Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rpocklin/ui-router-tabs
Idiot-proof tab panes with route support using Angular.js + Bootstrap 3 + UI Router
https://github.com/rpocklin/ui-router-tabs
Last synced: 4 months ago
JSON representation
Idiot-proof tab panes with route support using Angular.js + Bootstrap 3 + UI Router
- Host: GitHub
- URL: https://github.com/rpocklin/ui-router-tabs
- Owner: rpocklin
- License: other
- Created: 2014-09-09T06:25:29.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-07-05T02:25:59.000Z (over 7 years ago)
- Last Synced: 2024-05-14T18:19:46.637Z (9 months ago)
- Language: JavaScript
- Size: 2.72 MB
- Stars: 244
- Watchers: 12
- Forks: 57
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# UI Router Tabs
Leverages [UI Bootstrap](http://angular-ui.github.io/bootstrap/) and [UI Router](https://github.com/angular-ui/ui-router) to give you full-strength route-driven tabs in Angular.js.
[](http:/travis-ci.org/rpocklin/ui-router-tabs)
[](https://coveralls.io/r/rpocklin/ui-router-tabs)
[](https://gratipay.com/rpocklin/)
## Example / Demo
[Link](http://rpocklin.github.io/ui-router-tabs/example/index.html)
## How to Install / Usage
1. Install the plugin into your Angular.js project, manually or via `bower install angular-ui-router-tabs`
1. Add `ui.router.tabs` as a new module dependency in your angular app.
1. Define your routes in a hierarchy that makes sense for a tabbed layout, Eg:
```javascript
$stateProvider.state('user', {
url: '',
controller: 'UserCtrl',
templateUrl: 'example.html'
}).state('user.settings', {
url: '/user/settings',
templateUrl: 'user/settings.html'
}).state('user.accounts', {
url: '/user/accounts',
templateUrl: 'user/accounts.html'
});
```
1. Define your `tabData` (or similiar variable) in the root view controller of your tabs (ie. `UserCtrl` in the case above) Eg:
```javascript
$scope.tabData = [
{
heading: 'Settings',
route: 'user.settings'
},
{
heading: 'Accounts',
route: 'user.accounts',
disable: true
}
];
```
NOTE: You can also specify `params` and `options` to pass special parameters or options for the target route to UI Router, Eg:
```javascript
{
heading: 'Accounts',
route: 'user.accounts',
params: {
accountId: account.id
},
options: {}
}
```
1. Declare the following in your the parent HTML view template ``.
Optional attributes for the `` (which are passed on to the UI Bootstrap component) are:
* `type: [ 'tabs' | 'pills' ]`
* `vertical: boolean`
* `justified: boolean`
* `class: string`
* `templateUrl: `
NOTE: If you use a custom template, you may need to define a `ui-view` placeholder for the child content panes in the same HTML view template eg. ``.
## Tips
* UI Bootstrap Tabs will not select a tab by default. If you want it to, specify the target sub-route when you
show the tabs (ie. link the `ui-view` containing the tabs with the default (first) element as the sub-route `example/#/user/settings` in the example.)
* You can override the default directive template by specifying `template-url="my_template.html"` on the `` element.
* You can enable / disable tabs by specifying `disable: true` in the `tabData` (can be dynamically set).
* You can use `` in a custom directive template to add any HTML into the tab title (eg. icons)
* You can update the `tabData` variable dynamically, if you want to.
* You can move the `` tag around to wherever you want the tab listing to appear. (left-positioned is the best spot to enable responsive design.).
* Each tab will have a default class of `tab`, an active tab will have the `active` class.
## Running Locally
1. Checkout git repository locally: `git clone [email protected]:rpocklin/ui-router-tabs.git`
1. `npm install`
1. `bower install`
1. `grunt serve`
1. View `http://localhost:9000/example/` in your browser to see the example.
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`) - please consider adding tests!
4. Push to the branch (`git push origin my-new-feature`)
5. Run `grunt` and ensure there are no errors.
6. Create a new Pull Request
## History
* 2.0.2 Fixed invalid `` placement in default template.
* 2.0.1 Fixed invalid html in default template (missing `
`).
* 2.0.0 Added `class` and `template-url` attributes on `uib-tab` and began using `` tag.
* 1.8.0 Added inline template by default (as requested) and allowed customer classes parameter.
* 1.7.0 Added `uib` prefix for UI Bootstrap elements (as per v0.14.0). See [#47](/../../pull/47).
Upgraded angular-bootstrap to v14.0.
* 1.6.0 Renamed `disabled` attribute to `disable` in line with UI Bootstrap ``. See [#39](/../../issues/39).
* 1.5.1 Removed `bower_components` from repository. See [#40](/../../pull/40).
* 1.5.0 Bumped `angular-bootstrap` dependency to v0.13.0 (fixes default tab being auto-selected).
* 1.4.3 Added handling of `$stateChangeCancel`, `$stateChangeError` and `$stateNotFound` to reset active tab.
* 1.4.2 Added feature to update tabs if state change event is cancelled. See [#19](/../../pull/19).
* 1.4.1 Bumped angular-bootstrap dependency to v0.12.1.
* 1.4.0 Removed default `$state.go(..)` route option, added `disabled` option and updated jsbeautifier. See [#16](/../../pull/16).
* 1.3.0 Improved state equality checking to include params and options.
* 1.2.0 Prevented reload of current state again. See [#11](/../../pull/11).
* 1.1.4 Added support for `strict-di` mode.
* 1.1.3 Fixed tab switching when using `ngTouch`. See [#2](/../../issues/2).
* 1.1.2 Added `$stateChangeSuccess` watcher to update parent tab(s) when using
`ui-sref` or `$state.go()`. See [#1](/../../issues/1).
* 1.1.0 Added nested tab support (tabs within tabs)
* 1.0.0 Initial release
## License
Released under the MIT License. See the [LICENSE][license] file for further details.
[license]: https://github.com/rpocklin/ui-router-tabs/blob/master/LICENSE