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.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 70ae73f80e5b31016df86e89eb8da7df16c124e6aa40a124a29bc2a36a30e050 |
|
MD5 | 87fcb428b7a3c1353f8aa4b9e9552370 |
|
BLAKE2b-256 | 1dcb88b0e68e1429fc76a092ada6973754e642dfe5217ea2c2e100ac558b2fcc |
Close
Hashes for oarepo_model_builder_ui-4.0.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ad8b7f26ed348946e7389536b8edaed3ac63d5a7c55c6c1540ef73d96276958c |
|
MD5 | f42741b67e95a2348da6cc5a7ea5f4bc |
|
BLAKE2b-256 | 12a19458c767a344c37acf0fe39e07c2201d5ad3022090fe215207ecce385b4c |