TabUI
UI Components Library built on top of Bootstrap 5.
Explore TabUI docs »
Report bug
·
Request feature
·
Blog
## Table of contents
- [Table of contents](#table-of-contents)
- [Quick start](#quick-start)
- [Status](#status)
- [What's included](#whats-included)
- [Bugs and feature requests](#bugs-and-feature-requests)
- [Documentation](#documentation)
- [Frameworks](#frameworks)
- [Templates](#templates)
- [Contributing](#contributing)
- [Community](#community)
- [Versioning](#versioning)
- [Creators](#creators)
- [Thanks](#thanks)
- [Copyright and license](#copyright-and-license)
## Quick start
Several quick start options are available:
- [Download the latest release](https://github.com/abidesa/tabui/archive/v4.2.2.zip)
- Clone the repo: `git clone https://github.com/abidesa/tabui.git`
- Install with [npm](https://www.npmjs.com/): `npm install @tabui/tabui`
- Install with [yarn](https://yarnpkg.com/): `yarn add @tabui/tabui`
- Install with [Composer](https://getcomposer.org/): `composer require tabui/tabui:4.0.5`
Read the [Getting started page](https://tabui.io/docs/getting-started/introduction/) for information on the framework contents, templates and examples, and more.
## Status
[](https://github.com/abidesa/tabui/actions?query=workflow%3AJS+Tests+branch%3Amain)
[](https://www.npmjs.com/package/@tabui/tabui)
[](https://packagist.org/packages/tabui/tabui)
[](https://coveralls.io/github/tabui/tabui?branch=main)
[](https://github.com/abidesa/tabui/blob/main/dist/css/tabui.min.css)
[](https://github.com/abidesa/tabui/blob/main/dist/css/tabui.min.css)
[](https://github.com/abidesa/tabui/blob/main/dist/js/tabui.min.js)
[](https://github.com/abidesa/tabui/blob/main/dist/js/tabui.min.js)
## What's included
Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this:
```text
tabui/
├── css/
│ ├── tabui-grid.css
│ ├── tabui-grid.css.map
│ ├── tabui-grid.min.css
│ ├── tabui-grid.min.css.map
│ ├── tabui-grid.rtl.css
│ ├── tabui-grid.rtl.css.map
│ ├── tabui-grid.rtl.min.css
│ ├── tabui-grid.rtl.min.css.map
│ ├── tabui-reboot.css
│ ├── tabui-reboot.css.map
│ ├── tabui-reboot.min.css
│ ├── tabui-reboot.min.css.map
│ ├── tabui-reboot.rtl.css
│ ├── tabui-reboot.rtl.css.map
│ ├── tabui-reboot.rtl.min.css
│ ├── tabui-reboot.rtl.min.css.map
│ ├── tabui-utilities.css
│ ├── tabui-utilities.css.map
│ ├── tabui-utilities.min.css
│ ├── tabui-utilities.min.css.map
│ ├── tabui-utilities.rtl.css
│ ├── tabui-utilities.rtl.css.map
│ ├── tabui-utilities.rtl.min.css
│ ├── tabui-utilities.rtl.min.css.map
│ ├── tabui.css
│ ├── tabui.css.map
│ ├── tabui.min.css
│ ├── tabui.min.css.map
│ ├── tabui.rtl.css
│ ├── tabui.rtl.css.map
│ ├── tabui.rtl.min.css
│ └── tabui.rtl.min.css.map
└── js/
├── tabui.bundle.js
├── tabui.bundle.js.map
├── tabui.bundle.min.js
├── tabui.bundle.min.js.map
├── tabui.esm.js
├── tabui.esm.js.map
├── tabui.esm.min.js
├── tabui.esm.min.js.map
├── tabui.js
├── tabui.js.map
├── tabui.min.js
└── tabui.min.js.map
```
We provide compiled CSS and JS (`tabui.*`), as well as compiled and minified CSS and JS (`tabui.min.*`). [source maps](https://developers.google.com/web/tools/chrome-devtools/javascript/source-maps) (`tabui.*.map`) are available for use with certain browsers' developer tools. Bundled JS files (`tabui.bundle.js` and minified `tabui.bundle.min.js`) include [Popper](https://popper.js.org/).
## Bugs and feature requests
Have a bug or a feature request? Please first read the [issue guidelines](https://github.com/abidesa/tabui/blob/main/.github/CONTRIBUTING.md#using-the-issue-tracker) and search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/abidesa/tabui/issues/new).
## Documentation
The documentation for the TabUI is hosted at our website [TabUI](https://tabui.io/)
### Running documentation locally
1. Run `npm install` to install the Node.js dependencies, including Hugo (the site builder).
2. Run `npm run test` (or a specific npm script) to rebuild distributed CSS and JavaScript files, as well as our docs assets.
3. From the root `/tabui` directory, run `npm run docs-serve` in the command line.
4. Open `http://localhost:9001/` in your browser, and voilà.
Learn more about using Hugo by reading its [documentation](https://gohugo.io/documentation/).
## Frameworks
TabUI supports most popular frameworks.
- [TabUI for Bootstrap (Vanilla JS)](https://github.com/abidesa/tabui)
- [TabUI for React](https://github.com/abidesa/tabui-react)
## Templates
Fully featured, out-of-the-box, templates for your application based on TabUI.
- [Bootstrap Admin Template](https://tabui.io/)
- [React Admin Template](https://tabui.io/react)
## Contributing
Please read through our [contributing guidelines](https://github.com/abidesa/tabui/blob/main/.github/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.
Editor preferences are available in the [editor config](https://github.com/abidesa/tabui/blob/main/.editorconfig) for easy use in common text editors. Read more and download plugins at .
## Community
Stay up to date on the development of TabUI and reach out to the community with these helpful resources.
- Read and subscribe to [The Official TabUI Blog](https://tabui.io/blog).
- Follow [@tabui on Twitter](https://twitter.com/tabui).
## Versioning
For transparency into our release cycle and in striving to maintain backward compatibility, TabUI is maintained under [the Semantic Versioning guidelines](http://semver.org/).
See [the Releases section of our project](https://github.com/abidesa/tabui/releases) for changelogs for each release version.
## Creators
**TabUI Team**
*
*
## Thanks
TabUI is designed as the extension of [Bootstrap](https://getbootstrap.com). Special thanks for [Bootstrap team](https://getbootstrap.com/docs/5.0/about/team/) and [Bootstrap's contributors](https://github.com/twbs/bootstrap/graphs/contributors).
## Copyright and license
Copyright 2022 TabUI Team. Code released under the [MIT License](https://github.com/abidesa/tabui/blob/main/LICENSE). Docs released under [Creative Commons](https://creativecommons.org/licenses/by/3.0/).