AngularUI - The companion suite for AngularJS
Usage
Requirements
- AngularJS v1.0.0+ is currently required.
- jQuery / Plugins (depends on directive). Check specific directive dependencies for more information
Installation
The repository comes with the modules pre-built and compressed into the build/
directory.
angular.module('myApp', ['ui']);
The modules can be found in the Directives and Filters folders. Check out the readme file associated with each module for specific module usage information.
Development
You do not need to build the project to use it - see above - but if you are working on it then this is what you need to know.
Requirements
-
Install Node.js and NPM (should come with)
-
Install local dependencies:
$ npm install
- Install global dependencies
grunt
,coffee-script
, andtestacular
:
$ npm install -g testacular coffee-script grunt
Build Files & Run Tests
Before you commit, always run grunt
to build and test everything once.
$ grunt
Test & Develop
The modules come with unit tests that should be run on any changes and certainly before commiting changes to the project. The unit tests should also provide further insight into the usage of the modules.
First, start the testacular server:
$ grunt server
Then, open your browser to http://localhost:8080 and run the watch command to re-run tests on every save:
$ grunt watch
Publishing
For core team: if you wish to publish a new version follow these steps:
- Bump the version number inside
package.json
- Build and test
- Commit the updated
package.json
andbuild/
folder on their own commit - Tag the commit:
git tag v[maj].[min].[patch]
- Push the tag:
git push [angular-ui] master --tags