National Pest Management

    This package has been deprecated

    Author message:

    this has been replaced by @myuw-web-components/myuw-help

    @myuw-web-components/myuw-help-and-feedback

    1.1.0 • Public • Published

    myuw-help

    This component provides a way to present help/feedback resources and information in a dialog so users can get help quickly, without leaving the page.

    Development and contribution

    To run the demo app locally and test the component, run the following commands:

    $ npm install
    $ npm start

    Usage

    Add the following import to your page's <head>:

    <script type="module" src="https://unpkg.com/@myuw-web-components/myuw-help?module"></script>
    <script nomodule src="https://unpkg.com/@myuw-web-components/myuw-help"></script>

    Fire the show-myuw-help event on the document.body when you want the dialog to display (e.g. when your "help" button is clicked):

    function showHelpDialog() {
        var event = new Event('show-myuw-help');
        document.body.dispatchEvent(event);
    }

    Note: It is important that you use that exact event name and dispatch the event from the document body. The component sets a listener on the body that listens for the show-myuw-help event.

    Use the component's HTML tag wherever you want:

        <myuw-help
            myuw-help-title="Get help"
            show-default-content
            open>
            <div class="your-div-here" slot="myuw-help-content">
                Your custom content
            </div>
        </myuw-help

    Configurable properties via attributes

    • myuw-help-title: The title to display at the top of the help dialog
    • show-default-content: Include this attribute if you want to include the default UW-Madison-flavored help links.
    • open: Only include this attribute if the dialog should be open by default

    Slots

    • myuw-help-content: Use this slot to insert your own content into the dialog (with whatever markup and styling you want).

    Keywords

    none

    Install

    npm i @myuw-web-components/myuw-help-and-feedback

    DownloadsWeekly Downloads

    6

    Version

    1.1.0

    License

    Apache-2.0

    Unpacked Size

    44.6 kB

    Total Files

    7

    Last publish

    Collaborators

    • benjaminsousa
    • lstels
    • nogalpaulina
    • myuw-web-components-jenkins
    • jordanalanjones
    • zeke.witter
    • apetro
    • scott.berg