pip-webui/pip-webui-settings/README.md

HTML5 UI for LOB applications

# <img src="https://github.com/pip-webui/pip-webui/raw/master/doc/Logo.png" alt="Pip.WebUI Logo" style="max-width:30%"> <br/> Extensible settings page

![](https://img.shields.io/badge/license-MIT-blue.svg)

Settings page allows users to set their preferences and change application settings.
Pip.WebUI.Settings module implements extensible settings page that can be filled with tabs by application developers.
The module also contains few standard tabs for basic user info and active sessions.

### pipSettings provider

pipSettings provider allows to configure Settings page and fill it with standard or custom tabs.

```javascript
pipSettingsProvider.addTab({
    state: 'custom',
    title: 'Custom tab',
    auth: true,
    stateConfig: {
        url: '/custom',
        templateUrl: 'custom_tab.html'
    }
});
```

### Basic Info tab

Basic Info tab allows to change user account and set preferences like language, theme. 
Also here user change change his password or verify his primary email address.
This tab requires presence of the standard **users** REST API.

<img src="https://github.com/pip-webui/pip-webui-settings/raw/master/doc/images/img-settings-basic-info.png"/>

### Active Sessions tab

Active Sessions tab shows currently open user sessions and allows to close them.
This tab requires presence of the standard **sessions** REST API.

<img src="https://github.com/pip-webui/pip-webui-settings/raw/master/doc/images/img-settings-active-sessions.png"/>

## Learn more about the module

- [User's guide](https://github.com/pip-webui/pip-webui-settings/blob/master/doc/UsersGuide.md)
- [Online samples](http://webui.pipdevs.com/pip-webui-settings/index.html)
- [API reference](http://webui-api.pipdevs.com/pip-webui-settings/index.html)
- [Developer's guide](https://github.com/pip-webui/pip-webui-settings/blob/master/doc/DevelopersGuide.md)
- [Changelog](https://github.com/pip-webui/pip-webui-settings/blob/master/CHANGELOG.md)
- [Pip.WebUI project website](http://www.pipwebui.org)
- [Pip.WebUI project wiki](https://github.com/pip-webui/pip-webui/wiki)
- [Pip.WebUI discussion forum](https://groups.google.com/forum/#!forum/pip-webui)
- [Pip.WebUI team blog](https://pip-webui.blogspot.com/)

## <a name="dependencies"></a>Module dependencies

* [pip-webui-lib](https://github.com/pip-webui/pip-webui-lib): angular, angular material and other 3rd party libraries
* [pip-webui-css](https://github.com/pip-webui/pip-webui-css): CSS styles and web components
* [pip-webui-core](https://github.com/pip-webui/pip-webui-core): localization and other core services
* [pip-webui-rest](https://github.com/pip-webui/pip-webui-rest): REST resources for users, files and sessions
* [pip-webui-controls](https://github.com/pip-webui/pip-webui-controls): date and time controls (??)
* [pip-webui-layouts](https://github.com/pip-webui/pip-webui-layouts): document layout
* [pip-webui-nav](https://github.com/pip-webui/pip-webui-nav): navigation dropdown
* [pip-webui-locations](https://github.com/pip-webui/pip-webui-locations): location control to show current user and signin locations
* [pip-webui-pictures](https://github.com/pip-webui/pip-webui-pictures): user avatar control

## <a name="license"></a>License

This module is released under [MIT license](License) and totally free for commercial and non-commercial use.