File: HelperText.md

package info (click to toggle)
cockpit 354-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 308,956 kB
  • sloc: javascript: 775,606; python: 40,351; ansic: 35,655; cpp: 11,117; sh: 3,511; makefile: 580; xml: 261
file content (190 lines) | stat: -rw-r--r-- 6,928 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
---
id: 'Helper text'
section: components
cssPrefix: pf-v6-c-helper-text
---## Examples

### Basic

```html
<div class="pf-v6-c-helper-text">
  <div class="pf-v6-c-helper-text__item">
    <span class="pf-v6-c-helper-text__item-text">This is default helper text</span>
  </div>
</div>
<div class="pf-v6-c-helper-text">
  <div class="pf-v6-c-helper-text__item pf-m-indeterminate">
    <span class="pf-v6-c-helper-text__item-icon">
      <i class="fas fa-fw fa-minus" aria-hidden="true"></i>
    </span>
    <span class="pf-v6-c-helper-text__item-text">
      <span class="pf-v6-screen-reader">Indeterminate:</span>
      This is indeterminate helper text
    </span>
  </div>
</div>
<div class="pf-v6-c-helper-text">
  <div class="pf-v6-c-helper-text__item pf-m-warning">
    <span class="pf-v6-c-helper-text__item-icon">
      <i class="fas fa-fw fa-exclamation-triangle" aria-hidden="true"></i>
    </span>
    <span class="pf-v6-c-helper-text__item-text">
      <span class="pf-v6-screen-reader">Warning:</span>
      This is warning helper text
    </span>
  </div>
</div>
<div class="pf-v6-c-helper-text">
  <div class="pf-v6-c-helper-text__item pf-m-success">
    <span class="pf-v6-c-helper-text__item-icon">
      <i class="fas fa-fw fa-check-circle" aria-hidden="true"></i>
    </span>
    <span class="pf-v6-c-helper-text__item-text">
      <span class="pf-v6-screen-reader">Success:</span>
      This is success helper text
    </span>
  </div>
</div>
<div class="pf-v6-c-helper-text">
  <div class="pf-v6-c-helper-text__item pf-m-error">
    <span class="pf-v6-c-helper-text__item-icon">
      <i class="fas fa-fw fa-exclamation-circle" aria-hidden="true"></i>
    </span>
    <span class="pf-v6-c-helper-text__item-text">
      <span class="pf-v6-screen-reader">Error:</span>
      This is error helper text
    </span>
  </div>
</div>

```

### Multiple items

You can include multiple `HelperTextItem` components inside a single `HelperText` container.

```html
<ul class="pf-v6-c-helper-text" role="list">
  <li class="pf-v6-c-helper-text__item">
    <span class="pf-v6-c-helper-text__item-text">This is default helper text</span>
  </li>
  <li class="pf-v6-c-helper-text__item">
    <span
      class="pf-v6-c-helper-text__item-text"
    >This is another default helper text in the same block</span>
  </li>
  <li class="pf-v6-c-helper-text__item">
    <span
      class="pf-v6-c-helper-text__item-text"
    >And this is more default text in the same block</span>
  </li>
</ul>

```

### Dynamic

If the `HelperTextItem` components are expected or intended to dynamically update in some way, you should use a dynamic `HelperText` container.

