API Reference / @gtkx/config / @gtkx/config / ElementPropsExport

Type Alias: ElementPropsExport ​

ElementPropsExport = object

Defined in: packages/config/src/config.ts:139

The props type an elements.config entry adds to a generated element, and how it combines with them.

Properties ​

composition? ​

optional composition?: "factory" | "intersection"

Defined in: packages/config/src/config.ts:149

How the exported props are combined: intersection is inherited; factory applies only to this type.

Default Value ​

"intersection"

constructOnly? ​

optional constructOnly?: string[]

Defined in: packages/config/src/config.ts:155

Props that can only be set when the element is created; changing them afterward throws.

Default Value ​

[]

export ​

export: string

Defined in: packages/config/src/config.ts:143

Name of the props type to import from the module.

module ​

module: string

Defined in: packages/config/src/config.ts:141

Module specifier containing the named export; relative paths start at the project root.