@ blackbaud/ 帮助客户端

提供客户端库,用于与“帮助部件”互动。 此模块属于 @ sskyux-sdk/ 建设者 财务报告和审定财务报表 @blackbaud/skyux-lib-帮助。 。 。 .

SKYUX 用户

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

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

见 帮助配置( t) 用于更多的配置属性.

菜单模式

何时 helpMode 实值 menu,期望是 @blackbaud-internal/skyux-spa-omnibar 将控制无所不在的触发器,而不是 help-client因此, help-client 将 没有 显示任何触发部件的可视元素。 奥姆尼巴将在菜单设计中构建出视觉元素取而代之. 任何用途 BBHELP.HelpWidget#open 将会导致在新标签中打开这个话题.

menu 为任何消费者推荐的模式.

遗留模式

何时 helpMode 实值 legacy, (中文(简体) ), help-client 在 DOM 中添加一个触发器,用于模仿 @blackbaud-internal/skyux-spa-omnibar 并设置一个无所不在的触发器 顶端 在全纳巴。 所有用途 BBHELP.HelpWidget 将扩展此触发器, 在帮助部件中显示想要的话题 .