teneeto/cactus-ui

Accessibility focused react component library.

Cactus-UI

Cactus UI is a library that exposes accessible react components besides some useful hooks and utility functions. Mostly focuses on the accessibility side of the components instead of the visualization. It is easy to customize and can be used together with other libraries like styled-components to style easily.

---

Getting Started

Visit cactus-ui.ciceksepeti.dev for docs, examples and styling!

Features

• Accessible – Accessibility and behaviour is implemented according to WAI-ARIA Authoring Practices, including full screen reader and keyboard navigation support.
• Adaptable – All components are designed to work with mouse, touch, and keyboard interactions. They’re built with an accessibility first approach.
• Customizable – Easy to customize with inline style, CSS files and libraries like styled-components.

How to Interact with Library

Cactus UI uses Yarn to install, build and test packages. To install Yarn please follow this link, how to install yarn?. By running commands right below, you will be able to work with Cactus UI locally,

git clone [email protected]:ciceksepetitech/cactus-ui.git
cd cactus-ui
yarn install --frozen-lockfile
yarn lerna:build

Script Definitions

yarn lerna:build            # builds all packages via lerna
yarn storybook:start        # runs storybook
yarn lint                   # runs linter
yarn format                 # formats all code
yarn test:watch             # runs all tests for all packages in watch mode

Contributors

Thank you to all the contributors for improving this package. If you would like to be one of the contributors of this package, please follow instructions in how to contribute?