README.md

Graasp UI

React components for the Graasp ecosystem.

Packages

Adding the library to your project

You will have to add the library and its peer dependencies:

yarn add @graasp/ui @graasp/stylis-plugin-rtl date-fns lucide-react

Usage

import { MyComponent } from '@graasp/ui'

const Example = () => {
  return <MyComponent />
}

Sub packages

Components for Graasp Apps

Graasp apps can use specific components to share style without needing to import the full bundle: use import from @graasp/ui/apps

Text Editor

Since Quill does not play nicely with SSR frameworks (access to the document property is not gated), it is exposed in its own sub-package: @graasp/ui/text-editor

Storybook

Storybook provides a nice display of defined UI components. To open the framework, run

yarn storybook

To explore the UI components and play with their props click the link bellow:

License

AGPL-3.0 © Graasp Association