ui/client/features/page-builder/domain/TsxExport
Craft.js layout -> one TSX file.
Cockpit client (features), next. Source: ui/client/features/page-builder/domain/TsxExport.ts.
Type Aliases#
SerializedNode#
SerializedNode =
object
Defined in: ui/client/features/page-builder/domain/TsxExport.ts:6
One node of Craft's query.serialize() output (parsed), only the fields the export reads.
Properties#
hidden?
optionalhidden?:boolean
Defined in: ui/client/features/page-builder/domain/TsxExport.ts:10
isCanvas?
optionalisCanvas?:boolean
Defined in: ui/client/features/page-builder/domain/TsxExport.ts:11
nodes?
optionalnodes?:string[]
Defined in: ui/client/features/page-builder/domain/TsxExport.ts:9
parent?
optionalparent?:string|null
Defined in: ui/client/features/page-builder/domain/TsxExport.ts:12
props?
optionalprops?:Record<string,unknown>
Defined in: ui/client/features/page-builder/domain/TsxExport.ts:8
type
type:
string| {resolvedName:string; }
Defined in: ui/client/features/page-builder/domain/TsxExport.ts:7
SerializedNodes#
SerializedNodes =
Record<string,SerializedNode>
Defined in: ui/client/features/page-builder/domain/TsxExport.ts:15
Functions#
componentName()#
componentName(
name):string
Defined in: ui/client/features/page-builder/domain/TsxExport.ts:24
A component name from free text: my page -> MyPage; a leading digit or nothing usable falls back to Page.
Parameters#
name
string
Returns#
string
handlerName()#
handlerName(
label):string
Defined in: ui/client/features/page-builder/domain/TsxExport.ts:30
A handler prop from a button label: Add category -> onAddCategory; an empty label -> onButton.
Parameters#
label
string
Returns#
string
serializeToTsx()#
serializeToTsx(
nodes,__namedParameters):string
Defined in: ui/client/features/page-builder/domain/TsxExport.ts:101
The layout as one TSX module: type <Name>Props (one () => void per button) above
export default function <Name>({ ...handlers }: <Name>Props) { return (...); }. One element per node, children in
order, hidden nodes left out; a node type it does not know becomes a fragment of its children.
Parameters#
nodes
__namedParameters
name
string
Returns#
string