Line

You are reading the unreleased docs (next). See latest (v0.9)

ui/client/features/page-builder/components/BlockField

Cockpit client (features), next. Source: ui/client/features/page-builder/components/BlockField.tsx.

Type Aliases#

BlockFieldProps#

BlockFieldProps = object

Defined in: ui/client/features/page-builder/components/BlockField.tsx:6

Properties#

children?

optional children?: ReactNode

Defined in: ui/client/features/page-builder/components/BlockField.tsx:12

The <option>s of a select.

kind?

optional kind?: "text" | "number" | "select"

Defined in: ui/client/features/page-builder/components/BlockField.tsx:10

label

label: string

Defined in: ui/client/features/page-builder/components/BlockField.tsx:9

prop

prop: string

Defined in: ui/client/features/page-builder/components/BlockField.tsx:8

The block prop this field edits.

Functions#

BlockField()#

BlockField(__namedParameters): Element

Defined in: ui/client/features/page-builder/components/BlockField.tsx:16

One labelled control of the selected block's settings, written straight back to the block's prop.

Parameters#

__namedParameters

BlockFieldProps

Returns#

Element


useBlockNode()#

useBlockNode(base): object

Defined in: ui/client/features/page-builder/components/BlockField.tsx:42

A block's drag handle (connect + drag in one ref) and its class, outlined while it is selected.

Parameters#

base

string

Returns#

object

className

className: string

ref

ref: (el) => void

Parameters
el

HTMLElement | null

Returns

void