UNPKG

ink-checkbox

Version:

Checkbox component for Ink

github.com/baspinarenes/ink-checkbox

baspinarenes/ink-checkbox

72 lines (39 loc) • 1.08 kB
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
# ink-checkbox > Checkbox component for [Ink](https://github.com/vadimdemedes/ink). ## Install ``` $ npm install ink-checkbox --save ``` ## Demo Coming soon. ## Props ### Attributes ##### label Type: `string` Value to display next to the checkbox. ##### focused Type: `string` Checks if the cursor is above the checkbox. Highlights the highlighted checkbox using Ink's focus management. ##### index Type: `number` \ Default: `undefined` Checkbox identifier. If you are rendering more than one checkbox, it can be used instead of label to identify. ##### checked Type: `boolean`\ Default: `false` Controls whether the checkbox is selected by default. ##### wrapperStyles Type: `Object` Default: `{}` Override props of wrapper Ink's Box component. ##### styles Type: `Object` Default: `{}` Override default styles. ### Event Handlers ##### onChanged Type: `Function` Function to call for value updates. So it triggers when `Space`, `y` and `n` keys. ##### onSubmitted Type: `Function` Function to call for value submits. So it triggers when `Enter` keys.