1 ### UI Bootstrap - [AngularJS](http://angularjs.org/) directives specific to [Bootstrap](http://getbootstrap.com)
3 [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/angular-ui/bootstrap?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
4 [![Build Status](https://secure.travis-ci.org/angular-ui/bootstrap.svg)](http://travis-ci.org/angular-ui/bootstrap)
5 [![devDependency Status](https://david-dm.org/angular-ui/bootstrap/dev-status.svg?branch=master)](https://david-dm.org/angular-ui/bootstrap#info=devDependencies)
9 - [Installation](#installation)
10 - [NPM](#install-with-npm)
11 - [Bower](#install-with-bower)
12 - [NuGet](#install-with-nuget)
13 - [Custom](#custom-build)
14 - [Manual](#manual-download)
17 - [Supported browsers](#supported-browsers)
18 - [Need help?](#need-help)
19 - [Found a bug?](#found-a-bug)
20 - [Contributing to the project](#contributing-to-the-project)
21 - [Development, meeting minutes, roadmap and more.](#development-meeting-minutes-roadmap-and-more)
26 Do you want to see directives in action? Visit http://angular-ui.github.io/bootstrap/!
30 Installation is easy as UI Bootstrap has minimal dependencies - only the AngularJS and Twitter Bootstrap's CSS are required.
31 Note: Since version 0.13.0, UI Bootstrap depends on [ngAnimate](https://docs.angularjs.org/api/ngAnimate) for transitions and animations, such as the accordion, carousel, etc. Include `ngAnimate` in the module dependencies for your app in order to enable animation.
36 $ npm install angular-ui-bootstrap
39 This will install AngularJS and Bootstrap NPM packages.
41 #### Install with Bower
43 $ bower install angular-bootstrap
46 Note: do not install 'angular-ui-bootstrap'. A separate repository - [bootstrap-bower](https://github.com/angular-ui/bootstrap-bower) - hosts the compiled javascript file and bower.json.
48 #### Install with NuGet
49 To install AngularJS UI Bootstrap, run the following command in the Package Manager Console
52 PM> Install-Package Angular.UI.Bootstrap
57 Head over to http://angular-ui.github.io/bootstrap/ and hit the *Custom build* button to create your own custom UI Bootstrap build, just the way you like it.
61 After downloading dependencies (or better yet, referencing them from your favorite CDN) you need to download build version of this project. All the files and their purposes are described here:
62 https://github.com/angular-ui/bootstrap/tree/gh-pages#build-files
63 Don't worry, if you are not sure which file to take, opt for `ui-bootstrap-tpls-[version].min.js`.
65 ### Adding dependency to your project
67 When you are done downloading all the dependencies and project files the only remaining part is to add dependencies on the `ui.bootstrap` AngularJS module:
70 angular.module('myModule', ['ui.bootstrap']);
73 If you're a Browserify or Webpack user, you can do:
76 var uibs = require('angular-ui-bootstrap');
78 angular.module('myModule', [uibs]);
85 https://github.com/angular-ui/bootstrap/wiki/FAQ
89 Directives from this repository are automatically tested with the following browsers:
90 * Chrome (stable and canary channel)
96 Modern mobile browsers should work without problems.
100 Need help using UI Bootstrap?
102 * Live help in the IRC (`#angularjs` channel at the `freenode` network). Use this [webchat](https://webchat.freenode.net/) or your own IRC client.
103 * Ask a question in [StackOverflow](http://stackoverflow.com/) under the [angular-ui-bootstrap](http://stackoverflow.com/questions/tagged/angular-ui-bootstrap) tag.
105 **Please do not create new issues in this repository to ask questions about using UI Bootstrap**
108 Please take a look at [CONTRIBUTING.md](CONTRIBUTING.md#you-think-youve-found-a-bug) and submit your issue [here](https://github.com/angular-ui/bootstrap/issues/new).
114 # Contributing to the project
116 We are always looking for the quality contributions! Please check the [CONTRIBUTING.md](CONTRIBUTING.md) for the contribution guidelines.
118 # Development, meeting minutes, roadmap and more.
120 Head over to the [Wiki](https://github.com/angular-ui/bootstrap/wiki) for notes on development for UI Bootstrap, meeting minutes from the UI Bootstrap team, roadmap plans, project philosophy and more.