The extension interface for ContextTool extension point.

Inheritance: ContextToolExtensionBaseExtension


checked optional
checked: (propsLayoutContextToolProps) => boolean

Check whether this tool is checked.

disabled optional
disabled: (propsLayoutContextToolProps) => boolean

Check whether this tool is disabled.

getGroupId: () => string

Return group id.

getIcon: () => ComponentClass<SVGAttributes<SVGElement>any>

Return the icon.

getSettingPanel: (propsLayoutContextToolProps) => ComponentClass<unknownany>

The setting panel of the tool. Returning null means there is no setting panel for the tool. If the returned value is not null, the setting panel will be rendered.

getTitle: () => string

Return the title.

id: string

The unique id. For widget's provided extension, the id pattern is: widgetId + extensionName

index optional
index: number

If an extension point supports multiple extensions, the index is used to determine the extension order.

name optional
name: string

The extension name.

onClick optional
onClick: (propsLayoutContextToolProps, evt?MouseEvent<anyMouseEvent>) => void

OnClick callback.

visible optional
visible: (propsLayoutContextToolProps) => boolean

Check whether this tool is visible.

widgetId optional
widgetId: string

The widget id that provides the extension. No widget id means the extension is provided by Jimu.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.