Strapi Design System

A UI component library for creating amazing Strapi extensions.

Installation

$ yarn add react react-dom @strapi/design-system @strapi/icons styled-components react-router-dom

# or

$ npm i react react-dom @strapi/design-system @strapi/icons styled-components react-router-dom

Getting Started

Wrap your application with the DesignSystemProvider. You can additionally pass a theme and/or locale, although you don't have to as we have default values for both.

import { DesignSystemProvider, lightTheme } from '@strapi/design-system';

function MyApp({ children }) {
  return (
    <DesignSystemProvider locale="en-GB" theme={lightTheme}>
      {children}
    </DesignSystemProvider>
  );
}

export default App;

Then, checkout the complete Storybook documentation to find the components you want to use and how to use them.

Contributing

Please follow our CONTRIBUTING guidelines.

License

Licensed under the MIT License, Copyright © 2015-present Strapi Solutions SAS.

See LICENSE for more information.