@movable/ui
v1.15.2
Published
Movable Ink's shared MUI components and MUI theme for our vite applications
Downloads
1,772
Readme
@movable/ui
todo: update
This repo contains the shared components for our frontend applications. Using this react component library guide
Local Development
Installation
- Ensure you have
volta
installed on your computer - Clone the repo
npm install
(note:npm
, notyarn
)
Usage
Ensure the project consuming this library has all the required peer dependencies.
WARNING: Providing Theme Colors to Custom Components
While within using app you'll be able to use (theme) => theme.palette...
style of sx props. But within our custom component this does NOT traverse to the using app. You'll want to use the theme palette directly to ensure proper color strings. See #224
import palette from 'path_to_src/theme/palette';
export default InkCustomComponent() {
return (
<Box sx={{ backgroundColor: palette.neutral50 }}>
...
</Box>
)
}
Yarn Linking
@movable/ui
:yarn link
@movable/ui
:npm run watch
front-end/packages/studio
:yarn link /path/to/local/@movable/ui
front-end/packages/studio
:yarn dev --force
- Be sure afterwards to unlink from
front-end/packages/studio
:yarn unlink @movable/ui
If yarn gets confused, try unlinking, removing node_modules
and following the steps again.
NPM Linking
tbd
Linking to local Studio
Conventional Commits
This repo has conventional-commits We lint for this both pre-commit and on PR actions. It is required and will not pass without it.
Ex:
fix(percy): added percy snapshots for all component states
- active
- disabled
- focused