Files
Umbraco-CMS/src/Umbraco.Web.UI.Client/libs/extensions-registry/entity-action.models.ts
Jacob Overgaard 501958e2df updated examples
2023-04-12 14:19:41 +02:00

52 lines
966 B
TypeScript

import type { ManifestElement } from './models';
/**
* An action to perform on an entity
* For example for content you may wish to create a new document etc
*/
export interface ManifestEntityAction extends ManifestElement {
type: 'entityAction';
meta: MetaEntityAction;
conditions: ConditionsEntityAction;
}
export interface MetaEntityAction {
/**
* An icon to represent the action to be performed
*
* @examples [
* "umb:box",
* "umb:grid"
* ]
*/
icon?: string;
/**
* The friendly name of the action to perform
*
* @examples [
* "Create",
* "Create Content Template"
* ]
*/
label: string;
/**
* @TJS-ignore
*/
api: any; // create interface
/**
* The alias for the repsoitory of the entity type this action is for
* such as 'Umb.Repository.Documents'
* @examples [
* "Umb.Repository.Documents"
* ]
*/
repositoryAlias: string;
}
export interface ConditionsEntityAction {
entityType: string;
}