Table of contents

• Table of contents
• Quick start
• Status
• What's included
• Bugs and feature requests
• Documentation
• Frameworks
• Templates
• Contributing
• Community
• Versioning
• Creators
• Thanks
• Copyright and license

Quick start

Several quick start options are available:

• Download the latest release
• Clone the repo: git clone https://github.com/abidesa/tabui.git
• Install with npm: npm install @tabui/tabui
• Install with yarn: yarn add @tabui/tabui
• Install with Composer: composer require tabui/tabui:4.0.5

Read the Getting started page for information on the framework contents, templates and examples, and more.

Status

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:

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 (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.

Bugs and feature requests

Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Documentation

The documentation for the TabUI is hosted at our website TabUI

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.

Frameworks

TabUI supports most popular frameworks.

• TabUI for Bootstrap (Vanilla JS)
• TabUI for React

Templates

Fully featured, out-of-the-box, templates for your application based on TabUI.

• Bootstrap Admin Template
• React Admin Template

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at https://editorconfig.org/.

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.
• Follow @tabui on Twitter.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, TabUI is maintained under the Semantic Versioning guidelines.

See the Releases section of our project for changelogs for each release version.

Creators

TabUI Team

• https://twitter.com/tabui
• https://github.com/tabui

Thanks

TabUI is designed as the extension of Bootstrap. Special thanks for Bootstrap team and Bootstrap's contributors.

Copyright and license

Copyright 2022 TabUI Team. Code released under the MIT License. Docs released under Creative Commons.