Welcome to the unofficial OpenUI UI library, or oui-ui for short.
Note: This is currently a library I'm developing to learn web components. It's best not to use this in production.
If you'd like to see a demo, you can check out the oui-ui documentation site
What's OpenUI? According to the OpenUI site:
The purpose of Open UI to the web platform is to allow web developers to style and extend built-in web UI controls, such as
<select>dropdowns, checkboxes, radio buttons, and date/color pickers.Long term, we hope that Open UI will establish a standard process for developing high-quality UI controls suitable for addition to the web platform.
oui-ui is the implementation of these proposed UI controls as a web component library, and so can be used with HTML, or with a framework like React or Vue.
If you want to get started, you can follow along to the checkbox quick start
Currently, oui-ui only exports a single checkbox component.
| Component |
|---|
<oui-checkbox> |
Being by forking the repo. Whilst in the root directory:
- run
nvm use, or ensure you're the node version specified in the.nvmrcfile. - install dependencies using
yarn. - ensure the tests are passing by running
yarn test. - kick off the dev server by running
yarn develop. - run the docs site locally using
yarn docs:start. - jump into whichever you package you want to change
- view your changes in your locally running docs
oui-ui uses:
- 💪🏾 TypeScript as the primary language to keep things strong(ly typed).
- 📝 Changesets to manage changelogs, versioning, and publishing.
- 🛠 Web Test Runner for testing
- 🧼 ESLint + Prettier for keeping code clean like a money machine.
- 🗂 Docusaurus for handling our documentation.
- 🤖 Commitizen + Commitlint for consistent commits.
- 🙋🏽♂️ Andrico for keeping things ticking along.