@saarbyrne/playbook
v1.2380.0
Published
kitman playbook library - standalone with inlined colors
Readme
Playbook
Playbook is the Kitman Labs design system which is built on top of MUI.
This package contains the the code that Kitman layers on top of Material UI to build playbook. Based off the designs in the Playbook Master figma file.
🚧 Note: These docs are a WIP as Playbook is being rolled out accross the product see see the project resources below 🚧
Usage
As a starting point, the Material UI components are themed using a global theme we define in this package which is outlined by the design team.
Playbook is built using the following @mui packages
@mui/base@mui/icons-material@mui/lab@mui/material@mui/x-data-grid-pro@mui/x-date-pickers-pro
API documentation for all components are found here
It is not recommended to import material components directly from MUI. This gives playbook the flexibility to add wrapper components to suit Kitman labs needs, or to create universal components whos styles have been overrided. See contribution guidelines
Example, MUI docs would suggest:
import Stack from '@mui/material/Stack';
import Button from '@mui/material/Button';
import { DataGrid } from '@mui/x-data-grid';But it is reccomended to import via playbook so consistent usage is maintained
import {
Stack,
Button,
DataGrid
} from `@kitman/playbook/components`Themes
TODO - when the default theme is built, outline how it works here
Components
@kitman/playbook/components houses all the components for:
@mui/material@mui/x-data-grid-pro@mui/x-date-pickers-pro
Hooks
This houses utility hooks exported from @mui/material.
Icons
@kitman/playbook/icons is a wrapper for material icons. Usage guidlines are
outlined by material ui here. All icons
here are available through
playbook icons.
Imports can be done via:
import { AccessAlarm, ThreeDRotation } from '@kitman/playbook/icons';Contribution
The Playbook package is managed by a governance team that spans front-end engineering and design.
Documentation
Playbook uses storybook to document components. Storybook can be run locally or visited on our hosted chromatic instance. See Documentation
