Skip to content

README.md

Latest commit

 

History

History
58 lines (40 loc) · 1.68 KB

README.md

File metadata and controls

58 lines (40 loc) · 1.68 KB

@ippon-ui/react

The Ippon UI React component library, wrapping the @ippon-ui/styles Pattern Library.

Installation

The components render the Pattern Library markup, so they require @ippon-ui/styles alongside React 19. Both UI packages are bundled into your application, so install them as dev dependencies:

npm install -D @ippon-ui/react @ippon-ui/styles

react and react-dom (^19) are peer dependencies provided by your application.

Usage

Import the fonts, icons and stylesheet once in your application entry point:

import '@ippon-ui/styles/fonts/open-sans/400.css';
import '@ippon-ui/styles/fonts/open-sans/600.css';
import '@ippon-ui/styles/fonts/open-sans/700.css';
import '@ippon-ui/styles/fonts/saira-extra-condensed/700.css';
import '@ippon-ui/styles/icons/ionicons.css';
import '@ippon-ui/styles/tikui.css';

Then use the components:

import { IpponButton } from '@ippon-ui/react';

export const SaveButton = () => (
  <IpponButton color="information" onClick={() => console.log('saved')}>
    Save
  </IpponButton>
);

Documentation

Every component is documented in Storybook. Stories live in stories/ (one file per component) and render against the built @ippon-ui/styles stylesheet.

Build the styles first (from the monorepo root), then serve Storybook on port 4230:

mise build        # builds icons + styles + react
mise react-dev    # serves Storybook at http://localhost:4230

mise react-build builds the React library and then its static Storybook (output in storybook-static/).

License

Apache-2.0 © Ippon Technologies