Skip to content

Commit

Permalink
docs: add docs on meta-plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
soofstad committed Jun 13, 2024
1 parent 1e0597d commit 3ba750e
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 0 deletions.
14 changes: 14 additions & 0 deletions packages/dm-core-plugins/docs/MetaPlugin/Documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Plugin for displaying the `_meta_`-attribute of any entity. The entity it self will be displayed right under the meta-information.

![MetaPlugin](./meta.png)

## Usage

```json
{
"type": "CORE:UiRecipe",
"name": "Meta",
"plugin": "@development-framework/dm-core-plugins/meta"
}
```
The plugin can be used on any type of entity, and has no configuration.
28 changes: 28 additions & 0 deletions packages/dm-core-plugins/docs/MetaPlugin/Examples/Basic.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"title": "Example",
"description": "Minimal example of meta plugin",
"note": "",
"showDemo": true,
"blueprint": {
"type": "CORE:Blueprint",
"name": "Example",
"description": "",
"attributes": [
{
"type": "dmss://system/SIMOS/BlueprintAttribute",
"name": "type",
"attributeType": "string",
"optional": false
}
]
},
"entity": {
"type": "./Example",
"_id": "1179c897-df62-445f-87e4-f393b4253936"
},
"recipe": {
"type": "CORE:UiRecipe",
"name": "Meta",
"plugin": "@development-framework/dm-core-plugins/meta"
}
}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3ba750e

Please sign in to comment.