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.
ngx-bootstrap
Native Angular directives for Bootstrap 3 and Bootstrap 4
Table of contents
- Getting Started
- Installation instructions
- Usage & Demo
- API
- Troubleshooting
- Contributing
- License
Getting Started
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.
Additionally to allow reach experience while working with Dates we are using moment.js, de facto base date manipulation library at the moment.
Installation instructions
Install ngx-bootstrap
from npm
npm install ngx-bootstrap --save
You will need bootstrap styles (Bootstrap 3)
<!-- index.html -->
<link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet">
Or Bootstrap 4
<!--- index.html -->
<link href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-alpha.6/css/bootstrap.min.css" rel="stylesheet">
To enable bootstrap 4 theme templates in ngx-bootstrap, please read
here
<!-- index.html -->
<link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet">
How to use it with:
How to build lib for development
First time
- clone repository
npm install
npm run test
it will run build and link
To run bootstrap 3 and 4 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 terminalng serve
in second
Run npm run link
after clean install and rebuild
Usage & Demo
Main source of API documentation and usage scenarios available here:
http://valor-software.github.io/ngx-bootstrap/
API
Check demo page for API reference
Troubleshooting
So you are in trouble, where to get help:
- you can search and ask for help at StackOverflow
- you can join slack and ask a question
- if none of this helped please search and only then open new issue
Contribution
Are 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!
If you need more modules check here
Please read central ngx
modules readme for details, plans and approach
Credits
Crossbrowser testing sponsored by Browser Stack