ngx permission
Table of contents
About
Angular 2 or Angular 4 implementation of angular-permission
Installation
Install through npm:
npm install --save ngx-permission
Then include in your apps module:
;;
Define role and role validation function by RoleStoreService
Now you can use onlyForRoles and exceptRoles directives in your components:
;
Router
set canActivate property RouterConnector class
{
path: 'about',
component: AboutComponent,
data: {
ngxPermissions: {
only: ['user']
}
},
canActivate: [RouterConnector]
},
{
path: 'secret',
component: SectetDataComponent,
data: {
ngxPermissions: {
exept: ['user'],
redirectTo: 'about'
}
},
canActivate: [RouterConnector]
}
Usage without a module bundler
<script src="node_modules/ngx-permission/bundles/ngx-permission.umd.js"></script>
<script>
// everything is exported ngxPermission namespace
</script>
Documentation
All documentation is auto-generated from the source via compodoc and can be viewed here: https://TekVanDo.github.io/ngx-permission/docs/
Roadmap
- implements forRoot and forChild functions
- add support for observables
- implements permissions
- improve documentation
- better tests coverage
- nested roles
Development
Prepare your environment
- Install Node.js and NPM
- Install local dev dependencies:
npm install
while current directory is this repo
Development server
Run npm start
to start a development server on port 8000 with auto reload + tests.
Testing
Run npm test
to run tests once or npm run test:watch
to continually run tests.
Release
- Bump the version in package.json (once the module hits 1.0 this will become automatic)
npm run release
License
MIT