Interface: ExtensionConfigComponentProps<TConfig>
Makaio Framework / contracts / ExtensionConfigComponentProps
Interface: ExtensionConfigComponentProps<TConfig>
Section titled “Interface: ExtensionConfigComponentProps<TConfig>”Defined in: ../../../packages/contracts/src/extension/contributions/web-ui-types.ts:128
Props for custom extension configuration components.
When an extension provides ui.configComponent, the loaded component receives
these props to interact with the extension configuration system.
Type Parameters
Section titled “Type Parameters”TConfig
Section titled “TConfig”TConfig = unknown
Extension configuration type.
Properties
Section titled “Properties”config
Section titled “config”config:
TConfig
Defined in: ../../../packages/contracts/src/extension/contributions/web-ui-types.ts:130
Current configuration values.
errors?
Section titled “errors?”
optionalerrors?:Record<string,string>
Defined in: ../../../packages/contracts/src/extension/contributions/web-ui-types.ts:141
Validation errors keyed by field name.
isSaving
Section titled “isSaving”isSaving:
boolean
Defined in: ../../../packages/contracts/src/extension/contributions/web-ui-types.ts:139
Whether a save is currently in progress.
onChange
Section titled “onChange”onChange: (
config) =>void
Defined in: ../../../packages/contracts/src/extension/contributions/web-ui-types.ts:135
Called when configuration values change.
Parameters
Section titled “Parameters”config
Section titled “config”TConfig
Updated configuration.
Returns
Section titled “Returns”void
onSave
Section titled “onSave”onSave: () =>
Promise<void>
Defined in: ../../../packages/contracts/src/extension/contributions/web-ui-types.ts:137
Called when the user confirms the save action.
Returns
Section titled “Returns”Promise<void>