Selection Object - Revision history

Benzac at 14:48, 20 July 2022

2022-07-20T14:48:21Z

Benzac at 09:04, 6 May 2021

2021-05-06T09:04:52Z

Benzac at 09:16, 30 April 2021

2021-04-30T09:16:34Z

Benzac at 10:13, 29 April 2021

2021-04-29T10:13:14Z

Benzac at 16:38, 12 March 2021

2021-03-12T16:38:20Z

Benzac at 14:32, 14 January 2021

2021-01-14T14:32:53Z

Benzac: Created page with "The selection object can be used to specify the behavior of a content item if it is selected (i.e. if it has the focus). { "important": fals..."

2021-01-14T14:31:49Z

Created page with "The selection object can be used to specify the behavior of a content item if it is selected (i.e. if it has the focus). <syntaxhighlight lang="json"> { "important": fals..."

New page

The selection object can be used to specify the behavior of a content item if it is selected (i.e. if it has the focus).

<syntaxhighlight lang="json">
{
"important": false,
"headline": "Selection Headline",
"background": "http://link.to.image",
"action": null,
"data": null
}
</syntaxhighlight>

{| class="wikitable sortable"
|+ Property syntax of start object
|-
! Property !! Type !! Default Value !! Mandatory !! Since Version !! class="unsortable" | Description
|-
| <code>important</code> || <code>boolean</code> || <code>false</code> || No || data-sort-value=110|'''0.1.110''' ||
Indicates if the selection is important. This property only has an effect if the application is controlled with mouse or touch. If this property is set to <code>true</code>, the corresponding content item action will only be executed if the item has the focus.
|-
| <code>headline</code> || <code>string</code> || <code>null</code> || No || data-sort-value=111|'''0.1.111''' ||
The headline of the content that is used if the corresponding content item has the focus. This headline is attached as sub-headline to the content headline. If the content does not have a headline, this headline is used for that.
|-
| <code>background</code> || <code>string</code> || <code>null</code> || No || data-sort-value=110|'''0.1.110''' ||
The background image that is used if the corresponding content item has the focus. This property has no effect if the content is displayed in a panel.
|-
| <code>action</code> || <code>string</code> || <code>null</code> || No || data-sort-value=110|'''0.1.110''' ||
The selection action that is executed if the corresponding content item becomes the focus.
|-
| <code>data</code> || <code>object</code> || <code>null</code> || No || data-sort-value=110|'''0.1.110''' ||
The additional data of the selection action that is used if the action is executed.
|}

== See also ==
* [[Selection Examples]]

@@ Line 19: / Line 19: @@
 Indicates if the selection is important. This property only has an effect if the application is controlled with mouse or touch. If this property is set to <code>true</code>, the corresponding content item action will only be executed if the item has the focus.
-'''Note: Since version 0.1.135, the item also has the focus when the cursor is over it and the hover effect is set to preselect (Settings → Hover Effect → Preselect).'''
+'''Note: Since version 0.1.136, the item also has the focus when the cursor is over it and the hover effect is set to preselect (Settings → Hover Effect → Preselect).'''
 |-
 | <code>headline</code> || <code>string</code> || <code>null</code> || No || data-sort-value=111|'''0.1.111''' ||

@@ Line 19: / Line 19: @@
 Indicates if the selection is important. This property only has an effect if the application is controlled with mouse or touch. If this property is set to <code>true</code>, the corresponding content item action will only be executed if the item has the focus.
-'''Note: Since version 0.1.135, this property has no effect for pointer devices if the type of the hover effect is set to preselect (Settings → Hover Effect → Preselect).'''
+'''Note: Since version 0.1.135, the item also has the focus when the cursor is over it and the hover effect is set to preselect (Settings → Hover Effect → Preselect).'''
 |-
 | <code>headline</code> || <code>string</code> || <code>null</code> || No || data-sort-value=111|'''0.1.111''' ||

@@ Line 29: / Line 29: @@
 | <code>action</code> || <code>string</code> || <code>null</code> || No || data-sort-value=110|'''0.1.110''' ||
 The selection action that is executed if the corresponding content item becomes the focus.
-Please see [[Actions]] for possible values.
+Please see [[Internal Actions]] for possible values.
 |-
 | <code>data</code> || <code>object</code> || <code>null</code> || No || data-sort-value=110|'''0.1.110''' ||
 The additional data of the selection action that is used if the action is executed.
-Please see [[Actions]] for possible values.
+Please see [[Internal Actions]] for possible values.
 |}
 == See also ==
 * [[Selection Examples]]

@@ Line 12: / Line 12: @@
 {| class="wikitable sortable"
-|+ Property syntax of start object
+|+ Property syntax of selection object
 |-
 ! Property !! Type !! Default Value !! Mandatory !! Since Version !! class="unsortable" | Description