A react component library for iTwinUI
npm install @itwin/itwinui-react
srcset='https://itwin.github.io/iTwinUI/logo-dark.svg'
/>
alt='iTwinUI logo'
/>
iTwinUI-react is a React component library for iTwinUI.
The goal of this package is to provide React components that make it easier to use the styles from @itwin/itwinui-css. Check out the documentation website to detailed documentation and examples of all components.
š Check out the v3 migration guide if you're upgrading from an older version.
---
``
npm add @itwin/itwinui-react
---
Wrap your application entrypoint in ThemeProvider and import styles.css.
`jsx
import { ThemeProvider } from '@itwin/itwinui-react';
import '@itwin/itwinui-react/styles.css';
export default function App() {
return (
<>
{/ Your components go here. /}
);
}
`
ThemeProvider has a theme prop which accepts one of the following values:"light"
-
-
- (respects the color scheme of the operating system)"inherit"
- (default)
---
After setting up ThemeProvider and styles, import the component you want and start using it!
`jsx
import { Button } from '@itwin/itwinui-react';
const Page = () => (
);
``
Check out this template for a live interactive demo:
---
For a list of frequently asked questions, visit the wiki.
---
We welcome you to contribute and make this UI design system better. You can submit feature requests or bugs by creating an issue.
Please read our CONTRIBUTING.md for more information.
---
Read our CHANGELOG.md to find recent changes.