```html
<div class="pf-v6-c-helper-text">
  <div class="pf-v6-c-helper-text__item pf-m-dynamic">
    <span class="pf-v6-c-helper-text__item-text">This is default helper text</span>
  </div>
</div>
<div class="pf-v6-c-helper-text">
  <div class="pf-v6-c-helper-text__item pf-m-indeterminate pf-m-dynamic">
    <span class="pf-v6-c-helper-text__item-icon">
      <i class="fas fa-fw fa-minus" aria-hidden="true"></i>
    </span>
    <span class="pf-v6-c-helper-text__item-text">
      <span class="pf-v6-screen-reader">Indeterminate:</span>
      This is indeterminate helper text
    </span>
  </div>
</div>
<div class="pf-v6-c-helper-text">
  <div class="pf-v6-c-helper-text__item pf-m-warning pf-m-dynamic">
    <span class="pf-v6-c-helper-text__item-icon">
      <i class="fas fa-fw fa-exclamation-triangle" aria-hidden="true"></i>
    </span>
    <span class="pf-v6-c-helper-text__item-text">
      <span class="pf-v6-screen-reader">Warning:</span>
      This is warning helper text
    </span>
  </div>
</div>
<div class="pf-v6-c-helper-text">
  <div class="pf-v6-c-helper-text__item pf-m-success pf-m-dynamic">
    <span class="pf-v6-c-helper-text__item-icon">
      <i class="fas fa-fw fa-check-circle" aria-hidden="true"></i>
    </span>
    <span class="pf-v6-c-helper-text__item-text">
      <span class="pf-v6-screen-reader">Success:</span>
      This is success helper text
    </span>
  </div>
</div>
<div class="pf-v6-c-helper-text">
  <div class="pf-v6-c-helper-text__item pf-m-error pf-m-dynamic">
    <span class="pf-v6-c-helper-text__item-icon">
      <i class="fas fa-fw fa-exclamation-circle" aria-hidden="true"></i>
    </span>
    <span class="pf-v6-c-helper-text__item-text">
      <span class="pf-v6-screen-reader">Error:</span>
      This is error helper text
    </span>
  </div>
</div>

```

### Dynamic list

```html
<ul class="pf-v6-c-helper-text" role="list">
  <li class="pf-v6-c-helper-text__item pf-m-success pf-m-dynamic">
    <span class="pf-v6-c-helper-text__item-icon">
      <i class="fas fa-fw fa-check-circle" aria-hidden="true"></i>
    </span>
    <span class="pf-v6-c-helper-text__item-text">
      <span class="pf-v6-screen-reader">Success:</span>
      Must be at least 14 characters
    </span>
  </li>
  <li class="pf-v6-c-helper-text__item pf-m-error pf-m-dynamic">
    <span class="pf-v6-c-helper-text__item-icon">
      <i class="fas fa-fw fa-exclamation-circle" aria-hidden="true"></i>
    </span>
    <span class="pf-v6-c-helper-text__item-text">
      <span class="pf-v6-screen-reader">Error:</span>
      Cannot contain any variation of the word "redhat"
    </span>
  </li>
  <li class="pf-v6-c-helper-text__item pf-m-success pf-m-dynamic">
    <span class="pf-v6-c-helper-text__item-icon">
      <i class="fas fa-fw fa-check-circle" aria-hidden="true"></i>
    </span>
    <span class="pf-v6-c-helper-text__item-text">
      <span class="pf-v6-screen-reader">Success:</span>
      Must include at least 3 of the following: lowercase letter, uppercase letters, numbers, symbols
    </span>
  </li>
</ul>

```

### Usage

| Class | Applied to | Outcome |
| -- | -- | -- |
| `.pf-v6-c-helper-text` | `<div>`, `<ul>` |  Initiates the helper text component. **Required** |
| `.pf-v6-c-helper-text__item` | `<div>`, `<li>` |  Initiates a helper text item. **Required** |
| `.pf-v6-c-helper-text__item-icon` | `<span>` |  Initiates a helper text item icon. **Required when used in `.pf-v6-c-helper-text__item.pf-m-dynamic`** |
| `.pf-v6-c-helper-text__item-text` | `<span>` |  Initiates a helper text item text. **Required** |
| `.pf-m-dynamic` | `.pf-v6-c-helper-text__item` |  Modifies a helper text item to be dynamic. For use when the item changes state as the form field the text is associated with is updated. |
| `.pf-m-indeterminate` | `.pf-v6-c-helper-text__item` |  Modifies a helper text item for indeterminate state styles. |
| `.pf-m-warning` | `.pf-v6-c-helper-text__item` |  Modifies a helper text item for warning state styles. |
| `.pf-m-success` | `.pf-v6-c-helper-text__item` |  Modifies a helper text item for success state styles. |
| `.pf-m-error` | `.pf-v6-c-helper-text__item` |  Modifies a helper text item for error state styles. |
| `.pf-m-hidden` | `.pf-v6-c-helper-text` | Hides helper text. |