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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266 |
89x
26x
26x
89x
89x
89x
| import React from 'react';
import PropTypes from 'prop-types';
import { Label } from '@collab-ui/react';
/**
* @category controls
* @component checkbox
* @variations collab-ui-react
*/
const Checkbox = props => {
const {
checked,
children,
className,
disabled,
htmlId,
indeterminate,
inputRef,
label,
name,
nestedLevel,
onChange,
required,
value,
...otherProps
} = props;
return (
<div
className={
'cui-input-group cui-checkbox' +
`${(nestedLevel && ` cui-input--nested-${nestedLevel}`) || ''}` +
` ${className}`
}
>
<input
aria-checked={checked}
className={
`cui-input cui-checkbox__input` +
`${(indeterminate && ' indeterminate') || ''}`
}
type="checkbox"
ref={inputRef}
disabled={disabled}
checked={checked}
required={required}
name={name}
value={value}
onChange={onChange}
tabIndex={0}
id={htmlId}
{...otherProps}
/>
<Label
className="cui-checkbox__label"
label={label}
htmlFor={htmlId}
/>
{children}
</div>
);
};
Checkbox.propTypes = {
/** @prop Sets Checkbox status as checked | false */
checked: PropTypes.bool,
/** @prop Child component to display next to the input | null */
children: PropTypes.node,
/** @prop Optional css class string | '' */
className: PropTypes.string,
/** @prop Sets the attribute disabled to the Checkbox | false */
disabled: PropTypes.bool,
/** @prop Unique HTML ID. Used for tying label to HTML input. Handy hook for automated testing */
htmlId: PropTypes.string.isRequired,
/** @prop Optional indeterminate capabilities of checkbox | false */
indeterminate: PropTypes.bool,
/** @prop optional ref attribute for Checkbox input element | null */
inputRef: PropTypes.func,
/** @prop Required label string for Checkbox */
label: PropTypes.string.isRequired,
/** @prop Sets the attribute name to the Checkbox input element | '' */
name: PropTypes.string,
/** @prop Set the level of nested checkboxes | 0 */
nestedLevel: PropTypes.number,
/** @prop Optional onChange handler invoked when user makes a change within the Checkbox input element | null */
onChange: PropTypes.func,
/** @prop Optional required setting for Checkbox input | false */
required: PropTypes.bool,
/** @prop sets value of the Checkbox input element | '' */
value: PropTypes.string,
};
Checkbox.defaultProps = {
autoFocus: false,
checked: false,
className: '',
disabled: false,
indeterminate: false,
inputRef: null,
label: '',
name: '',
nestedLevel: 0,
onChange: () => {},
required: false,
value: '',
};
Checkbox.displayName = 'Checkbox';
export default Checkbox;
/**
* @component checkbox
* @section default
* @react
import { Checkbox, CheckboxGroup, InputHelper } from '@collab-ui/react';
export default function CheckboxDefault() {
return (
<CheckboxGroup name='CheckboxGroup1'>
<Checkbox
value='me'
label='me'
htmlId='testCheckbox1'
onChange={() => { }}
/>
</CheckboxGroup>
);
}
**/
/**
* @component checkbox
* @section group
* @react
import { Checkbox, CheckboxGroup, InputHelper } from '@collab-ui/react';
export default function CheckboxGroupExample() {
return (
<CheckboxGroup name='CheckboxGroup1'>
<Checkbox
value='me'
label='me'
htmlId='testCheckbox1'
onChange={() => { }}
/>
<Checkbox
value='you'
label='you'
htmlId='testCheckbox2'
onChange={() => { }}
/>
<Checkbox
value='us'
label='us'
htmlId='testCheckbox3'
onChange={() => { }}
/>
</CheckboxGroup>
);
}
**/
/**
* @component checkbox
* @section disabled
* @react
import { Checkbox } from '@collab-ui/react';
export default function CheckboxDisabled() {
return (
<Checkbox
value='disabledChecked'
label='Disabled Checkbox'
htmlId='disabledCheckbox'
disabled
onChange={()=>{}}
/>
);
}
**/
/**
* @component checkbox
* @section indeterminate
* @react
import { Checkbox } from '@collab-ui/react';
export default function CheckboxIndeterminate() {
return (
<Checkbox
value='indeterminate'
label='Indeterminate Checkbox'
htmlId='indeterminateCheckbox'
onChange={()=>{}}
indeterminate
/>
);
}
**/
/**
* @component checkbox
* @section nested
* @react
import { Checkbox } from '@collab-ui/react';
export default class CheckboxNested extends React.PureComponent {
state = {
parent: false,
child1: false,
child2: false,
child3: false,
}
render() {
return (
<span>
<Checkbox
value='parent'
label='Parent Checkbox Example'
htmlId='parentCheckbox'
checked={this.state.parent}
onChange={() => this.setState({ parent: !this.state.parent })}
key='child-0'
/>
<Checkbox
value='child1'
label='Child Checkbox Nested 1 Level'
htmlId='childCheckbox1'
nestedLevel={1}
checked={this.state.child1}
onChange={() => this.setState({ child1: !this.state.child1 })}
key='child-1'
/>
<Checkbox
value='child2'
label='Child Checkbox Nested 2 Levels'
htmlId='childCheckbox2'
nestedLevel={2}
checked={this.state.child2}
onChange={() => this.setState({ child2: !this.state.child2 })}
key='child-2'
/>
<Checkbox
value='child3'
label='Child Checkbox Nested 3 Levels'
htmlId='childCheckbox3'
nestedLevel={3}
checked={this.state.child3}
onChange={() => this.setState({ child3: !this.state.child3 })}
key='child-3'
/>
</span>
);
}
}
**/
|