API Reference / @gtkx/config / @gtkx/config / ElementConfigOptions

Type Alias: ElementConfigOptions ​

ElementConfigOptions = object

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

Overrides for one GLib type in elements.config, keyed by its registered type name.

Properties ​

acceptedChildTypes? ​

optional acceptedChildTypes?: string[]

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

Accepted child GLib type names to show in the generated element documentation.

Default Value ​

[]

component? ​

optional component?: ModuleExport

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

Component export that wraps the generated element.

Default Value ​

None: no wrapper component

isLazy? ​

optional isLazy?: boolean

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

Whether the parent container creates this element's GObject instead of the element constructing its own. Subtypes inherit the setting.

Default Value ​

false

omittedProps? ​

optional omittedProps?: string[]

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

GObject properties to leave out of generated props, such as properties managed by an element behavior.

Default Value ​

[]: every GObject property becomes a prop

props? ​

optional props?: ElementPropsExport

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

Additional props type to combine with the generated element props.

Default Value ​

None: no extra props type