diff --git a/src/Umbraco.Web.UI.Client/storybook/stories/extending/dataset-context.mdx b/src/Umbraco.Web.UI.Client/storybook/stories/extending/dataset-context.mdx new file mode 100644 index 0000000000..f1ed340bdd --- /dev/null +++ b/src/Umbraco.Web.UI.Client/storybook/stories/extending/dataset-context.mdx @@ -0,0 +1,24 @@ +import { Meta } from '@storybook/addon-docs'; + + + +# Dataset Context + +The dataset context is a context which holds the data for a set of properties. +Property Editors UIs requires the dataset context to be present to work. This enables Property Editor UIs to have a generic relation with its ownership. + +The Dataset context holds a name and a set of properties. What makes a property can vary but we require a alias and a value. + +## Dataset in relation to Property Editors and Workspaces. + +A dataset context is the connection point between a Property Editor and a Workspace. + +The hirachy is as follows: +- Workspace Context + - Dataset Context + - Property Editor UIs + +A dataset covers a set of properties, in some cases a workspace then needs to have multiple datasets. An example of such is variants of the Document Workspace. Each variant have their own dataset. diff --git a/src/Umbraco.Web.UI.Client/storybook/stories/extending/workspaces/context.mdx b/src/Umbraco.Web.UI.Client/storybook/stories/extending/workspaces/context.mdx index 1ea5c76b9b..74cc0c9907 100644 --- a/src/Umbraco.Web.UI.Client/storybook/stories/extending/workspaces/context.mdx +++ b/src/Umbraco.Web.UI.Client/storybook/stories/extending/workspaces/context.mdx @@ -15,6 +15,8 @@ TODO: extend the description of a workspace - A workspace context knows about its entity type (e.g. content, media, member, etc.) and holds its unique string (ex: key). - Most workspaces contexts holds a draft state of its entities data. It is a copy of the entity data that can be modified at runtime and send to the server to be saved. +If a workspace wants to utilize Property Editor UIs, then it must provide a dataset context for the property editors. The dataset is the generic interface between workspace and property editors. See dataset contexts for more info. + TODO: More points and examples: ```ts