@jsxtools/aui
Version:
A baseline UI as Mixins, Custom Elements, React Components, etc.
48 lines (34 loc) • 1.67 kB
Markdown
# AUI
[![NPM Version][npm-img]][npm-url]
[![Build Status][cli-img]][cli-url]
[![Coverage][cov-img]][cov-url]
**AUI** is a baseline UI available as Mixins, Custom Elements, and React Components, enabling you to build accessible and reusable components in whatever development environment you prefer.
## Features
- 🎨 **TypeScript Support**: Full type safety and autocompletion
- ⚡ **Performance Optimized**: Efficient updates and rendering
- 🚀 **Zero Dependencies**: Lightweight and framework-agnostic
- 🎯 **React Exports**: Every custom element is available as a React component
- 📦 **Tree-shakeable**: Only import what you need
- 🎨 **Fully Covered**: Full 100% test coverage
## Installation
```shell
npm install @jsxtools/aui
```
- [Dive into the Mixins](src/mixins)
- [Dive into the Custom Elements](src/elements)
- [Dive into the React Components](src/react)
## Contributing
Contributions are welcome!
1. Fork the repository
2. Create your feature branch (`git checkout -b your/amazing-feature`)
3. Commit your changes (`git commit -m "Add some amazing feature"`)
4. Push to the branch (`git push origin your/amazing-feature`)
5. Open a Pull Request
## License
This project is licensed under the [MIT No Attribution License](https://opensource.org/license/mit-0).
[npm-img]: https://img.shields.io/npm/v/@jsxtools/aui
[npm-url]: https://www.npmjs.com/package/@jsxtools/aui
[cli-img]: https://github.com/jsxtools/aui/actions/workflows/check.yml/badge.svg
[cli-url]: https://github.com/jsxtools/aui/actions/workflows/check.yml
[cov-img]: https://codecov.io/gh/jsxtools/aui/graph/badge.svg
[cov-url]: https://codecov.io/gh/jsxtools/aui