yv01p/Umbraco-CMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

JSDocs

Browse Source
This commit is contained in:
Niels Lyngsø
2023-11-17 08:51:38 +01:00
parent 108416fb2b
commit 9b5594b28b
2 changed files with 33 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
src/Umbraco.Web.UI.Client/src/libs/extension-api/types/base.types.ts
View File

@@ -1,9 +1,12 @@
import type { UmbApi } from "../models/index.js";
import type { ManifestBase } from "./manifest-base.interface.js";
import type { ApiLoaderProperty, CssLoaderProperty, ElementAndApiLoaderProperty, ElementLoaderProperty, JsLoaderProperty } from "./utils.js";
import type { UmbApi } from '../models/index.js';
import type { ManifestBase } from './manifest-base.interface.js';
import type {
ApiLoaderProperty,
CssLoaderProperty,
ElementAndApiLoaderProperty,
ElementLoaderProperty,
JsLoaderProperty,
} from './utils.js';
export interface ManifestWithView<ElementType extends HTMLElement = HTMLElement> extends ManifestElement<ElementType> {
meta: MetaManifestWithView;
@@ -23,22 +26,18 @@ export interface ManifestElementWithElementName extends ManifestElement {
elementName: string;
}
export interface ManifestPlainCss<CssType = unknown> extends ManifestBase {
/**
* The file location of the stylesheet file to load
* @TJS-type string
* @TJS-type string
*/
css?: CssLoaderProperty<CssType>
css?: CssLoaderProperty<CssType>;
}
export interface ManifestPlainJs<JsType> extends ManifestBase {
/**
* The file location of the javascript file to load
* @TJS-type string
* @TJS-type string
*/
js?: JsLoaderProperty<JsType>;
}
@@ -54,18 +53,16 @@ export interface ManifestApi<ApiType extends UmbApi = UmbApi> extends ManifestBa
/**
* The file location of the javascript file to load
* @TJS-type string
* @TJS-type string
*/
js?: ApiLoaderProperty<ApiType>;
/**
* @TJS-ignore
* @TJS-type string
*/
api?: ApiLoaderProperty<ApiType>;
}
export interface ManifestElement<ElementType extends HTMLElement = HTMLElement> extends ManifestBase {
/**
* @TJS-ignore
@@ -74,13 +71,13 @@ export interface ManifestElement<ElementType extends HTMLElement = HTMLElement>
/**
* The file location of the javascript file to load
* @TJS-type string
* @TJS-type string
*/
js?: ElementLoaderProperty<ElementType>;
/**
* The file location of the element javascript file to load
* @TJS-type string
* @TJS-type string
*/
element?: ElementLoaderProperty<ElementType>;
@@ -96,7 +93,8 @@ export interface ManifestElement<ElementType extends HTMLElement = HTMLElement>
meta?: unknown;
}
export interface ManifestElementAndApi<ElementType extends HTMLElement = HTMLElement, ApiType extends UmbApi = UmbApi> extends ManifestBase {
export interface ManifestElementAndApi<ElementType extends HTMLElement = HTMLElement, ApiType extends UmbApi = UmbApi>
extends ManifestBase {
/**
* @TJS-ignore
*/
@@ -106,23 +104,21 @@ export interface ManifestElementAndApi<ElementType extends HTMLElement = HTMLEle
*/
readonly ELEMENT_TYPE?: ElementType;
/**
* The file location of the javascript file to load
* @TJS-type string
* @TJS-type string
*/
js?: ElementAndApiLoaderProperty<ElementType, ApiType>;
/**
* The file location of the api javascript file to load
* @TJS-type string
* @TJS-type string
*/
api?: ApiLoaderProperty<ApiType>;
/**
* The file location of the element javascript file to load
* @TJS-type string
* @TJS-type string
*/
element?: ElementLoaderProperty<ElementType>;
@@ -131,4 +127,4 @@ export interface ManifestElementAndApi<ElementType extends HTMLElement = HTMLEle
* Note it is NOT <my-dashboard></my-dashboard>, just the element name.
*/
elementName?: string;
}
}

13
src/Umbraco.Web.UI.Client/src/libs/extension-api/types/manifest-kind.interface.ts
View File

@@ -1,8 +1,17 @@
export interface ManifestKind<ManifestTypes> {
type: 'kind';
alias: string;
matchType: string;
matchKind: string;
/**
* Provide pre defined properties for the extension manifest.
* Define the `type`-property and other properties you like to preset for implementations of this kind.
*
* @examples {
* type: 'section',
* weight: 123,
* },
* @TJS-type object
*/
manifest: Partial<ManifestTypes>;
}
}