GTKX

API Reference / @gtkx/codegen / ApiReferenceOptions

Type Alias: ApiReferenceOptions ​

ApiReferenceOptions = object

Defined in: packages/codegen/src/docs/api-reference.ts:29

What to index and the element config the rendered pages reflect.

Properties ​

acceptedChildTypes? ​

optional acceptedChildTypes?: Record<string, string[]>

Defined in: packages/codegen/src/docs/api-reference.ts:39

girPath ​

girPath: string[]

Defined in: packages/codegen/src/docs/api-reference.ts:34

Directories to search for .gir files.

libraries ​

libraries: string[]

Defined in: packages/codegen/src/docs/api-reference.ts:32

GIR library identifiers to load, such as "Adw-1"; their dependencies are pulled in too.

omittedProps? ​

optional omittedProps?: OmittedProps

Defined in: packages/codegen/src/docs/api-reference.ts:38

GObject properties the project omits from generated props; without it pages show props that do not exist.

props? ​

optional props?: ElementProps

Defined in: packages/codegen/src/docs/api-reference.ts:36

Base props interfaces per element, as read by readBuiltinElements; without it pages miss them.

resolveFrom? ​

optional resolveFrom?: string

Defined in: packages/codegen/src/docs/api-reference.ts:30