tuix-webcomponents

<tuix-webcomponents>

This webcomponent follows the open-wc recommendation.

Installation

npm i tuix-webcomponents

Usage

Webbundle version

Webbundle Link: https://tuix-webcomponents.s3.eu-central-1.amazonaws.com/[e-mail]
Styles Link: https://tuix-webcomponents.s3.eu-central-1.amazonaws.com/[e-mail]

React .tsx with SSR

import { loadFonts } from 'tuix-webcomponents';

function App() {
  
  // load fonts for SSR and CSR
  useEffect(() => {
    loadFonts()
  }, [])
  
  return (
    <tuix-text size="xl" color="primary">Test text</tuix-text>
  )
}

React .tsx without SSR

import { loadFonts } from 'tuix-webcomponents';
loadFonts()

function App() {
  
  return (
    <tuix-text size="xl" color="primary">Test text</tuix-text>
  )
}

Linting and formatting

To scan the project for linting and formatting errors, run

npm run lint

To automatically fix linting and formatting errors, run

npm run format

Demoing with Storybook

To run a local instance of Storybook for your component, run

npm run storybook

To build a production version of Storybook, run

npm run storybook:build

Tooling configs

For most of the tools, the configuration is in the package.json to reduce the amount of files in your project.

If you customize the configuration a lot, you can consider moving them to individual files.

Local Demo with web-dev-server

npm start

To run a local development server that serves the basic demo located in demo/index.html