Introduction
What is BSUI?
BSUI (BootStrap User Interface, pronounced /ˌbiː ˌɛs ˌjuː ˈaɪ/) is an open-source component system for building React applications with Bootstrap 5.
BSUI provides composable React components, a consistent component API, Bootstrap utility props, and JSDoc-based IntelliSense support. The library is designed to simplify the development of Bootstrap-based interfaces while preserving Bootstrap's conventions and utility system.
Features
- Bootstrap 5 Components
- Validated utility props
- Consistent component API
- Bootstrap-compatible architecture
- No Bootstrap JavaScript dependency
- JSDoc-powered IntelliSense
- Interactive documentation
Requirements
Before installing BSUI, make sure your project includes:
- React
19+ - Bootstrap
5.1.3
Installation
Install BSUI and Bootstrap:
npm install @promethey/bsui bootstrap
Import Bootstrap styles in your application entry point:
import "bootstrap/dist/css/bootstrap.min.css";
Usage
Documentation
The documentation is organized into several sections:
| Section | Description |
|---|---|
| Components | Component APIs, usage examples, and supported props |
| Forms | Form components, controls, and input patterns |
| Storybook | Interactive component previews and visual examples |