/ui

Scaleflex UI framework for React built with TypeScript and styled-components. Any questions or issues, please report to https://github.com/scaleflex/ui/issues

Primary LanguageTypeScriptOtherNOASSERTION

Scaleflex UI

lerna style: styled-components

Scaleflex UI framework for React built with TypeScript and styled-components.

Storybook for UI (Documentation)

Scaleflex UI is shipping several packages:

Installation

npm i @scaleflex/ui # styled-components react react-dom
yarn add @scaleflex/ui # styled-components react react-dom

Make sure to have react, react-dom and styled-components installed in your package as they are included in our peer dependencies.

Usage

Before writing any components in your application make sure to provide them with our theme. This is done by wrapping your application in our ThemeProvider component.

import ThemeProvider from '@scaleflex/ui/theme';

ReactDOM.render(
  <ThemeProvider>
    <App />
  </ThemeProvider>,
  document.querySelector('#root')
);

More examples can be found in the theme package readme.

After that, you are ready to use our framework inside of your application!

// Please note that in most cases we provide direct default exports for better tree-shaking support.
import Button from '@scaleflex/ui/core/button';