@tui/uilib
v5.0.1-MR-95.0
Published
TUI Design System
Readme
TUI Design System
https://web.tui/resources/storybook/
Quick Start
nvm use
npm i
npm run devThis will spin up:
- storybook: http://localhost:6006/
How to use it
Installation
To install the latest stable version:
npm install @tui/ui-library or yarn add @tui/ui-library
To install the next major version (be aware it might contain untested features):
npm install @tui/ui-library@next or yarn add @tui/ui-library@next
Themes
Theme files provide some global variables that are needed by the components in order to adhere to the theme guidelines (colors, spacing, etc.). TUI is the only available theme at the moment.
In dist/themes/<<themename>>/, you will find the theme file style.css as well as other global stylesheets. For example, for the TUI theme you
could import in your .js files:
import '@tui/ui-library/dist/themes/tui/index.css';
import '@tui/ui-library/dist/themes/tui/fonts.css';Themes variables are declared within the "data-theme" attribute selector, so you will need to add it on either the host page html tag or your MFE:
<html data-theme="tui">
<!--or-->
<my-custom-mfe data-theme="tui">
<!--or-->
<div data-theme="tui"></div
></my-custom-mfe>
</html>Development mode
You can also clone this repository, install the dependencies and use npm run dev to run a local server where to check the example templates for the
components, how themes are generated, the original unprocessed stylesheets (post processed with postcss-preset-env), etc.
Contributing
Your feedback is welcome. You may request changes and improvements by creating an Issue on the UI Library (UILIB) project in Jira. If you have a general query about the UI Library you are welcome to post in the UI Library Support channel on Teams.
Please check the contributing document and the guidelines for contribution.
Migration
Please check the migration document
