Skip to content

Commit 35dfaef

Browse files
authored
update docs for 0.4.x (#6)
1 parent f3c0b27 commit 35dfaef

File tree

1 file changed

+57
-7
lines changed

1 file changed

+57
-7
lines changed

README.md

Lines changed: 57 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ React Native bindings.
6868

6969
is an alias for `React.Ref.t(Js.nullable(element))`.
7070

71-
### Props
71+
### CheckBox common props
7272

7373
All props are optional.
7474

@@ -77,11 +77,6 @@ All props are optional.
7777
Value of the checkbox. When `true`, checkbox will be checked. Default value is
7878
`false`.
7979

80-
#### `disabled: bool`
81-
82-
When `true`, user will not be able to toggle the checkbox. Default value is
83-
`false`.
84-
8580
#### `onChange: checkBoxEvent => unit`
8681

8782
Returns a [native event](#checkBoxEvent).
@@ -90,16 +85,71 @@ Returns a [native event](#checkBoxEvent).
9085

9186
Returns the new `bool` value.
9287

88+
#### `testID: string`
89+
90+
Used to locate this view in end-to-end tests.
91+
92+
### CheckBox Android props
93+
94+
#### `disabled: bool`
95+
96+
When `true`, user will not be able to toggle the checkbox. Default value is
97+
`false`.
98+
9399
#### `tintColors`
94100

95101
```reason
96102
tintColors:
97-
(~_true: ReactNative.Color.t=?, ~_false: ReactNative.Color.t=?, unit) => tintColors
103+
(~_true: int=?, ~_false: int=?, unit) => tintColors
98104
```
99105

100106
Value for `_true` will be used when the checkbox is checked, and value for
101107
`_false` will be used when it is not checked.
102108

109+
### CheckBox iOS props
110+
111+
#### `lineWidth: float`
112+
113+
The width of the lines of the check mark and box. Defaults to `2.0`.
114+
115+
#### `hideBox: bool`
116+
117+
Control if the box should be hidden or not. Defaults to `false`
118+
119+
#### `` boxType: `circle or `square ``
120+
121+
The type of box to use. Defaults to `` `circle ``
122+
123+
#### `tintColor: Color.t`
124+
125+
The color of the box when the checkbox is Off. Defaults to `#aaaaaa`
126+
127+
#### `onCheckColor: Color.t`
128+
129+
The color of the check mark when it is On. Defaults to `#007aff`
130+
131+
#### `onFillColor: Color.t`
132+
133+
The color of the inside of the box when it is On. Defaults to transparent
134+
135+
#### `onTintColor: Color.t`
136+
137+
The color of the line around the box when it is On. Defaults to `#007aff`
138+
139+
#### `animationDuration: float`
140+
141+
The duration in seconds of the animations. Defaults to 0.5
142+
143+
#### `` onAnimationType: `stroke or `fill or `bounce or `flat or `oneStroke or `fade ``
144+
145+
The type of animation to use when the checkbox gets checked. Defaults to
146+
`` `stroke ``
147+
148+
#### `` offAnimationType: `stroke or `fill or `bounce or `flat or `oneStroke or `fade ``
149+
150+
The type of animation to use when the checkbox gets unchecked. Defaults to
151+
`` `stroke ``
152+
103153
### `View` props
104154

105155
Refer to

0 commit comments

Comments
 (0)