type

RowLabelProps

The current row values and position passed to a custom array or block heading.

Component props

PropertyTypeDescription
fieldSchemaFieldThe containing array or block field’s schema, including its name, path, and display settings.
rowRowLabelSnapshotA read-only copy of the current row’s values, including unsaved edits. Ridu supplies a new snapshot when the row changes.
rowNumbernumberThe displayed row position, starting at one. Updates when the row moves.
i18nAdminI18nTranslate labels and format values using the admin’s language and preferences.
configConfigPresent only when defineRowLabel supplies decodeConfig. Contains the checked settings returned by the decoder.

How it works

row contains unsaved values and is read-only. rowNumber starts at one and changes when the row is moved.

Read these props with $props() and derive the heading with Svelte $derived so it updates while the user edits the row.

config is available only when defineRowLabel has a decodeConfig function. Use a field component for editing controls.

Full signature

type RowLabelProps<Config = undefined> = Omit<RowLabelComponentProps, "config"> & ([Config] extends [undefined] ? { config?: never } : { config: Config })

Source packages/plugin/src/admin.ts:171

Related guides