Guides

Guides are maintained in bizdoc.json configuration.

"Guides": [
  {
    "Name": "myPurchaseGuide",
    "Title": "Purchase",
    "Steps": [
      {
        "Content": "Purchase form help!"
      },
      {
        "Selector": "[data-help=type]",
        "Content": "Type help!",
        "Position": "End"
      }
    ]
  }
]

You can set a guide to a form, report, utility, widget or cube view.

"Forms": [
  {
    "Name": "purchase",
    "Title": "Purchase",
    "Guide": "myPurchaseGuide"
  }
]

Make your component user aware.

<bizdoc-help-tip name="my-guide"></bizdoc-help-tip>

Inject the GuideService to start a guide from code.

You can change a component guide at runtime using it's reference (FormRef, ReportRef, WidgetRef or UtilityRef). For example, a form may provide different guide for line view and header view, or a different guide per user role.

import {} from '@bizdoc/core';
export class MyFormComponent implements FormComponent<MyModel> {
    constructor(private _formRef: FormRef) {}
    onBind(data: DocumentModel<MyForm>) {
        this._formRef.guide = 'myGuide';
    }
}