Native Angular Bootstrap Components
npm install ngx-basic-components
ngx-bootstrap
Server side rendered version of this documentation available
here served with Angular universal and nest.js
Best way to quickly integrate Bootstrap 3 or Bootstrap 4 Components with Angular
- Documentation
- Release Notes
- Slack Community
ngx-bootstrap contains all core (and not only) Bootstrap components powered by Angular. So you don't need to include original JS components, but we are using markup and CSS provided by 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 to use these funds.
What's there 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!
ngx-bootstrap from npm:bash
npm install ngx-bootstrap --save
`Add needed package to NgModule imports:
`
import { TooltipModule } from 'ngx-bootstrap/tooltip';@NgModule({
...
imports: [TooltipModule.forRoot(),...]
...
})
`Add component to your page:
`
tooltip="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
Simple demo
`You will need bootstrap styles:
-
Bootstrap 3
`
`-
Bootstrap 4
`
`
##### Method 2
Use the Angular CLI ng add command for updating your Angular project.
`bash
ng add ngx-bootstrap
`Or use
ng add to add needed component (for example tooltip).
`bash
ng add ngx-bootstrap --component tooltip
`
Add component to your page:
`
tooltip="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
Simple demo
`
$3
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('bs3'); // or 'bs4'
...
}
}
`Usage & Demo
Main source of API documentation and usage scenarios available here:
https://valor-software.com/ngx-bootstrap/.
Additionally you can find demos and docs deployed from latest code with angular@latest and href="https://ngx-bootstrap-latest.surge.sh/">angular@next.
Server side rendered version of this documentation available here served with Angular universal and nest.js.
API
Check demo page for API reference.$3
- Bootstrap and angular-cli please refer to using-with-bootstrap-and-angular-cli
- angular-seed please refer to getting-started-with-angular-seed
- system.js (and angular2 quickstart) please checkout sample repository
- plnkr sample available here
- AoT using ngc and rollup please refer to ngx-bootstrap-with-aot
- ASP.NET Core 2.0 please refer to using-with-asp.net-core-2$3
First time:
- clone repository
-
npm install
- npm run buildTo update your fork and prepare it for local usage:
-
git pull upstream development
- rm -rf node_modules
- npm install
- npm run buildTo run the demo:
-
npm run demo.serve _// to serve local demo. This is for testing only, without watchers._For local development run:
-
npm run build.watch _// in first terminal_
- ng serve _// in second_If you want to run the demo with Angular Universal:
-
npm run demo.serve-universalCompatibility
The only two dependencies are Angular and Bootstrap CSS.
Here is the versions compatibility list:
| ngx-bootstrap | Angular | Bootstrap CSS |
| ------------- | ------------- | -------------- |
| 5.x.x | 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)
You can also join our Slack channel 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.If, and only if, none of the above helped, please open a new issue.
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.
$3
Please read central
ngx` modules readme for details, plans and approach.End-to-end testing sponsored by Cypress