Skip to content

@signkit/core Types


@signkit/core Types / FieldInspectorSlotProps

Interface: FieldInspectorSlotProps

Defined in: types.ts:113

Properties

draft

draft: Field

Defined in: types.ts:117

Mutable draft copy used by the inspector before save.


field

field: Field

Defined in: types.ts:115

The currently selected field from the template.


getValue

getValue: (path) => unknown

Defined in: types.ts:119

Reads a value from the draft field using a dot-path.

Parameters

path

string

Returns

unknown


remove

remove: () => void

Defined in: types.ts:125

Removes the selected field from the template.

Returns

void


save

save: () => void

Defined in: types.ts:123

Persists the current draft back to the template.

Returns

void


setValue

setValue: (path, value) => void

Defined in: types.ts:121

Writes a value to the draft field using a dot-path.

Parameters

path

string

value

unknown

Returns

void


updateField

updateField: (patch) => void

Defined in: types.ts:127

Emits an immediate field patch without going through the draft helpers.

Parameters

patch

Partial<Field> & object

Returns

void

Released under the Apache License 2.0.