New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

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

Package Overview
Dependencies
Maintainers
5
Versions
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

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

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.

  • 1.1.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
0
decreased by-100%
Maintainers
5
Weekly downloads
 
Created
Source

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).

FAQs

Package last updated on 27 Jul 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc