diff --git a/src/Umbraco.Web.UI.Client/src/stories/extending/actions.stories.mdx b/src/Umbraco.Web.UI.Client/src/stories/extending/entity-actions.stories.mdx similarity index 87% rename from src/Umbraco.Web.UI.Client/src/stories/extending/actions.stories.mdx rename to src/Umbraco.Web.UI.Client/src/stories/extending/entity-actions.stories.mdx index 90474b912d..e05954a726 100644 --- a/src/Umbraco.Web.UI.Client/src/stories/extending/actions.stories.mdx +++ b/src/Umbraco.Web.UI.Client/src/stories/extending/entity-actions.stories.mdx @@ -1,8 +1,11 @@ import { Meta } from '@storybook/addon-docs'; - + -# Actions +# Entity Actions TODO: introduction to actions @@ -12,10 +15,7 @@ TODO: introduction to actions - **Entity Bulk Action:** Relates to an entity type: document, media, etc. Performs the action on a selection of items. -- **Workspace Action:** - Relates to a workspace alias (Umb.Workspace.Document). Performs the action on the workspace draft state. - -TODO: graphically show the different types of actions + ### Registering an Entity Action diff --git a/src/Umbraco.Web.UI.Client/src/stories/extending/registration.stories.mdx b/src/Umbraco.Web.UI.Client/src/stories/extending/registration.stories.mdx index 7b06b2f779..a62b1eb036 100644 --- a/src/Umbraco.Web.UI.Client/src/stories/extending/registration.stories.mdx +++ b/src/Umbraco.Web.UI.Client/src/stories/extending/registration.stories.mdx @@ -8,22 +8,8 @@ Registering UI extensions happens through the global extension registry. There are two ways to register UI extensions: -1. Directly through a manifest file -2. Referencing a "Start up" resource in the manifest where full control over registration can take place. - -## Manifest files - -```json -{ - "type": "", // type of extension - "alias": "", // unique alias for the extension - "elementName": "", // unique name of the custom element - "js": "", // path to the javascript resource - "meta": { - // additional props for the extension type - } -} -``` +1. Reference an entry point resource in the manifest where full control over registration can take place. +2. Directly through a manifest file ## Entry Point Files @@ -56,3 +42,17 @@ const manifest = { extensionRegistry.register(extension); ``` + +## Manifest JSON files + +```json +{ + "type": "", // type of extension + "alias": "", // unique alias for the extension + "elementName": "", // unique name of the custom element + "js": "", // path to the javascript resource + "meta": { + // additional props for the extension type + } +} +``` diff --git a/src/Umbraco.Web.UI.Client/src/stories/extending/sections.stories.mdx b/src/Umbraco.Web.UI.Client/src/stories/extending/sections.stories.mdx index bc61b2f7ce..9d75b0a2a9 100644 --- a/src/Umbraco.Web.UI.Client/src/stories/extending/sections.stories.mdx +++ b/src/Umbraco.Web.UI.Client/src/stories/extending/sections.stories.mdx @@ -3,3 +3,74 @@ import { Meta } from '@storybook/addon-docs'; # Sections + +TODO: Introduction to sections + + + +The section manifest: + +TODO: can we get a typescript interface here? + +```json +{ + "type": "section", + "alias": "My.Section", + "name": "My Section", + "weight": 10, + "meta": { + "label": "My Section", + "pathname": "my-section" + } +} +``` + +The Backoffice ships with the following sections: +Content, Media, Members, Packages, Users, Settings. + +## Section Sidebar + +TODO: Introduction to section sidebar + + + +### Sidebar Items + +TODO: Introduction to section sidebar items + + + +#### Manifest + +TODO: not implemented yet + +#### Sidebar Menu + +```json +{ + "type": "sidebarMenu", + "alias": "My.SidebarMenu.Something", + "name": "Something Sidebar Menu", + "weight": 10, + "meta": { + "label": "My Something Sidebar Menu", + "sections": ["My.Section"] + } +} +``` + +#### Sidebar Menu Item + +```json +{ + "type": "sidebarMenuItem", + "alias": "Umb.SidebarMenuItem.Documents", + "name": "Documents Sidebar Menu Item", + "weight": 10, + "meta": { + "label": "Documents", + "icon": "umb:folder", + "sidebarMenus": ["Umb.SidebarMenu.Content"], + }, +}; +``` diff --git a/src/Umbraco.Web.UI.Client/src/stories/extending/workspace-views.stories.mdx b/src/Umbraco.Web.UI.Client/src/stories/extending/workspace-views.stories.mdx deleted file mode 100644 index 2107d4df44..0000000000 --- a/src/Umbraco.Web.UI.Client/src/stories/extending/workspace-views.stories.mdx +++ /dev/null @@ -1,8 +0,0 @@ -import { Meta } from '@storybook/addon-docs'; - - - -# Workspace Views diff --git a/src/Umbraco.Web.UI.Client/src/stories/extending/workspaces.stories.mdx b/src/Umbraco.Web.UI.Client/src/stories/extending/workspaces.stories.mdx index 30a3c8ca01..376b51eb80 100644 --- a/src/Umbraco.Web.UI.Client/src/stories/extending/workspaces.stories.mdx +++ b/src/Umbraco.Web.UI.Client/src/stories/extending/workspaces.stories.mdx @@ -3,3 +3,9 @@ import { Meta } from '@storybook/addon-docs'; # Workspaces + +## Workspace Views + +## Workspace Actions + +Relates to a workspace alias (Umb.Workspace.Document). Performs the action on the workspace draft state.