Home > @uniformdev/canvas > CanvasClient > getComponentDefinitions

CanvasClient.getComponentDefinitions() method

Fetches all Canvas component definitions

Signature:

Parameters

<table><thead><tr><th>

Parameter

</th><th>

Type

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

options

</td><td>

Omit<ComponentDefinitionGetParameters, 'projectId'>

</td><td>

(Optional)

</td></tr> </tbody></table> Returns:

Promise<{ componentDefinitions: { id: string; name: string; icon?: string | undefined; titleParameter?: string | null | undefined; thumbnailParameter?: string | null | undefined; canBeComposition?: boolean | undefined; parameters?: { id: string; name: string; helpText?: string | undefined; type: string; localizable?: boolean | undefined; typeConfig?: unknown; }[] | undefined; categoryId?: string | null | undefined; description?: string | undefined; previewImageUrl?: string | undefined; useTeamPermissions?: boolean | undefined; permissions?: { roleId: string; permission: "read" | "write" | "create" | "delete"; state: number; }[] | undefined; slots?: { id: string; name: string; allowedComponents: string[]; inheritAllowedComponents: boolean; allowAllComponents?: boolean | undefined; patternsInAllowedComponents?: boolean | undefined; minComponents?: number | undefined; maxComponents?: number | undefined; }[] | undefined; slugSettings?: { required?: "no" | "yes" | "disabled" | undefined; unique?: "no" | "local" | "global" | undefined; regularExpression?: string | undefined; regularExpressionMessage?: string | undefined; } | undefined; defaults?: { type: string; parameters?: { [key: string]: { value?: unknown; type: string; connectedData?: { pointer: string; syntax: "jptr"; failureAction?: "t" | "p" | "c" | "a" | undefined; failureLogLevel?: "e" | "w" | "i" | undefined; failureDefault?: string | undefined; } | undefined; locales?: { [key: string]: unknown; } | undefined; }; } | undefined; variant?: string | undefined; slots?: { [key: string]: any[]; } | undefined; _id?: string | undefined; _pattern?: string | undefined; _dataResources?: { [key: string]: { type: string; isPatternParameter?: boolean | undefined; ignorePatternParameterDefault?: boolean | undefined; variables?: { [key: string]: string; } | undefined; }; } | undefined; _patternDataResources?: { [key: string]: { type: string; isPatternParameter?: boolean | undefined; ignorePatternParameterDefault?: boolean | undefined; variables?: { [key: string]: string; } | undefined; }; } | undefined; _patternError?: "NOTFOUND" | "CYCLIC" | undefined; _overrides?: { [key: string]: { parameters?: { [key: string]: { value?: unknown; type: string; connectedData?: { pointer: string; syntax: "jptr"; failureAction?: "t" | "p" | "c" | "a" | undefined; failureLogLevel?: "e" | "w" | "i" | undefined; failureDefault?: string | undefined; } | undefined; locales?: { [key: string]: unknown; } | undefined; }; } | undefined; slots?: { [key: string]: any[]; } | undefined; variant?: string | undefined; }; } | undefined; _overridability?: { parameters?: { [key: string]: "no" | "yes"; } | undefined; variants?: boolean | undefined; hideLockedParameters?: boolean | undefined; } | undefined; _locales?: string[] | undefined; } | null | undefined; variants?: { id: string; name: string; }[] | undefined; created?: string | undefined; updated?: string | undefined; }[]; }>