<commit_before># NG Bootstrap - [Angular 2](http://angular.io/) directives specific to [Bootstrap 4](http://v4-alpha.getbootstrap.com/)

[![Build Status](https://travis-ci.org/ng-bootstrap/ng-bootstrap.svg?branch=master)](https://travis-ci.org/ng-bootstrap/ng-bootstrap)
[![devDependency Status](https://david-dm.org/ng-bootstrap/ng-bootstrap/dev-status.svg?branch=master)](https://david-dm.org/ng-bootstrap/ng-bootstrap#info=devDependencies)

Welcome to the Angular 2 version of the [Angular UI Bootstrap](https://github.com/angular-ui/bootstrap) library.
This library is being built from scratch by the [ui-bootstrap team](https://github.com/angular-ui/bootstrap).
We are using TypeScript and targeting the Bootstrap 4 CSS framework. 

As with Bootstrap 4 and Angular 2, this library is a work in progress. Please check out our list of
[issues](https://github.com/ng-bootstrap/ng-bootstrap/issues) to see all the things we are implementing.
Feel free to make comments there.

## Supported browsers

We support the same browsers and versions supported by both Bootstrap 4 and Angular 2, whichever is _more_ restrictive.
See [this](https://github.com/angular/angular/blob/master/README.md) for up-to-date Angular 2 browser support.

* Chrome (45+)
* Firefox (40+)
* IE (9+) (but see [Bootstrap 4's notes](http://v4-alpha.getbootstrap.com/getting-started/browsers-devices/#internet-explorer-9) on IE9)
* Edge (20+)
* Safari (7+)

## Dependencies
* [Angular 2](https://angular.io) (tested with 2.0-rc.4)
* [Bootstrap 4](https://v4-alpha.getbootstrap.com) (test with 4.0 alpha V2)

## Installation
After installing the above dependencies, install `ng-bootstrap` via:
```
npm install --save @ng-bootstrap/ng-bootstrap
```
Once Installed, directives may be imported in several different ways:
For all the directives (if you simply intend on using everything):
```
import {NGB_DIRECTIVES} from '@ng-bootstrap/ng-bootstrap';
```
Or, for specific component directives (using Alert as an example):
```
import {NGB_ALERT_DIRECTIVES} from '@ng-bootstrap/ng-bootstrap';
```
Once imported, add your chosen directives on your component's `directives` array property:
```
directives: [
  ...,
  NGB_DIRECTIVES,
  ...
]
```
Certain directives need to be precompiled in order to be used. This is done via your component's `precompiled` array
property. The following components require precompilation:
```
precompile: [
  ...,
  NGB_PRECOMPILE,
  ...
]
```
We recommend putting these in the top level component of your application. So ultimately, you
should wind up having something that looks like this:
```
import {Component} from '@angular/core';
import {NGB_DIRECTIVES, NGB_PRECOMPILE} from '@ng-bootstrap/ng-bootstrap';

@Component({
  selector: 'app',
  directives: [ NGB_DIRECTIVES ],
  precompile: [ NGB_PRECOMPILE ],
  templateUrl: './app.html',
})
export class App {
    ...
}
```
## Contributing to the project

We are always looking for the quality contributions! Please check the [CONTRIBUTING.md](CONTRIBUTING.md) doc for contribution guidelines.

## Getting Help

Please, do not open issues for the general support questions as we want to keep GitHub issues for bug reports and feature requests. You've got much better chances of getting your question answered on [StackOverflow](http://stackoverflow.com/questions/tagged/ng-bootstrap) where maintainers are looking at questions tagged with `ng-bootstrap`.

StackOverflow is a much better place to ask questions since:
* there are hundreds of people willing to help on StackOverflow
* questions and answers stay available for public viewing so your question / answer might help someone else
* SO voting system assures that the best answers are prominently visible.<commit_msg>docs(README): add demo reference<commit_after># NG Bootstrap - [Angular 2](http://angular.io/) directives specific to [Bootstrap 4](http://v4-alpha.getbootstrap.com/)

[![Build Status](https://travis-ci.org/ng-bootstrap/ng-bootstrap.svg?branch=master)](https://travis-ci.org/ng-bootstrap/ng-bootstrap)
[![devDependency Status](https://david-dm.org/ng-bootstrap/ng-bootstrap/dev-status.svg?branch=master)](https://david-dm.org/ng-bootstrap/ng-bootstrap#info=devDependencies)

Welcome to the Angular 2 version of the [Angular UI Bootstrap](https://github.com/angular-ui/bootstrap) library.
This library is being built from scratch by the [ui-bootstrap team](https://github.com/angular-ui/bootstrap).
We are using TypeScript and targeting the Bootstrap 4 CSS framework. 

As with Bootstrap 4 and Angular 2, this library is a work in progress. Please check out our list of
[issues](https://github.com/ng-bootstrap/ng-bootstrap/issues) to see all the things we are implementing.
Feel free to make comments there.

## Demo

Check all the directives in action at https://ng-bootstrap.github.io

## Dependencies
* [Angular 2](https://angular.io) (tested with 2.0-rc.4)
* [Bootstrap 4](https://v4-alpha.getbootstrap.com) (test with 4.0 alpha V2)

## Installation
After installing the above dependencies, install `ng-bootstrap` via:
```
npm install --save @ng-bootstrap/ng-bootstrap
```
Once Installed, directives may be imported in several different ways:
For all the directives (if you simply intend on using everything):
```
import {NGB_DIRECTIVES} from '@ng-bootstrap/ng-bootstrap';
```
Or, for specific component directives (using Alert as an example):
```
import {NGB_ALERT_DIRECTIVES} from '@ng-bootstrap/ng-bootstrap';
```
Once imported, add your chosen directives on your component's `directives` array property:
```
directives: [
  ...,
  NGB_DIRECTIVES,
  ...
]
```
Certain directives need to be precompiled in order to be used. This is done via your component's `precompiled` array
property. The following components require precompilation:
```
precompile: [
  ...,
  NGB_PRECOMPILE,
  ...
]
```
We recommend putting these in the top level component of your application. So ultimately, you
should wind up having something that looks like this:
```
import {Component} from '@angular/core';
import {NGB_DIRECTIVES, NGB_PRECOMPILE} from '@ng-bootstrap/ng-bootstrap';

@Component({
  selector: 'app',
  directives: [ NGB_DIRECTIVES ],
  precompile: [ NGB_PRECOMPILE ],
  templateUrl: './app.html',
})
export class App {
    ...
}
```
## Supported browsers

We support the same browsers and versions supported by both Bootstrap 4 and Angular 2, whichever is _more_ restrictive.
See [this](https://github.com/angular/angular/blob/master/README.md) for up-to-date Angular 2 browser support.

* Chrome (45+)
* Firefox (40+)
* IE (9+) (but see [Bootstrap 4's notes](http://v4-alpha.getbootstrap.com/getting-started/browsers-devices/#internet-explorer-9) on IE9)
* Edge (20+)
* Safari (7+)

## Contributing to the project

We are always looking for the quality contributions! Please check the [CONTRIBUTING.md](CONTRIBUTING.md) doc for contribution guidelines.

## Getting Help

Please, do not open issues for the general support questions as we want to keep GitHub issues for bug reports and feature requests. You've got much better chances of getting your question answered on [StackOverflow](http://stackoverflow.com/questions/tagged/ng-bootstrap) where maintainers are looking at questions tagged with `ng-bootstrap`.

StackOverflow is a much better place to ask questions since:
* there are hundreds of people willing to help on StackOverflow
* questions and answers stay available for public viewing so your question / answer might help someone else
* SO voting system assures that the best answers are prominently visible.
{'fraction_non_alphanumeric': 0.11253976670201485, 'fraction_numerical': 0.008218451749734889, 'mean_word_length': 4.817270624518119, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 21, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1132198', 'n_tokens_mistral': 2255, 'n_tokens_neox': 2093, 'n_words': 797}