Home > @uniformdev/canvas-vue > useUniformContextualEditing

useUniformContextualEditing() function

Adds contextual editing capability to a Uniform app. This hook is already integrated in <UniformComposition />, you won't need to use it directly, unless you have a custom setup.

Signature:

Parameters

Returns:

{ composition: vue_demi.ComputedRef<{ type: string; parameters?: { [key: string]: { value?: unknown; type: string; connectedData?: { pointer: string; syntax: "jptr"; failureAction?: "p" | "a" | "t" | "c" | undefined; failureLogLevel?: "i" | "e" | "w" | undefined; failureDefault?: string | undefined; } | undefined; locales?: { [key: string]: unknown; } | undefined; }; } | undefined; variant?: string | undefined; projectMapNodes?: { id: string; path: string; projectMapId: string; data?: { isSearchHit?: boolean | undefined; queryStrings?: { name: string; value?: string | undefined; helpText?: string | undefined; }[] | undefined; previewValue?: string | undefined; } | undefined; locales?: { [key: string]: { path: string; inherited: boolean; }; } | undefined; }[] | undefined; slots?: { [key: string]: { type: string; parameters?: { [key: string]: { value?: unknown; type: string; connectedData?: { pointer: string; syntax: "jptr"; failureAction?: "p" | "a" | "t" | "c" | undefined; failureLogLevel?: "i" | "e" | "w" | 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; optionalPatternParameter?: boolean | undefined; variables?: { [key: string]: string; } | undefined; }; } | undefined; _patternDataResources?: { [key: string]: { type: string; isPatternParameter?: boolean | undefined; ignorePatternParameterDefault?: boolean | undefined; optionalPatternParameter?: 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?: "p" | "a" | "t" | "c" | undefined; failureLogLevel?: "i" | "e" | "w" | undefined; failureDefault?: string | undefined; } | undefined; locales?: { [key: string]: unknown; } | undefined; }; } | undefined; slots?: { [key: string]: any[]; } | undefined; variant?: string | undefined; }; } | undefined; _overridability?: { parameters?: { [key: string]: "yes" | "no"; } | undefined; variants?: boolean | undefined; hideLockedParameters?: boolean | undefined; } | undefined; _locales?: string[] | undefined; }[]; } | undefined; _id: string; _slug?: string | null | undefined; _name: string; _author?: string | undefined; _authorSubject?: string | undefined; _creator?: string | undefined; _creatorSubject?: string | undefined; _pattern?: string | undefined; _patternDataResources?: { [key: string]: { type: string; isPatternParameter?: boolean | undefined; ignorePatternParameterDefault?: boolean | undefined; optionalPatternParameter?: boolean | undefined; variables?: { [key: string]: string; } | undefined; }; } | undefined; _dataResources?: { [key: string]: { type: string; isPatternParameter?: boolean | undefined; ignorePatternParameterDefault?: boolean | undefined; optionalPatternParameter?: 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?: "p" | "a" | "t" | "c" | undefined; failureLogLevel?: "i" | "e" | "w" | undefined; failureDefault?: string | undefined; } | undefined; locales?: { [key: string]: unknown; } | undefined; }; } | undefined; slots?: { [key: string]: any[]; } | undefined; variant?: string | undefined; }; } | undefined; _overridability?: { parameters?: { [key: string]: "yes" | "no"; } | undefined; variants?: boolean | undefined; hideLockedParameters?: boolean | undefined; } | undefined; _locales?: string[] | undefined; } | undefined>; isContextualEditing: vue_demi.ComputedRef<boolean>; }