UIDataType
An uxiverse.com typeThe root class for all UI DataTypes. E.g. on/off -> true/false in the case of BooleanType. Formally extends https://schema.org/DataType, but support can't be 100% guaranteed.
| Property | Expected Type | Description |
|---|---|---|
| ContextProperty | Element | A property that holds the context a UI element is in |
| DescriptionFlag | Element | Flags to express that a UI element describes something, e.g. isHelp, isContent, isProgress |
| HierarchyFlag | https://schema.org/Boolean | Flags that express a hierarchical position on an element |
| NavigationProperty | Element | A property that holds the navigation on a UI element, e.g. menu, settings |
| OutcomeProperty | A property that holds a result, output or status | |
| a11y | Element | Properties related to accessibility |
| input | Input is the value/parameter/prop that gets passed to an element in the UX, and can be empty. This applies to visual as well as non-visual elements. | |
| isInUseBy | When people collaboratively work, the property isInUseBy can be used to make an element non-editable until it is set free. Showing where other users are can also prevent conflicting edits. | |
| isUsableBy | To handle which User, Role or Group can use an Element of the UI, the property isUsableBy can be used to grey out parts of the interface, or hide them entirely. |
Instances of "UIDataType" may appear as a value for the following properties
| Property | On Type | Description |
|---|---|---|
| OutcomeProperty | Element | A property that holds a result, output or status |
| input | Element | Input is the value/parameter/prop that gets passed to an element in the UX, and can be empty. This applies to visual as well as non-visual elements. |
| inputRange | The input range defines the type(s) of data which a uxi:UIElement can consume. This can be used to choose UIElements automatically. E.g. in the case of a date picker this could be https://schema.org/Date or https://schema.org/DateTime. For the (sub-)uxi:UIElement for selecting a year inside that date picker, a uxi:UIPropertyValueSpecification could be used to narrow down the selection. Also useful for converting, sending or receiving data. | |
| result | A result is an outcome property that's immediately evaluated. It can be used to tell the user what consequences their actions will have. E.g. the result in a currency calculator app, completed user profile data as a result of editing, or a fulfilled workflow after performing a sequence of tasks (before submitting). Technically, results should be treated as immediate/synchronous outcomes, compare with uxi:output for side-effects/asynchronous handling. |