3.1.1 • Published 3 years ago

@blackbaud/help-client v3.1.1

Weekly downloads
2,172
License
MIT
Repository
github
Last release
3 years ago

@blackbaud/help-client

npm status

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.

Menu mode

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.

3.1.1

3 years ago

3.1.0

3 years ago

3.0.1

4 years ago

3.0.1-rc.21

4 years ago

3.0.1-rc.20

4 years ago

3.0.1-rc.22

4 years ago

3.0.1-rc.18

4 years ago

3.0.1-rc.19

4 years ago

3.0.1-rc.17

4 years ago

3.0.1-rc.16

4 years ago

3.0.1-rc.15

4 years ago

3.0.1-rc.14

4 years ago

3.0.1-rc.13

4 years ago

3.0.1-rc.12

4 years ago

3.0.1-rc.11

4 years ago

3.0.1-rc.6

4 years ago

3.0.1-rc.7

4 years ago

3.0.1-rc.4

4 years ago

3.0.1-rc.5

4 years ago

3.0.1-rc.10

4 years ago

3.0.1-rc.2

4 years ago

3.0.1-rc.3

4 years ago

3.0.1-rc.8

4 years ago

3.0.1-rc.9

4 years ago

3.0.1-rc.1

4 years ago

3.0.1-rc.0

4 years ago

3.0.0

5 years ago

3.0.0-rc.0

5 years ago

2.2.0

5 years ago

2.1.0

6 years ago

2.0.3

6 years ago

2.0.2

6 years ago

2.0.1

6 years ago

2.0.0

6 years ago

2.0.0-beta.10

6 years ago

2.0.0-beta.9

6 years ago

2.0.0-beta.8

6 years ago

2.0.0-beta.7

6 years ago

2.0.0-beta.6

6 years ago

2.0.0-beta.5

6 years ago

2.0.0-beta.4

6 years ago

2.0.0-beta.3

6 years ago

2.0.0-beta.2

6 years ago

2.0.0-beta.1

6 years ago

1.3.0

7 years ago

1.2.0

7 years ago

1.1.0

8 years ago

1.0.2

8 years ago

1.0.1

8 years ago

1.0.0

8 years ago