Installation

This library is available as an npm package.

Important note: styled-components, react, react-dom are peer dependencies, so make sure they are installed in your app.

$ npm i ustudio-ui
# or
$ yarn add ustudio-ui

Usage

First of, wrap your main component in our <ThemeProvider /> to gain access to the bundled styles.

import React from 'react';

import { ThemeProvider } from 'ustudio-ui/theme';

const App = () => <ThemeProvider>...</ThemeProvider>;

After that feel free to import and use all of our components and hooks in your application! ;)

Every component can be imported in two ways: either default from component folder, or named from root:

import Button from 'ustudio-ui/components/Button';
// or
import { Button } from 'ustudio-ui';

Important note: for compatibility with tree-shaking we suggest towards using default imports rather than named.

Also, make sure to read our theming guide to squeeze out all the power of uStudio UI Kit and achieve the best look and feel.

Contributing

Learn our code of conduct to become a contributor of uStudio UI.

Bugs and proposals

If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to our GitHub Repository.

Browsers support

uStudio UI supports the latest, stable releases of all major browsers and platforms. It also supports Internet Explorer 11. You don't need to provide any JavaScript polyfill as it manages unsupported browser features internally and in isolation.

| IE | Edge | Firefox | Chrome | Safari | | --- | ----- | ------- | ------ | ------ | | 11 | >= 14 | >= 52 | >= 49 | >= 10 |