You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on May 29, 2019. It is now read-only.
-[Contributing to the project](#contributing-to-the-project)
20
+
-[Development, meeting minutes, roadmap and more.](#development-meeting-minutes-roadmap-and-more)
21
+
11
22
12
-
As of 17 Jan 2015 the project has brought on new maintainers to try and clear through the backlog of Angular 1.3 issues. As you can appreciate this is a **massive** undertaking
13
-
by a purely part-time, unpaid volunteer team; so please be patient with us! The milestones are as follows:
23
+
# Demo
14
24
15
-
***DONE** - The **0.12.1** milestone will be for bug fixes for the existing Angular 1.2 supported version
16
-
* The **0.13.0** milestone will contain issues / PRs that are majorly blocking 1.3 compatibility
17
-
* The **0.13.x** milestone will contain issues / PRs that are nice to haves for 1.3 compatibility
18
-
* The **1.0** milestone is TBA
19
-
* The **Backlog** milestone is nice to haves
20
-
* The **Purgatory** Milestone is *"Good luck getting that in"*
25
+
Do you want to see directives in action? Visit http://angular-ui.github.io/bootstrap/!
21
26
22
-
The plan is to:
27
+
# Installation
23
28
24
-
1.**DONE** - **Rapidly Release 0.12.1** - new Maintainers learning the merge and release process
25
-
1.**Triage of existing Pull Requests** - into 0.13.0, 0.13.x, Backlog and Purgatory milestones
26
-
1.**Triage of existing issues** - into 0.13.0, 0.13.x, Backlog and Purgatory milestones
27
-
1. Obligatory - **profit!**
29
+
Installation is easy as UI Bootstrap has minimal dependencies - only the AngularJS and Twitter Bootstrap's CSS are required.
28
30
29
-
## Demo
31
+
#### Install with Bower
32
+
```sh
33
+
$ bower install angular-ui-bootstrap
34
+
```
30
35
31
-
Do you want to see directives in action? Visit http://angular-ui.github.io/bootstrap/!
36
+
#### Install with NuGet
37
+
To install AngularJS UI Bootstrap, run the following command in the Package Manager Console
32
38
33
-
## Installation
39
+
```sh
40
+
PM> Install-Package Angular.UI.Bootstrap
41
+
```
42
+
43
+
#### Custom build
44
+
45
+
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.
34
46
35
-
Installation is easy as angular-ui-bootstrap has minimal dependencies - only the AngularJS and Bootstrap's CSS are required.
36
-
After downloading dependencies (or better yet, referencing them from your favourite CDN) you need to download build version of this project. All the files and their purposes are described here:
47
+
#### Manual download
48
+
49
+
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:
Don't worry, if you are not sure which file to take, opt for `ui-bootstrap-tpls-[version].min.js`.
39
52
53
+
### Adding dependency to your project
54
+
40
55
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:
41
56
42
-
```javascript
57
+
```js
43
58
angular.module('myModule', ['ui.bootstrap']);
44
59
```
45
60
46
-
Project files are also available through your favourite package manager:
If you are having problems making some directives work, there are several ways to get help:
53
-
54
-
* Live help in the IRC (`#angularjs` channel at the `freenode` network). Use this [webchat](https://webchat.freenode.net/) or your own IRC client.
55
-
* Ask a question in [stackoverflow](http://stackoverflow.com/) under the [angular-ui-bootstrap](http://stackoverflow.com/questions/tagged/angular-ui-bootstrap) tag.
56
-
* Write your question in our [mailing list](https://groups.google.com/forum/#!categories/angular-ui/bootstrap).
57
-
58
-
Project's issue on GitHub should be used discuss bugs and features.
61
+
# Support
59
62
60
63
## FAQ
61
64
@@ -72,143 +75,26 @@ Directives from this repository are automatically tested with the following brow
72
75
73
76
Modern mobile browsers should work without problems.
74
77
75
-
**IE 8 is not officially supported at the moment**. This project is run by volunteers and with the current number of commiters
76
-
we are not in the position to guarantee IE8 support. If you need support for IE8 we would welcome a contributor who would like to take care about IE8.
77
-
Alternatively you could sponsor this project to guarantee IE8 support.
78
-
79
-
We believe that most of the directives would work OK after:
80
-
* including relevant shims (for ES5 we recommend https://github.com/kriskowal/es5-shim)
81
-
* taking care of the steps described in http://docs.angularjs.org/guide/ie
82
-
83
-
We are simply not regularly testing against IE8.
84
-
85
-
## Project philosophy
86
-
87
-
### Native, lightweight directives
88
-
89
-
We are aiming at providing a set of AngularJS directives based on Bootstrap's markup and CSS. The goal is to provide **native AngularJS directives** without any dependency on jQuery or Bootstrap's JavaScript.
90
-
It is often better to rewrite an existing JavaScript code and create a new, pure AngularJS directive. Most of the time the resulting directive is smaller as compared to the original JavaScript code size and better integrated into the AngularJS ecosystem.
91
-
92
-
### Customizability
93
-
94
-
All the directives in this repository should have their markup externalized as templates (loaded via `templateUrl`). In practice it means that you can **customize directive's markup at will**. One could even imagine providing a non-Bootstrap version of the templates!
95
78
96
-
### Take what you need and not more
97
-
98
-
Each directive has its own AngularJS module without any dependencies on other modules or third-party JavaScript code. In practice it means that you can **just grab the code for the directives you need** and you are not obliged to drag the whole repository.
99
-
100
-
### Quality and stability
101
-
102
-
Directives should work. All the time and in all browsers. This is why all the directives have a comprehensive suite of unit tests. All the automated tests are executed on each checkin in several browsers: Chrome, ChromeCanary, Firefox, Opera, Safari, IE9.
103
-
In fact we are fortunate enough to **benefit from the same testing infrastructure as AngularJS**!
104
-
105
-
## Support
106
-
107
-
If you are having problems making some directives work, there are several ways to get help:
79
+
## Need help?
80
+
Need help using UI Bootstrap?
108
81
109
82
* Live help in the IRC (`#angularjs` channel at the `freenode` network). Use this [webchat](https://webchat.freenode.net/) or your own IRC client.
110
-
* Ask a question in [stackoverflow](http://stackoverflow.com/) under the [angular-ui-bootstrap](http://stackoverflow.com/questions/tagged/angular-ui-bootstrap) tag.
111
-
* Write your question in our [mailing list](https://groups.google.com/forum/#!categories/angular-ui/bootstrap).
112
-
113
-
Project's issue on GitHub should be used discuss bugs and features.
83
+
* Ask a question in [StackOverflow](http://stackoverflow.com/) under the [angular-ui-bootstrap](http://stackoverflow.com/questions/tagged/angular-ui-bootstrap) tag.
114
84
115
-
## Contributing to the project
85
+
**Please do not create new issues in this repository to ask questions about using UI Bootstrap**
116
86
117
-
We are always looking for the quality contributions! Please check the [CONTRIBUTING.md](CONTRIBUTING.md) for the contribution guidelines.
118
-
119
-
### Development
120
-
#### Prepare your environment
121
-
* Install [Node.js](http://nodejs.org/) and NPM (should come with)
122
-
* Install global dev dependencies: `npm install -g grunt-cli karma`
123
-
* Install local dev dependencies: `npm install` while current directory is bootstrap repo
124
-
125
-
#### Build
126
-
* Build the whole project: `grunt` - this will run `lint`, `test`, and `concat` targets
127
-
* To build modules, first run `grunt html2js` then `grunt build:module1:module2...:moduleN`
128
-
129
-
You can generate a custom build, containing only needed modules, from the project's homepage.
130
-
Alternatively you can run local Grunt build from the command line and list needed modules as shown below:
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).
135
89
136
-
Check the Grunt build file for other tasks that are defined for this project.
137
90
138
-
#### TDD
139
-
* Run test: `grunt watch`
140
-
141
-
This will start Karma server and will continuously watch files in the project, executing tests upon every change.
91
+
----
142
92
143
-
#### Test coverage
144
-
Add the `--coverage` option (e.g. `grunt test --coverage`, `grunt watch --coverage`) to see reports on the test coverage. These coverage reports are found in the coverage folder.
145
93
146
-
### Customize templates
94
+
#Contributing to the project
147
95
148
-
As mentioned directives from this repository have all the markup externalized in templates. You might want to customize default
149
-
templates to match your desired look & feel, add new functionality etc.
150
-
151
-
The easiest way to override an individual template is to use the `<script>` directive:
For more information visit: https://github.com/karlgoldstein/grunt-html2js
96
+
We are always looking for the quality contributions! Please check the [CONTRIBUTING.md](CONTRIBUTING.md) for the contribution guidelines.
200
97
201
-
### Release
202
-
* Bump up version number in `package.json`
203
-
* Commit the version change with the following message: `chore(release): [version number]`
204
-
* tag
205
-
* push changes and a tag (`git push --tags`)
206
-
* switch to the `gh-pages` branch: `git checkout gh-pages`
207
-
* copy content of the dist folder to the main folder
208
-
* Commit the version change with the following message: `chore(release): [version number]`
209
-
* push changes
210
-
* switch back to the `main branch` and modify `package.json` to bump up version for the next iteration
211
-
* commit (`chore(release): starting [version number]`) and push
212
-
* publish Bower and NuGet packages
98
+
# Development, meeting minutes, roadmap and more.
213
99
214
-
Well done! (If you don't like repeating yourself open a PR with a grunt task taking care of the above!)
100
+
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.
0 commit comments