From 4fbceaeb6ffa1b8f87a1878fa59a9b2fca6a8258 Mon Sep 17 00:00:00 2001 From: Julia Gru <56249914+julczka@users.noreply.github.com> Date: Tue, 18 Jul 2023 09:49:29 +0200 Subject: [PATCH] add a word of docs --- .../file-system-tree-item.context.ts | 8 +++++++- .../file-system-tree-item.element.ts | 9 ++++++++- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/tree/file-system-tree-item/file-system-tree-item.context.ts b/src/Umbraco.Web.UI.Client/src/packages/core/tree/file-system-tree-item/file-system-tree-item.context.ts index 362300982e..cc71d528d7 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/tree/file-system-tree-item/file-system-tree-item.context.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/tree/file-system-tree-item/file-system-tree-item.context.ts @@ -1,7 +1,13 @@ import { UmbTreeItemContextBase } from '../tree-item-base/tree-item-base.context.js'; import { UmbControllerHostElement } from '@umbraco-cms/backoffice/controller-api'; import { FileSystemTreeItemPresentationModel } from '@umbraco-cms/backoffice/backend-api'; - +/** + * Tree item context for file system tree items. Uses the path as the unique identifier. + * + * @export + * @class UmbFileSystemTreeItemContext + * @extends {UmbTreeItemContextBase} + */ export class UmbFileSystemTreeItemContext extends UmbTreeItemContextBase { constructor(host: UmbControllerHostElement) { super(host, (x: FileSystemTreeItemPresentationModel) => x.path); diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/tree/file-system-tree-item/file-system-tree-item.element.ts b/src/Umbraco.Web.UI.Client/src/packages/core/tree/file-system-tree-item/file-system-tree-item.element.ts index d4d75ea008..b6943a4a5c 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/tree/file-system-tree-item/file-system-tree-item.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/tree/file-system-tree-item/file-system-tree-item.element.ts @@ -21,7 +21,14 @@ const manifest: UmbBackofficeManifestKind = { }, }; umbExtensionsRegistry.register(manifest); - +/** + * Tree item element for file system tree items. Uses the path as the unique identifier. + * + * @export + * @class UmbFileSystemTreeItemElement + * @extends {UmbLitElement} + * @implements {UmbTreeItemExtensionElement} + */ @customElement('umb-file-system-tree-item') export class UmbFileSystemTreeItemElement extends UmbLitElement implements UmbTreeItemExtensionElement { private _item?: FileSystemTreeItemPresentationModel;