@blackbaud/help-client

Provides a client-side library for interacting with the Help Widget.

3.1.1
latest
Source
npm

Version published: 3 years ago

Maintainers: 1

Created: 8 years ago

Source

@blackbaud/help-client

Provides a client-side library for interacting with the Help Widget. This module is a dependency of @skyux-sdk/builder and @blackbaud/skyux-lib-help.

SKYUX usage

{
  "help": {
    "helpMode": "menu"
  }
}

// inside a consumer's typescript code
BBHELP.HelpWidget.open('foo.html');

See help-config.ts for more configuration properties.

When helpMode is menu, the expectation is that @blackbaud-internal/skyux-spa-omnibar will control the omnipresent trigger, not help-client. As a result, help-client will not display any visual elements for triggering the widget. The omnibar will build out visual elements in a menu design instead. Any usage of BBHELP.HelpWidget#open will result in opening the topic in a new tab.

menu is the recommended mode for any consumers.

Legacy mode

When helpMode is legacy, help-client adds a trigger to the DOM that is meant to mimic @blackbaud-internal/skyux-spa-omnibar and places an omnipresent trigger on top of the omnibar. All usages of BBHELP.HelpWidget will expand that trigger to display the desired topic in a help widget.

FAQs

What is @blackbaud/help-client?

Is @blackbaud/help-client well maintained?

Package last updated on 03 May 2022

Did you know?

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