This project is a Storybook instance that has been pre-loaded with all 100+ KendoReact UI components. It will be updated with any new components after every major release.
This is intended to be a blank slate for you and your team to edit, customize, and build on top of. To that end, it currently includes no documentation beyond PropTypes (full KendoReact component documentation can be found here) and no styling beyond the default KendoReact theme (learn more about theming here).
The following addons have been installed to this Storybook instance:
- @storybook/addon-a11y
- aria-live-storybook-addon
- storybook-addon-pseudo-states
Note that all of these addons are accessibility-related. KendoReact is, by default, built to be accessible. Read more about our commitment to accessibility and the technical specifications we meet. However, custom styling and changes can sometimes create inaccessible components. We encourage you to use the accessibility testing addons to ensure that the components are still meeting accessibility standards.
Beyond that, we have refrained from customizing the Storybook instance so that you have a fresh start for your new project. Check out the Storybook Integrations Library to find more useful addons.
This project also includes support for publishing to GitHub Pages, in the form of the storybook-deployer
tool. This has been included so that this project can be explored and previewed without needing to be downloaded and run locally. If you do not plan to publish your Storybook instance using GitHub Pages then it can be removed with no consequences.
If you find any bugs, errors, or other issues with this project, please reach out to us! The KendoReact Developer Advocate and primary maintainer of this repo is Kathryn Grayson Nanz. You can email her at nanz @ progress.com
or contact her via Twitter @kathryngrayson
with any questions or comments related to this project or KendoReact in general.
Use npm run storybook
to launch the Storybook instance!
This project was bootstrapped with Create React App.