Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Hidden icon options for Models and Flows #295

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions content/docs/models/contents.lr
Original file line number Diff line number Diff line change
Expand Up @@ -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
- `description`: an optional string that provides some description for the
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
rendered as an input field. This string is shown as an UI label on the
right side of the input field to give it more context. For instance, it can
be used to clarify units of a field (pixel, percent etc.).
- `addon_label`: an optional string or icon that is supported by all types
that are rendered as an input field. This string or icon is shown as an UI
label on the right side of the input field to give it more context. For
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 :ext](https://fontawesome.com/v4.7.0/icons/)
icon name between double brackets (e.g.: [[github]]).
- `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.
- `size` can be set to `normal`, `small` or `large` to affect the size a
Expand Down
3 changes: 2 additions & 1 deletion content/docs/models/flow/contents.lr
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ default = default
This should be self explanatory. One thing that is different about blocks
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
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

Expand Down