Skip to content

Commit 78fe13f

Browse files
authored
Merge pull request #6833 from umbraco/workspaces
Updated article
2 parents 67415f2 + cf0afc8 commit 78fe13f

File tree

1 file changed

+24
-10
lines changed

1 file changed

+24
-10
lines changed

14/umbraco-cms/customizing/workspaces.md

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,35 @@
44
This page is a work in progress and may undergo further revisions, updates, or amendments. The information contained herein is subject to change without notice.
55
{% endhint %}
66

7-
A Workspace is the editor for a specific entity type. It can either be a view of data or a complex editor with multiple views.
7+
A Workspace is an editor interface designed for managing specific entity types, such as content, media, or members. Workspaces allow users to interact with and modify data in a structured way, whether through a single view or multiple interconnected views. Workspaces are where you interact with and manage specific content or settings.
88

9-
* A workspace is based on an entity type (for example content, media, member, etc.) and a unique string (ex: key).
10-
* Most workspaces hold a draft state of an entity. It is a copy of the entity data that can be modified at runtime and sent to the server to be saved.
11-
* A workspace can be a single view or consist of multiple views.
12-
* A workspace should host a workspace context, with which anything within can communicate.
9+
For example: If you want to edit a page or create new content, you would go into the "Content" workspace. This workspace will provide you with a tree view, a content editor, media browser, and other specific tools to help you manage content.
10+
11+
## Key Concepts
12+
13+
* **Entity Type:** Each workspace is based on an entity type (for example content, media, member, and so on).
14+
* **Unique Key:** Workspaces are identified by a unique string key.
15+
* **Draft State:** Most workspaces maintain a draft state, allowing changes to be made before saving to the server.
16+
* **Workspace Context:** This context enables communication between different components within the workspace.
17+
* **Workspace Views:** A workspace can consist of a single or multiple views.
18+
* **Workspace Actions:** Actions that can be performed within a workspace, such as saving or publishing.
1319

1420
<figure><img src="../.gitbook/assets/workspace.svg" alt=""><figcaption><p>Workspace</p></figcaption></figure>
1521

22+
## Setting Up a Custom Workspace
23+
24+
To configure a custom workspace, implement the `UmbWorkspaceElement` interface:
25+
1626
```ts
17-
interface UmbWorkspaceElement {}
27+
interface UmbWorkspaceElement {
28+
entityKey: string;
29+
entityType: string;
30+
views: WorkspaceView[];
31+
},
1832
```
1933

20-
## [Workspace Context](extending-overview/extension-types/workspace-context.md)
21-
22-
## [Workspace Views](extending-overview/extension-types/workspace-views.md)
34+
## Related Links
2335

24-
## [Workspace Actions](extending-overview/extension-types/workspace-editor-actions.md)
36+
* [Workspace Context](extending-overview/extension-types/workspace-context.md)
37+
* [Workspace Views](extending-overview/extension-types/workspace-views.md)
38+
* [Workspace Actions](extending-overview/extension-types/workspace-editor-actions.md)

0 commit comments

Comments
 (0)