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-2.0.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0c37b850d21f9b25936c2e523773bf10dcea85fd614405411091b906734cdb8f |
|
MD5 | 7e3f09357705e26d122c236d3754f4a8 |
|
BLAKE2b-256 | 5d69a9bc17e83d3583ca7222c0c5e2d4d1bdae43af24ffa8154a0f83678905a0 |
Close
Hashes for oarepo_model_builder_ui-2.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3a8dfdb516109af8ce33d648e7a69ca46efb71512ecdd9c8fec06dca5c95c14b |
|
MD5 | 5571674a12650578ffc0105e93d94995 |
|
BLAKE2b-256 | 8a1dda2780f5d82403dac8f794df625e8d5f452d4e2e26326480432a9d72ea28 |