121 lines
4.4 KiB
Markdown
121 lines
4.4 KiB
Markdown
|
### UI Bootstrap - [AngularJS](http://angularjs.org/) directives specific to [Bootstrap](http://getbootstrap.com)
|
||
|
|
|
||
|
|
[](https://gitter.im/angular-ui/bootstrap?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||
|
|
[](http://travis-ci.org/angular-ui/bootstrap)
|
||
|
|
[](https://david-dm.org/angular-ui/bootstrap#info=devDependencies)
|
||
|
|
|
||
|
|
### Quick links
|
||
|
|
- [Demo](#demo)
|
||
|
|
- [Installation](#installation)
|
||
|
|
- [NPM](#install-with-npm)
|
||
|
|
- [Bower](#install-with-bower)
|
||
|
|
- [NuGet](#install-with-nuget)
|
||
|
|
- [Custom](#custom-build)
|
||
|
|
- [Manual](#manual-download)
|
||
|
|
- [Support](#support)
|
||
|
|
- [FAQ](#faq)
|
||
|
|
- [Supported browsers](#supported-browsers)
|
||
|
|
- [Need help?](#need-help)
|
||
|
|
- [Found a bug?](#found-a-bug)
|
||
|
|
- [Contributing to the project](#contributing-to-the-project)
|
||
|
|
- [Development, meeting minutes, roadmap and more.](#development-meeting-minutes-roadmap-and-more)
|
||
|
|
|
||
|
|
|
||
|
|
# Demo
|
||
|
|
|
||
|
|
Do you want to see directives in action? Visit http://angular-ui.github.io/bootstrap/!
|
||
|
|
|
||
|
|
# Installation
|
||
|
|
|
||
|
|
Installation is easy as UI Bootstrap has minimal dependencies - only the AngularJS and Twitter Bootstrap's CSS are required.
|
||
|
|
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.
|
||
|
|
|
||
|
|
#### Install with NPM
|
||
|
|
|
||
|
|
```sh
|
||
|
|
$ npm install angular-ui-bootstrap
|
||
|
|
```
|
||
|
|
|
||
|
|
This will install AngularJS and Bootstrap NPM packages.
|
||
|
|
|
||
|
|
#### Install with Bower
|
||
|
|
```sh
|
||
|
|
$ bower install angular-bootstrap
|
||
|
|
```
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
#### Install with NuGet
|
||
|
|
To install AngularJS UI Bootstrap, run the following command in the Package Manager Console
|
||
|
|
|
||
|
|
```sh
|
||
|
|
PM> Install-Package Angular.UI.Bootstrap
|
||
|
|
```
|
||
|
|
|
||
|
|
#### Custom build
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
#### Manual download
|
||
|
|
|
||
|
|
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:
|
||
|
|
https://github.com/angular-ui/bootstrap/tree/gh-pages#build-files
|
||
|
|
Don't worry, if you are not sure which file to take, opt for `ui-bootstrap-tpls-[version].min.js`.
|
||
|
|
|
||
|
|
### Adding dependency to your project
|
||
|
|
|
||
|
|
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:
|
||
|
|
|
||
|
|
```js
|
||
|
|
angular.module('myModule', ['ui.bootstrap']);
|
||
|
|
```
|
||
|
|
|
||
|
|
If you're a Browserify or Webpack user, you can do:
|
||
|
|
|
||
|
|
```js
|
||
|
|
var uibs = require('angular-ui-bootstrap');
|
||
|
|
|
||
|
|
angular.module('myModule', [uibs]);
|
||
|
|
```
|
||
|
|
|
||
|
|
# Support
|
||
|
|
|
||
|
|
## FAQ
|
||
|
|
|
||
|
|
https://github.com/angular-ui/bootstrap/wiki/FAQ
|
||
|
|
|
||
|
|
## Supported browsers
|
||
|
|
|
||
|
|
Directives from this repository are automatically tested with the following browsers:
|
||
|
|
* Chrome (stable and canary channel)
|
||
|
|
* Firefox
|
||
|
|
* IE 9 and 10
|
||
|
|
* Opera
|
||
|
|
* Safari
|
||
|
|
|
||
|
|
Modern mobile browsers should work without problems.
|
||
|
|
|
||
|
|
|
||
|
|
## Need help?
|
||
|
|
Need help using UI Bootstrap?
|
||
|
|
|
||
|
|
* Live help in the IRC (`#angularjs` channel at the `freenode` network). Use this [webchat](https://webchat.freenode.net/) or your own IRC client.
|
||
|
|
* Ask a question in [StackOverflow](http://stackoverflow.com/) under the [angular-ui-bootstrap](http://stackoverflow.com/questions/tagged/angular-ui-bootstrap) tag.
|
||
|
|
|
||
|
|
**Please do not create new issues in this repository to ask questions about using UI Bootstrap**
|
||
|
|
|
||
|
|
## Found a bug?
|
||
|
|
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).
|
||
|
|
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
|
||
|
|
# Contributing to the project
|
||
|
|
|
||
|
|
We are always looking for the quality contributions! Please check the [CONTRIBUTING.md](CONTRIBUTING.md) for the contribution guidelines.
|
||
|
|
|
||
|
|
# Development, meeting minutes, roadmap and more.
|
||
|
|
|
||
|
|
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.
|