ngx-bootstrap

The best way to quickly integrate Bootstrap 5 Bootstrap 4 Components with Angular

Note: ngx-bootstrap for Bootstrap 3 is still available but is no longer maintained or updated. development

## Links - [Documentation](http://valor-software.com/ngx-bootstrap/) - [Release Notes](https://github.com/valor-software/ngx-bootstrap/blob/development/CHANGELOG.md) - [Slack Community](https://join.slack.com/t/ngx-home/shared_invite/enQtNTExMTY5MzcwMTM0LWVjZGU2MjI4MTVhMGVlMTc2OWRiMzA0NzBhNDU5YzQ0MDM3MWI5NzJjZTUzNzIxZmNjYmFlMjU2MzE0YmY0NWY) ## Table of contents 1. [Getting Started](#getting-started) 2. [Usage & Demo](#usage--demo) 3. [Supporting](#supporting-ngx-bootstrap) 4. [Installation](#installation) 5. [Compatibility](#compatibility) 6. [Troubleshooting](#troubleshooting) 7. [Contributing](#contribution) 8. [Credits](#credits) 9. [License](#license) 10. [Valor Can Help](#valor-software-can-help) ## Getting Started ngx-bootstrap provides Bootstrap components powered by Angular, so you don't need to include original JS components. Check our [Getting started guide](https://valor-software.com/ngx-bootstrap/#/documentation#getting-started) if it's your first project with Angular Bootstrap. ## Usage & Demo Bootstrap components for Angular applications, dozens of demos and API documentation could be found here: [https://valor-software.com/ngx-bootstrap/](https://valor-software.com/ngx-bootstrap/). ## Supporting ngx-bootstrap ngx-bootstrap is an Open Source (MIT Licensed) project, it's an independent project with ongoing development made possible thanks to the support of our awesome backers. If you also would like to show support or simply give back to Open Source community, please consider becoming a backing sponsor of [ngx-bootstrap on OpenCollective](https://opencollective.com/ngx-bootstrap). All donated funds are managed transparently on OpenCollective and will be used solely for compensating work and expenses for contributors. Valor Software employees and contractors are not eligible for use of these funds. What's in it for you? Proper recognition and exposure of your name/logo/website on our page. Our main sponsors will be presented under this section! Be the first! ## Installation You can see the below simple example working on [StackBlitz](https://stackblitz.com/edit/vs-ngx-bootstrap-tooltip?file=src%2Findex.html) ##### Angular CLI way Use the Angular CLI ng add command for updating your Angular project. ```bash ng add ngx-bootstrap ``` ##### Manual way Install `ngx-bootstrap` from `npm`: ```bash npm install ngx-bootstrap --save ``` Add wanted package to NgModule imports: ``` import { TooltipModule } from 'ngx-bootstrap/tooltip'; @NgModule({ ... imports: [TooltipModule.forRoot(),...] ... }) ``` Add component to your page: ``` ``` You will need to add bootstrap css: This can be done with the css file directly in the index.html, or alternatively through a styles import in the `angular.json` file or via `styles.scss` import. However the latter two options require additionally installing bootstrap via npm. - `Bootstrap 5` ``` ``` - `Bootstrap 4` ``` ``` ### Setting up the bootstrap version manually As you may know `ngx-bootstrap` supports several `bootstrap.css` versions at the same time and has automatic tool to guess current used version of library, but if this guess fails you can specify version of `bootstrap.css` manually. Sometimes, your project might contain some library that could interfere with the bootstrap framework, or you might have a customized version of bootstrap. The consequence is that the process of determining bootstrap version might be failed, which can break the UI. In that case, we can still set the bootstrap version manually in the bootstrapping component (i.e. `AppComponent`): ``` import { setTheme } from 'ngx-bootstrap/utils'; @Component({...}) export class AppComponent { constructor() { setTheme('bs5'); // or 'bs4' ... } } ``` ### How to build lib for development First time: ```bash git clone https://github.com/valor-software/ngx-bootstrap.git cd ngx-bootstrap npm ci npm run build npm start ``` ## Compatibility The only two dependencies are [Angular](https://angular.io) and [Bootstrap](https://getbootstrap.com) CSS. Here is the version compatibility list: | ngx-bootstrap | Angular | Bootstrap CSS | |---------------|-----------------|----------------| | 11.x.x | 16.x.x | 5.x.x or 4.x.x | | 10.x.x | 15.x.x | 5.x.x or 4.x.x | | 9.0.0 | 14.x.x | 5.x.x or 4.x.x or 3.x.x | | 8.0.0 | 12.x.x - 13.x.x | 5.x.x or 4.x.x or 3.x.x | | 7.1.0 | 11.x.x - 12.x.x | 5.x.x or 4.x.x or 3.x.x | | 7.0.0 | 11.x.x - 12.x.x | 3.x.x or 4.x.x | | 6.0.0 | 9.x.x - 10.x.x | 3.x.x or 4.x.x | | 5.6.x | 7.x.x - 9.1.0 | 3.x.x or 4.x.x | | 5.0.0 - 5.6.0 | 7.x.x - 8.x.x | 3.x.x or 4.x.x | | 4.x.x | 6.x.x - 7.x.x | 3.x.x or 4.x.x | | 3.x.x | 6.x.x - 7.x.x | 3.x.x or 4.x.x | | 2.x.x | 2.x.x - 4.x.x | 3.x.x or 4.x.x | | 1.x.x | 2.x.x | 3.x.x or 4.x.x | ## Troubleshooting So if you are in trouble, here's where you can look for help. The best place to ask questions is on [StackOverflow (under the `ngx-bootstrap` tag)](https://stackoverflow.com/questions/tagged/ngx-bootstrap) where there is a strong community of individuals asking and answering questions. You can also join [our Slack channel](https://join.slack.com/t/ngx-home/shared_invite/enQtNTExMTY5MzcwMTM0LWVjZGU2MjI4MTVhMGVlMTc2OWRiMzA0NzBhNDU5YzQ0MDM3MWI5NzJjZTUzNzIxZmNjYmFlMjU2MzE0YmY0NWY) and link your stackoverflow question there. But try to avoid asking generic help questions directly on Slack since they can easily get lost in the chat. You can also [search among the existing GitHub issues](https://github.com/valor-software/ngx-bootstrap/issues?utf8=%E2%9C%93&q=is%3Aissue). If none of the above helped, please feel free to open a [new issue](https://github.com/valor-software/ngx-bootstrap/issues/new). ## Contribution All contributions very welcome! And remember, contribution is not only PRs and code, but any help with docs or helping other developers to solve issues are very appreciated! Thanks in advance! Please read our [contribution guidelines](https://github.com/valor-software/ngx-bootstrap/blob/development/CONTRIBUTING.md). ### Credits Crossbrowser testing sponsored by [Saucelabs](https://saucelabs.com/) [

](https://saucelabs.com/) ### License [MIT](https://github.com/valor-software/ngx-bootstrap/blob/development/LICENSE) ### Valor Software Can Help At [Valor Software](https://valor-software.com/) our people are not resources, our people are human beings, helping to create a better world through our efforts and knowledge. We are here to assist you with your project. We have a wonderful, ever-growing team that is ready and able. If you're looking for someone to guide you and your team please feel free to reach out to us on our site or at sales@valor-software.com, we would love to chat.

	Stars	Issues	Version	Updated	Created
@angular/material	24,081	2,059	17.3.6	5 days ago	8 years ago
@ng-bootstrap/ng-bootstrap			16.0.0	5 months ago	8 years ago
ngx-bootstrap			12.0.0	5 months ago	8 years ago
primeng	9,459	950	17.15.0	3 days ago	8 years ago

@angular/material vs @ng-bootstrap/ng-bootstrap vs ngx-bootstrap vs primeng

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Popular Searches

Sick of boring JavaScript newsletters?

Downloads in past