ILayoutNodeConfig

Interface

Interface representing the configuration for a layout node.

Properties

Property Type Notes
defaults Record<stringunknown>

Default values for the node's configuration.

i18n {
deleteLabel:
string
description:
string
editLabel:
string
label:
string
repositionDownLabel:
string
repositionUpLabel:
string
}

Various translation strings to display or use for a11y purposes in the node's editing UI

name string

Human-readable name of the layout node. Used internally for logging purposes (e.g. telemetry, etc.)

tag LayoutNodeTag

Tag of the layout node.

canAdjustVisibility Optional boolean

Whether the node's visibility is adjustable.

canEdit Optional boolean

Whether the node is editable.

canMove Optional boolean

Whether the node is repositionable.

editor Optional LayoutNodeEditorConfig

Optional editor configuration for the node. If provided and the card is editable, an edit control will be enabled that will open the editing experience defined here.

valuesProp Optional string

Property name for the node's values - e.g. when the node is edited, the updated values from the editor will be set on this property of the node.


Interface defined in packages/common/src/layouts/layout-shared-types.ts:381