ngx-bootstrap

What is ngx-bootstrap?

ngx-bootstrap is a popular Angular library that provides Bootstrap components powered by Angular. It allows developers to use Bootstrap's UI components in their Angular applications with ease, offering a wide range of features and customization options.

What are ngx-bootstrap's main functionalities?

Alerts

The Alerts component allows you to display different types of alert messages such as success, info, warning, and danger. This is useful for providing feedback to users.

<alert type="success">Success Alert</alert>

Modals

The Modals component allows you to create and manage modal dialogs. This is useful for displaying additional information or forms without navigating away from the current page.

<button type="button" class="btn btn-primary" (click)="openModal()">Open Modal</button>
<ng-template #template>
  <div class="modal-body">
    <p>Modal content goes here.</p>
  </div>
</ng-template>

Datepicker

The Datepicker component provides a user-friendly way to select dates. It supports various configurations and customizations to fit different use cases.

<input type="text" class="form-control" bsDatepicker>

Tabs

The Tabs component allows you to create tabbed interfaces. This is useful for organizing content into separate sections that can be easily navigated by users.

<tabset>
  <tab heading="Tab 1">Content of Tab 1</tab>
  <tab heading="Tab 2">Content of Tab 2</tab>
</tabset>

Tooltips

The Tooltips component provides a way to display additional information when users hover over or focus on an element. This is useful for providing contextual help or explanations.

<button type="button" class="btn btn-secondary" tooltip="Tooltip text">Hover me</button>

Other packages similar to ngx-bootstrap

ng-bootstrap

ng-bootstrap provides Bootstrap components for Angular without the need for jQuery. It offers a similar set of features to ngx-bootstrap but is designed to work seamlessly with Angular's reactive forms and other Angular-specific features.

primeng

PrimeNG is a comprehensive UI component library for Angular that includes a wide range of components such as data tables, charts, and form controls. It offers more components than ngx-bootstrap but may have a steeper learning curve.

angular-material

Angular Material is the official Material Design component library for Angular. It provides a set of high-quality, reusable UI components based on Google's Material Design guidelines. It offers a different design aesthetic compared to Bootstrap.

README

ngx-bootstrap

Best way to quickly integrate Bootstrap 3 or Bootstrap 4 Components with Angular

Links

• Documentation
• Release Notes
• Slack Community

Table of contents

1. Getting Started
2. Usage & Demo
3. Supporting
4. Installation
5. Compatibility
6. Troubleshooting
7. Contributing
8. Credits
9. License

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

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 backer sponsor of ngx-bootstrap on OpenCollective.

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!

Installation

Angular CLI way

Use the Angular CLI ng add command for updating your Angular project.

ng add ngx-bootstrap

Manual way

Install ngx-bootstrap from npm:

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:

<button type="button" class="btn btn-primary"
        tooltip="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
  Simple demo
</button>

You will need to add bootstrap css:

• Bootstrap 3

<!-- index.html -->
<link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet">

• Bootstrap 4

<!--- index.html -->
<link href="https://maxcdn.bootstrapcdn.com/bootstrap/4.5.3/css/bootstrap.min.css" rel="stylesheet">

Setting up the bootstrap version manually

As you may know ngx-bootstrap support 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('bs3'); // or 'bs4'
    ...
  }
}

How to build lib for development

First time:

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 and Bootstrap CSS. Here is the versions compatibility list:

ngx-bootstrap	Angular	Bootstrap CSS
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) 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.

Credits

Crossbrowser testing sponsored by Saucelabs

End-to-end testing sponsored by Cypress

License

MIT

Changelog

7.1.2 (2021-09-24)

Bug Fixes

• aria-expanded: fixed unnecessary aria-expanded (#6297) (329c7b8)
• datepicker: fix enabledDates/disabledDates property not working in min-mode (#6290) (78c45bc)
• datepicker: fix wrong value for SV and NL locales in daterangepicker (#6303) (2fb60fd)
• dropdown: fixed dropdown right align for bs5 (#6298) (aa279f4)
• modal: fixed modal uniq id (#6299) (be1db58)
• modals: fixed modals documentation for ModalOptions (#6292) (0222e4f)
• timepicker: fixed reset validation for ngModel (#6294) (d777be6)

Features

• datepicker: add timepicker support (#6275) (e93950b)
• datepicker: added config param to enable optional current time initialization (#6288) (3d2a0d5)
• dropdown: add arrow key navigation for dropdown list (#4156) (107f2b2)
• timepicker: add config for allowing empty time (#6279) (3a0757a)
• typeahead: added config option selectItemOnBlur to select item onBlur (#6295) (f36ec96)