pip-webui-help

Extensible help page for Pip.WebUI

Usage no npm install needed!

<script type="module">
  import pipWebuiHelp from 'https://cdn.skypack.dev/pip-webui-help';
</script>

README

Pip.WebUI Logo
Extensible help page

Any non-trivial application contains complex functionality. To use it effectively, user may need extra help. Pip.WebUI.Help module implements extensible help page that can be filled with tabs by application developers. Each tab may contain help information on various topics

pipHelp provider

pipHelp provider allows to configure Help page and fill it with tabs.

pipHelpProvider.addTab({
    state: 'custom',
    title: 'Custom tab',
    auth: true,
    stateConfig: {
        url: '/custom',
        templateUrl: 'help_custom_tab.html'
    }
});

Help page

Help page implemented as extensible container that can be filled with content tabs. It can navigated to using help state or /#help route.

Todo: Replace the image with more realistic help content

Help Page Sample

Learn more about the module

Module dependencies

License

This module is released under MIT license and totally free for commercial and non-commercial use.