Add icon option to Models and Flows

This commit is contained in:
Florian Merges 2020-02-18 19:29:35 +00:00
parent 066b23400e
commit dc67b658a6
2 changed files with 8 additions and 5 deletions

View File

@ -61,10 +61,12 @@ The following options are used for all types:
- `label`: the label for the field. This is shown in the UI in larger letters - `label`: the label for the field. This is shown in the UI in larger letters
- `description`: an optional string that provides some description for the - `description`: an optional string that provides some description for the
field that is shown in the UI to give a bit more explanation. field that is shown in the UI to give a bit more explanation.
- `addon_label`: an optional string that is supported by all types that are - `addon_label`: an optional string or icon that is supported by all types
rendered as an input field. This string is shown as an UI label on the that are rendered as an input field. This string or icon is shown as an UI
right side of the input field to give it more context. For instance, it can label on the right side of the input field to give it more context. For
be used to clarify units of a field (pixel, percent etc.). instance, it can be used to clarify units of a field (pixel, percent etc.).
If an icon is to be used it must be a valid Fontawesome 4 icon name and
between double brackets (e.g.: [[github]]).
- `width`: defines the width of the input in the admin as a fraction. For - `width`: defines the width of the input in the admin as a fraction. For
instance `1/4` sets it to a quarter of the width, `1/2` to a half etc. instance `1/4` sets it to a quarter of the width, `1/2` to a half etc.
- `size` can be set to `normal`, `small` or `large` to affect the size a - `size` can be set to `normal`, `small` or `large` to affect the size a

View File

@ -38,7 +38,8 @@ default = default
This should be self explanatory. One thing that is different about blocks This should be self explanatory. One thing that is different about blocks
compared to regular models is that they support the `button_label` attribute compared to regular models is that they support the `button_label` attribute
which can be used to customize the label of the button that adds blocks to which can be used to customize the label of the button that adds blocks to
a flow. a flow. Similar to the `addon_label` attribute of the [Regular Models
:ref](../), you can use an icon as a label instead.
## Templates ## Templates