Interface
The extension interface for ContextTool extension point.
Properties
| Property | Type | Notes |
|---|---|---|
checked | (props: LayoutContextToolProps) => boolean | Check whether this tool is checked. |
disabled | (props: LayoutContextToolProps) => boolean | Check whether this tool is disabled. |
getGroupId | () => string | Return group id. |
getIcon | () => ComponentClass<SVGAttributes<SVGElement>> | Return the icon. |
getSettingPanel | (props: LayoutContextToolProps) => FunctionComponent<any> | ComponentClass<any, any> | 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 | (props: LayoutContextToolProps) => string | Return the title. |
idinherited | string | The unique ID. For widget's provided extension, the id pattern is: widgetId + extensionName |
indexinherited | number | If an extension point supports multiple extensions, the index is used to determine the extension order. |
labelinherited | string | The extension label. |
nameinherited | string | The extension name. |
onClick | (props: LayoutContextToolProps, evt?: MouseEvent<any>) => void | OnClick callback. |
openWhenAdded | boolean | Check whether this tool should be opened by default when the toolbar opened. |
visible | (props: LayoutContextToolProps) => boolean | Check whether this tool is visible. |
widgetIdinherited | string | The widget ID that provides the extension. No widget id means the extension is provided by Jimu. |