For Dashboard Designers Reference Visual Components
Wednesday, May 17, 2023 12:20 PMVisual Components
Visual Components are small elements that can be used in HtmlViews and MarkdownViews. They are defined by a simple, custom element syntax and can be inserted into the html or markdown. Below are listed the available visual components and how to use them in an HtmlView or MarkdownView.
Components
API Component
Calls an IA_API
Function and places its response at the position of the component.
Properties
-
ia-name
: theiaName
of theIA_API
Function to execute. -
input-*
: input values for theIA_API
Function.
Usage
HTML
<ia-api ia-name="myAPI" input-myValue="myInputValue"></ia-api>
Markdown
[ia-api]{"ia-name": "myAPI", "input-myValue":"myInputValue"}
Rich-Text Editor Component
Provides a WYSIWYG textarea input to be used in forms.
Properties
-
name
: the input name (similar to<input>
or<textarea>
elements)
Usage
HTML
<ia-text-editor name="myFieldName"></ia-text-editor>
Markdown
[ia-text-editor]{"name":"myFieldName"}
Note that the text editor cannot be displayed in WYSIWYG mode inside an editor.
Markdown Editor Component
Provides a WYSIWYG textarea input with markdown mode to be used in forms.
Properties
-
name
: the input name (similar to<input>
or<textarea>
elements)
Usage
HTML
<ia-markdown-editor name="myMarkdownEditor"></ia-markdown-editor>
Markdown
[ia-markdown-editor]{"name":"myFieldName"}
Note that the markdown editor cannot be displayed in WYSIWYG mode inside an editor.