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

more docs

Browse Source
This commit is contained in:
Niels Lyngsø
2023-08-03 10:54:47 +02:00
parent 1a87de6bae
commit c53915ce3f
1 changed files with 26 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
src/Umbraco.Web.UI.Client/storybook/stories/extending/registration/conditions.mdx
View File

@@ -7,24 +7,44 @@ import { Meta } from '@storybook/addon-docs';
## UI Extension Conditions
Many of the Extension Types can be configured with conditions. These conditions are used to determine if the extension should be used or not.
Extension conditions are used to determine if an extension should be used or not.
Many of the Extension Types supports conditions, but not all of them.
The conditions are defined as an array of conditions. When all of the conditions are good an extension can be used.
All given conditions for an extension must be valid for an extension to be utilized.
### Using conditions
Describe the following example:
In this following example we define the manifest for a Workspace Action, this action will only be available in the workspace with the alias `My.Example.Workspace`.
```typescript
... insert example here.
{
type: 'workspaceAction',
name: 'example-workspace-action',
alias: 'My.Example.WorkspaceAction',
elementName: 'my-workspace-action-element',
conditions: [
{
alias: 'Umb.Condition.SectionAlias',
matches: 'My.Example.Workspace'
}
]
}
```
The conditions are defined as an array of conditions.
Each condition is an object with the following properties:
- `alias`- The alias of the condition to utilize.
The rest of the properties of the object are specific to the condition.
- `...` - The rest of the properties of the object are specific to the condition.
In the above example the `Umb.Condition.SectionAlias` condition is used, this condition takes a property `matches` which must be set to the alias of the section to match.
### Core conditions types
List the build in ones, and link to the docs for them.
The following conditions are available out of the box, for all extension types that support conditions.
- `Umb.Condition.SectionAlias` - Checks if the current section alias matches the one specified.
- `Umb.Condition.WorkspaceAlias` - Checks if the current workspace alias matches the one specified.
### Make your own conditions