Skip to content

Commit d81a34f

Browse files
committed
Update text box
1 parent 3a777b5 commit d81a34f

3 files changed

Lines changed: 117 additions & 103 deletions

File tree

content/en/docs/refguide/modeling/pages/input-widgets/text-box.md

Lines changed: 116 additions & 102 deletions
Original file line numberDiff line numberDiff line change
@@ -23,184 +23,198 @@ For example, the following text box allows the end-user to see, and set, the **N
2323

2424
{{< figure src="/attachments/refguide/modeling/pages/input-widgets/text-box/text-box.png" >}}
2525

26-
## 2 Properties
26+
## 2 Properties Pane
2727

28-
An example of text box properties is represented in the image below:
28+
The properties pane is divided into two major sections by a toggle at the top of the pane: **Properties** and **Styling**. Text box properties consist of the following sections:
2929

30-
{{< figure src="/attachments/refguide/modeling/pages/input-widgets/text-box/text-box-properties.png" width="250" >}}
31-
32-
Text box properties consist of the following sections:
33-
34-
* [Accessibility](#accessibility)
35-
* [Common](#common)
30+
Properties:
31+
* [General](#general)
3632
* [Data source](#data-source)
37-
* [Design Properties](#design-properties)
33+
* [Label](#label)
3834
* [Editability](#editability)
35+
* [Visibility](#visibility)
36+
* [Validation](#validation)
37+
* [Accessibility](#accessibility)
38+
* [Common](#common)
3939
* [Events](#events)
40+
* [On change Behavior](#on-change)
41+
42+
Styling:
43+
44+
* [Design Properties](#design-properties)
45+
* [Common](#common-styling)
46+
47+
Miscellaneous:
4048
* [Formatting](#formatting)
41-
* [General](#general)
42-
* [Label](#label)
43-
* [Validation](#validation)
44-
* [Visibility](#visibility)
4549

46-
### 2.1 Accessibility Section{#accessibility}
50+
## 3 Properties
4751

48-
### 2.1.1 Aria Required
52+
### 3.1 General Section{#general}
4953

50-
In a textbox widget, when **Aria required** is set to **Yes** then assistive technologies will read out the field that is required. When set to **No** then assistive technologies will not read the field out.
54+
#### 3.1.1 Show as Password
5155

52-
#### 2.1.2 Autocomplete
56+
Attributes of the data type `String` or `Hashed string` can have their value hidden. This can be used for passwords, for example, to prevent bystanders from seeing them.
5357

54-
The autocomplete property specifies if a text box should have autocomplete enabled. The autocomplete attribute also improves the browser's ability to pre-populate fields with user-preferred values. For more information on how this helps you comply with accessibility guidelines, see the [Web Content Accessibility Guidelines (WCAG) 2.1](https://www.w3.org/TR/WCAG21/#input-purposes)
58+
| Value | Description |
59+
| --- | --- |
60+
| False *(default)*| Normal text box |
61+
| True | Typed characters are not shown to the end-user , instead an asterisk is shown for every typed character |
5562

56-
### 2.2 Common Section{#common}
63+
#### 3.1.2 Input Mask
5764

58-
{{% snippet file="/static/_includes/refguide/common-section-link.md" %}}
65+
{{% alert color="info" %}}Input masks are not supported on native mobile pages.
66+
Input masks are designed for string data types. Be cautious when using them with numeric or hashed string data types.
67+
{{% /alert %}}
5968

60-
### 2.3 Data Source Section{#data-source}
69+
The input mask limits what the end-user can enter in the text box, following the rules below:
6170

62-
{{% snippet file="/static/_includes/refguide/data-source-section-link.md" %}}
71+
| Character | Allows Input of |
72+
| ----- | ----- |
73+
| `9` | any digit |
74+
| `Z` | any letter |
75+
| `U` | an upper-case letter |
76+
| `L` | a lower-case letter |
77+
| `*` | a letter *or* a digit |
6378

64-
### 2.4 Design Properties Section{#design-properties}
79+
Other characters will be taken literally.
6580

66-
{{% snippet file="/static/_includes/refguide/design-section-link.md" %}}
81+
For example, the input mask `99-LLL-9999` matches `24-apr-2008`.
6782

68-
### 2.5 Editability Section{#editability}
83+
#### 3.1.3 Maximum Length
6984

70-
{{% snippet file="/static/_includes/refguide/editability-section-link.md" %}}
85+
This property specifies the maximum number of characters that can be typed in this text box.
7186

72-
### 2.6 Events Section{#events}
87+
| Value | Description |
88+
| --- | --- |
89+
| Attribute length *(default)* | The maximum number of characters is the same as the maximum length of the connected attribute |
90+
| Unlimited | The maximum number of characters is unlimited |
91+
| Custom | The maximum number of characters is specified in the widget properties |
7392

74-
#### 2.6.1 On Change Event{#on-change}
93+
#### 3.1.4 Placeholder Text
7594

76-
The on change event property specifies an action that will be executed when the value has been changed and gets submitted. A value will be submitted when pressing the <kbd>Enter</kbd> key or leaving the widget, either by using the <kbd>Tab</kbd> key or by clicking another widget.
95+
The placeholder text is shown when no text has been entered yet, or when a displayed attribute is empty.
7796

78-
{{% snippet file="/static/_includes/refguide/events-section-link.md" %}}
97+
It can be used, for example, to give a hint to the end-user what kind of text should be entered.
7998

80-
#### 2.6.2 On Change Behaviour
99+
#### 3.1.5 AutoFocus {#autofocus}
81100

82-
The On Change Behaviour property lets users select how **on change** is handled via the following options Studio Pro:
101+
If `true`, the text area will be rendered focused with the device keyboard opened.
83102

84-
* When user leaves input field (Default)
85-
* While user is entering data
103+
{{% alert color="info" %}}
104+
This option is only available in native pages.
105+
{{% /alert %}}
86106

87-
##### 2.6.2.1 When user leaves input field (Default)
107+
<a id="label-properties"></a>
88108

89-
This option will work as in previous versions of Studio Pro. Textbox will apply changes when a value is not the same as previously saved value in the database and one of the following conditions is met:
109+
### 3.2 Data Source Section{#data-source}
90110

91-
* On enter key pressed: This will trigger on change and on enter key press events
92-
* Blurred: This will trigger on change and on leave events
111+
{{% snippet file="/static/_includes/refguide/data-source-section-link.md" %}}
93112

94-
This means that there is no way for users to trigger an on change event while typing. That use case requires the second option: **While user is entering data**.
113+
### 3.3 Label Section{#label}
95114

96-
##### 2.6.2.2 While user is entering data
115+
{{% snippet file="/static/_includes/refguide/label-section-link.md" %}}
97116

98-
This option allows makes it so users trigger an on change event while they are typing. Text Box will save changes when the value is not the same as the previously saved value in the database and if the last change made took place after the configured **Apply after (ms)** length of time.
117+
### 3.4 Editability Section{#editability}
99118

100-
With **While user is entering data**, users now can adjust one more property called **Apply after (ms)** (described above). This will reduce the amount of the calls made for an on change event, thus improving app performance.
119+
{{% snippet file="/static/_includes/refguide/editability-section-link.md" %}}
101120

102-
{{% snippet file="/static/_includes/refguide/events-section-link.md" %}}
121+
### 3.5 Visibility Section{#visibility}
103122

104-
#### 2.6.3 On Enter Event
123+
{{% snippet file="/static/_includes/refguide/visibility-section-link.md" %}}
105124

106-
The on enter event property specifies an action that will be executed when the widget is entered, either by using the <kbd>Tab</kbd> key or by clicking it with the mouse.
125+
### 3.6 Validation Section{#validation}
107126

108-
{{% snippet file="/static/_includes/refguide/events-section-link.md" %}}
127+
{{% snippet file="/static/_includes/refguide/widget-validation-link.md" %}}
109128

110-
#### 2.6.4 On Leave Event
129+
### 3.7 Accessibility Section{#accessibility}
111130

112-
The on leave event property specifies an action that will be executed when leaving the widget, either by using the <kbd>Tab</kbd> key or by clicking another widget.
131+
### 3.7.1 Aria Required
113132

114-
This differs from the [On change](#on-change) property in that the event will always be triggered, even if the value has not been changed.
133+
In a textbox widget, when **Aria required** is set to **Yes** then assistive technologies will read out the field that is required. When set to **No** then assistive technologies will not read the field out.
115134

116-
{{% snippet file="/static/_includes/refguide/events-section-link.md" %}}
135+
#### 3.7.2 Autocomplete
117136

118-
#### 2.6.5 On Enter Key Press Event
137+
The autocomplete property specifies if a text box should have autocomplete enabled. The autocomplete attribute also improves the browser's ability to pre-populate fields with user-preferred values. For more information on how this helps you comply with accessibility guidelines, see the [Web Content Accessibility Guidelines (WCAG) 2.1](https://www.w3.org/TR/WCAG21/#input-purposes)
119138

120-
The on enter key press event property specifies an action that will be executed when the focus is inside the widget and the <kbd>Enter</kbd> key is pressed. In a web application the widget will keep focus after the action gets executed.
139+
### 3.8 Common Section{#common}
140+
141+
{{% snippet file="/static/_includes/refguide/common-section-link.md" %}}
142+
143+
### 3.9 Events Section{#events}
144+
145+
#### 3.9.1 On Change Event{#on-change}
146+
147+
The on change event property specifies an action that will be executed when the value has been changed and gets submitted. A value will be submitted when pressing the <kbd>Enter</kbd> key or leaving the widget, either by using the <kbd>Tab</kbd> key or by clicking another widget.
121148

122149
{{% snippet file="/static/_includes/refguide/events-section-link.md" %}}
123150

124-
### 2.7 Formatting Section{#formatting}
151+
#### 3.9.2 On Enter Event
125152

126-
The formatting section applies only to the way that numeric attributes are displayed. These are attributes of the following data types:
153+
The on enter event property specifies an action that will be executed when the widget is entered, either by using the <kbd>Tab</kbd> key or by clicking it with the mouse.
127154

128-
* Decimal
129-
* Integer
130-
* Long
155+
{{% snippet file="/static/_includes/refguide/events-section-link.md" %}}
131156

132-
{{% snippet file="/static/_includes/refguide/numeric-formatting-link.md" %}}
157+
#### 3.9.3 On Leave Event
133158

134-
### 2.8 General Section{#general}
159+
The on leave event property specifies an action that will be executed when leaving the widget, either by using the <kbd>Tab</kbd> key or by clicking another widget.
135160

136-
#### 2.8.1 Show as Password
161+
This differs from the [On change](#on-change) property in that the event will always be triggered, even if the value has not been changed.
137162

138-
Attributes of the data type `String` or `Hashed string` can have their value hidden. This can be used for passwords, for example, to prevent bystanders from seeing them.
163+
{{% snippet file="/static/_includes/refguide/events-section-link.md" %}}
139164

140-
| Value | Description |
141-
| --- | --- |
142-
| False *(default)*| Normal text box |
143-
| True | Typed characters are not shown to the end-user , instead an asterisk is shown for every typed character |
165+
#### 3.9.4 On Enter Key Press Event
144166

145-
#### 2.8.2 Input Mask
167+
The on enter key press event property specifies an action that will be executed when the focus is inside the widget and the <kbd>Enter</kbd> key is pressed. In a web application the widget will keep focus after the action gets executed.
146168

147-
{{% alert color="info" %}}Input masks are not supported on native mobile pages.
148-
Input masks are designed for string data types. Be cautious when using them with numeric or hashed string data types.
149-
{{% /alert %}}
169+
{{% snippet file="/static/_includes/refguide/events-section-link.md" %}}
150170

151-
The input mask limits what the end-user can enter in the text box, following the rules below:
171+
### 3.10 On Change Behavior {#on-change-behavior}
152172

153-
| Character | Allows Input of |
154-
| ----- | ----- |
155-
| `9` | any digit |
156-
| `Z` | any letter |
157-
| `U` | an upper-case letter |
158-
| `L` | a lower-case letter |
159-
| `*` | a letter *or* a digit |
173+
The On Change Behavior property lets users select how **on change** is handled via the following options Studio Pro:
160174

161-
Other characters will be taken literally.
175+
* When user leaves input field (Default)
176+
* While user is entering data
162177

163-
For example, the input mask `99-LLL-9999` matches `24-apr-2008`.
178+
##### 3.10.1 When user leaves input field (Default)
164179

165-
#### 2.8.3 Maximum Length
180+
This option will work as in previous versions of Studio Pro. Textbox will apply changes when a value is not the same as previously saved value in the database and one of the following conditions is met:
166181

167-
This property specifies the maximum number of characters that can be typed in this text box.
182+
* On enter key pressed: This will trigger on change and on enter key press events
183+
* Blurred: This will trigger on change and on leave events
168184

169-
| Value | Description |
170-
| --- | --- |
171-
| Attribute length *(default)* | The maximum number of characters is the same as the maximum length of the connected attribute |
172-
| Unlimited | The maximum number of characters is unlimited |
173-
| Custom | The maximum number of characters is specified in the widget properties |
185+
This means that there is no way for users to trigger an on change event while typing. That use case requires the second option: **While user is entering data**.
174186

175-
#### 2.8.4 Placeholder Text
187+
##### 3.10.2 While user is entering data
176188

177-
The placeholder text is shown when no text has been entered yet, or when a displayed attribute is empty.
189+
This option allows makes it so users trigger an on change event while they are typing. Text Box will save changes when the value is not the same as the previously saved value in the database and if the last change made took place after the configured **Apply after (ms)** length of time.
178190

179-
It can be used, for example, to give a hint to the end-user what kind of text should be entered.
191+
With **While user is entering data**, users now can adjust one more property called **Apply after (ms)** (described above). This will reduce the amount of the calls made for an on change event, thus improving app performance.
180192

181-
#### 2.8.5 AutoFocus {#autofocus}
193+
{{% snippet file="/static/_includes/refguide/events-section-link.md" %}}
182194

183-
If `true`, the text area will be rendered focused with the device keyboard opened.
195+
## 4 Styling
184196

185-
{{% alert color="info" %}}
186-
This option is only available in native pages.
187-
{{% /alert %}}
197+
### 4.1 Design Properties Section{#design-properties}
188198

189-
<a id="label-properties"></a>
199+
{{% snippet file="/static/_includes/refguide/design-section-link.md" %}}
190200

191-
### 2.9 Label Section{#label}
201+
### 4.2 Common Section{#common-styling}
192202

193-
{{% snippet file="/static/_includes/refguide/label-section-link.md" %}}
203+
{{% snippet file="/static/_includes/refguide/common-section-link.md" %}}
194204

195-
### 2.10 Validation Section{#validation}
205+
## 5 Miscellaneous
196206

197-
{{% snippet file="/static/_includes/refguide/widget-validation-link.md" %}}
207+
### 5.1 Formatting Section{#formatting}
198208

199-
### 2.11 Visibility Section{#visibility}
209+
The formatting section applies only to the way that numeric attributes are displayed. These are attributes of the following data types:
200210

201-
{{% snippet file="/static/_includes/refguide/visibility-section-link.md" %}}
211+
* Decimal
212+
* Integer
213+
* Long
214+
215+
{{% snippet file="/static/_includes/refguide/numeric-formatting-link.md" %}}
202216

203-
## 3 Read More
217+
## 6 Read More
204218

205219
* [Data Types](/refguide/data-types/)
206220
* [Data View](/refguide/data-view/)

content/en/docs/refguide/modeling/pages/structure-widgets/navigation-list.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Styling:
3030
* [Design Properties](#design-properties)
3131
* [Common](#common-styling)
3232

33-
Misc:
33+
Miscellaneous:
3434
* [Navigation List Item Properties](#nav-list)
3535

3636
## 3 Properties
Binary file not shown.

0 commit comments

Comments
 (0)