Textkernel OneUI

npm version Build Status Coverage Status Language grade: JavaScript npm bundle size

Library of reusable React components with theming support

Getting started

For live examples of all OneUI components, click here.

Install with npm

Within your project’s frontend root, install the package from NPM. Make sure it’s marked as production dependency.

$ npm i '@textkernel/oneui'

Set up boilerplate

Import OneUI base stylesheet

In your application main Javascript, make sure to import the OneUI base stylesheet. The base stylesheet includes the default OneUI theme.

import '@textkernel/oneui/dist/oneui.min.css';

Custom themes and browser support

To enable support for older browsers that don’t support CSS variables natively and to apply custom a theme, OneUI comes with a utility that takes on all of these responsibilities. See Theming for more on custom themes.

To apply a specific theme on top of the library components, the OneUI utility can be used to parse the provided theme file:

import OneUI from '@textkernel/oneui';

OneUI.init({
    themeURL: 'http://theme-cdn.com/my-theme.css'
}).then(() => ReactDOM.render(
    <MyApp />,
    document.getElementById('root')
));

The utility can take three optional arguments:

  • themeURL: URL that provides the file containing the CSS variables that will be used instead of the default ones.
  • maxTime: The maximum amount of time in milliseconds that the loader will wait to parse the external theme, otherwise it will fallback to the default library theme. By default, the timeout is set to 2000 milliseconds.
  • ponyfillOptions: Allow the developer to override the default css-vars-ponyfill configuration.

IE11 support

OneUI relies on browser support for CSS variables. Support for older browsers such as IE11 can be enabled by using a polyfill. Using the previously mentioned utility will take care of it automatically.

Using components

  1. Import the desired UI component(s) from the library, e.g.:
import { Alert } from '@textkernel/oneui';
  1. Include the component on your page:
<Alert context="info" title="Hey there!">
    This is some information for you
</Alert>

Undocumented props

Please note that any properties that are not documented in the component prop types definition are applied to the top level HTML element unless mentioned otherwise. These undocumented props are also not described in Storybook.

Examples & Testing

Storybook

OneUI comes with a Storybook of examples for all components. Click here to check it out.

In order to run it yourself locally...

  1. Make sure you have Storybook installed (globally):
$ npm i -g @storybook/cli
  1. Within the OneUI root, run npm run storybook
  2. Go to http://localhost:9001 to check out examples of all OneUI components

Example of implementation

An implementation example can be found in the example directory, along with instructions on how to run it.

Testing

  • Run tests: npm test
  • Coverage report: npm run test:coverage

Theming

All CSS variables (‘custom properties’) exposed by OneUI can be customized, except for color shades (e.g. --color-primary-25) which are computed when generating new themes. A theme file is an additional stylesheet that consists of a reassignment of all variables with values that are different from their defaults. Theme files should not contain any CSS selectors or properties - only CSS variables and values, e.g.:

--color-primary: red;
--color-brand: blue;
--font-size-base: 12px;

Contributing

  • Did you find a bug or do you have a feature proposal? Please open a new issue.
  • If your IDE does not support EditorConfig, please install a plugin (e.g. for VS Code).
  • Please make sure to read the developer guidelines before contributing.

Copyright

Code and documentation © 2019 Textkernel B.V.