Model builder plugin for oarepo-ui
Project description
UI model builder plugin
An OARepo Model Builder plugin to generate user interface layout from model specification.
Installation
pip install oarepo-model-builder-ui
Usage
The plugin adds support for UI annotation of the model file:
title:
type: keyword
label.key: title.label
label.cs: Název
label.en: Title
help.key: title.help
hint.key: title.hint
ui:
detail: <detail component name>
edit: <edit component name>
// any other property here - not validated
The following files are generated:
<package>
+- model
+- ui.json
+- templates
+- <langcode>
+- LC_MESSAGES
+- messages.po
+- messages.mo
i18n
The po
and mo
files are standard gettext po files. The translation keys
are taken from the *.key
properties. If keys are not specified, they are
generated from the property path (for example, metadata.creator.firstName.label ).
UI layout
The UI layout is generated as a convenience for other tools, for example for oarepo-cli
.
It contains simplified layout of the model. Example:
{
"children": {
"title": {
"detail": "fulltext",
"input": "fulltext",
"help": "title.help",
"label": "title.label",
"hint": "title.hint"
},
"providers": {
"detail": "array",
"input": "array",
"help": "providers.help",
"label": "providers.label",
"hint": "providers.hint",
"child": {
"detail": "provider",
"input": "provider",
"children": {
"name": {
"detail": "keyword",
"input": "keyword",
"help": "providers/name.help",
"label": "providers/name.label",
"hint": "providers/name.hint"
}
}
}
}
}
}
Fields:
- detail: component used for rendering the detail page
- input: component used for rendering input
- help/label/hint: keys to gettext message catalogues
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for oarepo-model-builder-ui-4.0.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 771eca3fd7db5419f1ed56b9755f0b45611b85b1788de91550dcf118f27ac250 |
|
MD5 | 3c9524573b2accf6f77276a1bc2901f6 |
|
BLAKE2b-256 | 769fa5b7bd4981e5e532d039a15ef3e6aedc6b5bdc019efe99bb40bab42ff79f |
Close
Hashes for oarepo_model_builder_ui-4.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1254d3f34487b86c429dfb3d63a0c53c75c901ff92a29e6a5586200c898101ec |
|
MD5 | afa337bac2bf12b68be29bad4fb6dd30 |
|
BLAKE2b-256 | 974158452a9b510233b31e1c14e4239b47c7e65b72cfe15127a868c0b4bf9642 |