1.4.3 • Published 2 years ago
@kiniui/components v1.4.3
Keeper Components
This package contains a library shared components between Keeper and VLM.
Using this package
This package can be consumed using NPM. It is distributed as a private NPM package and as such it is necessary to login to an NPM account which is authorized by keeperinc organization in order to be able to pull this package.
$ npm login
$ npm install --save @keeperinc/components
You can then import any component provided by this package and use them with your own chakra themes
import SimpleCard, { SimpleCardProps } from './SimpleCard'
const MyComponent = (props) => (
<ChakraProvider theme={keeperTheme}>
<SimpleCard {...props}>This is what it looks like with Keeper's Theme</SimpleCard>
</ChakraProvider>
)
Storybook
All the components delivered with this package are documented using the storybook appliance.
$ git pull
$ npm install
$ npm run storybook
You can also access the public storybook instance hosted on Amplify: https://master.d8xmk1tk7pcda.amplifyapp.com/
Testing
Every component is tested using cypress and test can be run and visualized using the following commands:
$ git pull
$ npm install
$ npx cypress open
Changelog
This package uses semantic versioning
Version 0.0.1
- SimpleCard was added, cypress for testing and storybook for documentation
Contributing
- Follow our javascript conventions
- All components must be themable using chakra
- All components must be 508/WCAG compliant
- All components must be applicable to any project
- No global state is allowed
- Every component must be documented in the storybook
- Every component must be tested using cypress