ToolAssistanceFieldProps Interface

Properties of ToolAssistanceField component.

Extends

Inherited methods

Name Inherited from Description
onOpenWidget(widget: StatusBarFieldId): void StatusFieldProps Function called when the widget is opened or closed.

Properties

Name Type Description
cursorPromptTimeout number Cursor Prompt Timeout period.  
defaultPromptAtCursor boolean Indicates whether to show promptAtCursor by default.  
fadeOutCursorPrompt boolean Fade Out the Cursor Prompt when closed.  
includePromptAtCursor boolean Indicates whether to include promptAtCursor Checkbox.  
uiSettings undefined | UiSettingsStorage Optional parameter for persistent UI settings.  

Inherited properties

Name Type Inherited from Description
className undefined | string StatusFieldProps Custom CSS class name
isInFooterMode boolean StatusFieldProps Indicates whether the StatusBar is in footer mode
openWidget StatusBarFieldId StatusFieldProps Field Id for open widgets
style undefined | CSSProperties StatusFieldProps Custom CSS style properties

Defined in

Last Updated: 12 June, 2024