Skip to content

Commit f9e4c81

Browse files
author
Marco Cesarato
committed
docs: update readme and props
1 parent afcd944 commit f9e4c81

File tree

2 files changed

+110
-89
lines changed

2 files changed

+110
-89
lines changed

‎PROPS.md‎

Lines changed: 57 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -2,52 +2,60 @@
22

33
## 💡 Props List
44

5-
| Property | Description | Type | Default | Note |
6-
| ----------------------- | ------------------------------------------------------------------- | ---------------- | ---------------- | --------------------------------- |
7-
| `activeOpacity` | Opacity on pressed button | Number | `0.85` |
8-
| `append` | Custom element before right button | Component | |
9-
| `arrows` | Labels on button will be arrows (< and >) instead of plus and minus | Boolean | `false` |
10-
| `background` | Background color of number button | String | `transparent` | |
11-
| `buttonFontFamily` | Custom fontFamily of buttons of the Spinner | String | `System Default` | |
12-
| `buttonFontSize` | Custom fontSize of buttons of the Spinner | Number | `14` | |
13-
| `buttonLeftDisabled` | Disable left button | Boolean | `false` | |
14-
| `buttonLeftImage` | Custom element on the button left of the spinner | Component | | |
15-
| `buttonLeftText` | Custom text on the button left of the spinner | String | | |
16-
| `buttonPressLeftImage` | Custom element on the button left of the spinner on pressed state | Component | | |
17-
| `buttonPressRightImage` | Custom element on the button right of the spinner on pressed state | Component | | |
18-
| `buttonPressStyle` | Button Style on Pressed state (Plus and Minus buttons) | Object | | Could overwrite other props |
19-
| `buttonPressTextColor` | Custom color of the button of the Spinner on Pressed state | String | `#FFFFFF` | |
20-
| `buttonRightDisabled` | Disable right button | Boolean | `false` | |
21-
| `buttonRightImage` | Custom element on the button right of the spinner | Component | | |
22-
| `buttonRightText` | Custom text on the button right of the spinner | String | | |
23-
| `buttonStyle` | Button Style (Plus and Minus buttons) | Object | | Could overwrite other props |
24-
| `buttonTextColor` | Custom color of the button of the Spinner | String | `#FFFFFF` | |
25-
| `colorLeft` | Custom color of the Spinner left button | String | `#3E525F` | |
26-
| `colorMax` | Custom color of the Spinner when reach max value | String | | |
27-
| `colorMin` | Custom color of the Spinner when reach min value | String | | |
28-
| `colorPress` | Custom color of the Spinner button on touch press | String | `#3E525F` | |
29-
| `colorRight` | Custom color of the Spinner right button | String | `#3E525F` | |
30-
| `color` | Custom color of the Spinner | String | `#3E525F` | |
31-
| `disabled` | Disable the Spinner or not | Boolean | `false` | |
32-
| `editable` | Set if input number field is editable or not | Boolean | `true` | |
33-
| `fontFamily` | Custom fontFamily of the text input of the Spinner | String | System Default | |
34-
| `fontSize` | Custom fontSize of the text input of the Spinner | Number | `14` | |
35-
| `height` | Custom height of the Spinner | Number | `50` | |
36-
| `inputStyle` | Input Style (Text number at middle) | Object | | Could overwrite other props |
37-
| `max` | Max number permitted | String<br>Number | `0` | |
38-
| `min` | Min value permitted | String<br>Number | `99` | |
39-
| `onChange` | Get the number of the Spinner | Function | | `(num) => { ... }` |
40-
| `onDecrease` | When decrease button is clicked get value decreased | Function | | `(decreased) => { ... }` |
41-
| `onIncrease` | When increase button is clicked get value increased | Function | | `(increased) => { ... }` |
42-
| `onMax` | When max is reached get max number permitted | Function | | `(max) => { ... }` |
43-
| `onMin` | When min is reached get min number permitted | Function | | `(min) => { ... }` |
44-
| `precision` | Max numbers permitted after comma | Integer | `2` | |
45-
| `prepend` | Custom element after left button | Component | |
46-
| `rounded` | Use circular button | Boolean | `true` | |
47-
| `showBorder` | Show the border of the Spinner or not | Boolean | `false` | Use with `rounded={false}` |
48-
| `step` | Value to increment or decrement the current spinner value | String<br>Number | `1` | |
49-
| `style` | Container style | Object | | Could overwrite other props |
50-
| `textColor` | Custom number color | String | `#000000` | |
51-
| `type` | Type of spinner | String | `int` | Can be `int` or `real`/`float`... |
52-
| `value` | Controlled value of the Spinner | String<br>Number | `0` | |
53-
| `width` | Custom width of the Spinner | Number | `150` | |
5+
| Property | Description | Type | Default | Note |
6+
| ----------------------- | ---------------------------------------------------------------------- | ---------------- | ---------------- | --------------------------------- |
7+
| `activeOpacity` | Opacity on pressed button | Number | `0.85` |
8+
| `append` | Custom element before right button | Component | |
9+
| `arrows` | Labels on button will be arrows (< and >) instead of plus and minus | Boolean | `false` |
10+
| `autofocus` | If `true`, focuses the input on zcomponentDidMountz. | | `false` | |
11+
| `background` | Background color of number button | String | `transparent` | |
12+
| `buttonFontFamily` | Custom fontFamily of buttons of the Spinner | String | `System Default` | |
13+
| `buttonFontSize` | Custom fontSize of buttons of the Spinner | Number | `14` | |
14+
| `buttonLeftDisabled` | Disable left button | Boolean | `false` | |
15+
| `buttonLeftImage` | Custom element on the button left of the spinner | Component | | |
16+
| `buttonLeftText` | Custom text on the button left of the spinner | String | | |
17+
| `buttonPressLeftImage` | Custom element on the button left of the spinner on pressed state | Component | | |
18+
| `buttonPressRightImage` | Custom element on the button right of the spinner on pressed state | Component | | |
19+
| `buttonPressStyle` | Button Style on Pressed state (Plus and Minus buttons) | Object | | Could overwrite other props |
20+
| `buttonPressTextColor` | Custom color of the button of the Spinner on Pressed state | String | `#FFFFFF` | |
21+
| `buttonRightDisabled` | Disable right button | Boolean | `false` | |
22+
| `buttonRightImage` | Custom element on the button right of the spinner | Component | | |
23+
| `buttonRightText` | Custom text on the button right of the spinner | String | | |
24+
| `buttonStyle` | Button Style (Plus and Minus buttons) | Object | | Could overwrite other props |
25+
| `buttonTextColor` | Custom color of the button of the Spinner | String | `#FFFFFF` | |
26+
| `colorLeft` | Custom color of the Spinner left button | String | `#3E525F` | |
27+
| `colorMax` | Custom color of the Spinner when reach max value | String | | |
28+
| `colorMin` | Custom color of the Spinner when reach min value | String | | |
29+
| `colorPress` | Custom color of the Spinner button on touch press | String | `#3E525F` | |
30+
| `colorRight` | Custom color of the Spinner right button | String | `#3E525F` | |
31+
| `color` | Custom color of the Spinner | String | `#3E525F` | |
32+
| `disabled` | Disable the Spinner or not | Boolean | `false` | |
33+
| `editable` | Set if input number field is editable or not | Boolean | `true` | |
34+
| `fontFamily` | Custom fontFamily of the text input of the Spinner | String | System Default | |
35+
| `fontSize` | Custom fontSize of the text input of the Spinner | Number | `14` | |
36+
| `height` | Custom height of the Spinner | Number | `50` | |
37+
| `inputStyle` | Input Style (Text number at middle) | Object | | Could overwrite other props |
38+
| `maxLength` | Limits the maximum number of characters that can be entered. | Number | | |
39+
| `max` | Max number permitted | String<br>Number | `0` | |
40+
| `min` | Min value permitted | String<br>Number | `99` | |
41+
| `onBlur` | Callback that is called when the text input is blurred. | (e) => { ... } |
42+
| `onChange` | Get the number of the Spinner | Function | | `(num) => { ... }` |
43+
| `onDecrease` | When decrease button is clicked get value decreased | Function | | `(decreased) => { ... }` |
44+
| `onFocus` | Callback that is called when the text input is focused. | (e) => { ... } |
45+
| `onIncrease` | When increase button is clicked get value increased | Function | | `(increased) => { ... }` |
46+
| `onKeyPress` | Callback that is called when a key is pressed. | (e) => { ... } |
47+
| `onMax` | When max is reached get max number permitted | Function | | `(max) => { ... }` |
48+
| `onMin` | When min is reached get min number permitted | Function | | `(min) => { ... }` |
49+
| `onSubmitEditing` | Callback that is called when the text input's submit button is pressed | (e) => { ... } |
50+
| `precision` | Max numbers permitted after comma | Integer | `2` | |
51+
| `prepend` | Custom element after left button | Component | |
52+
| `rounded` | Use circular button | Boolean | `true` | |
53+
| `selectTextOnFocus` | If `true`, all text will automatically be selected on focus. | Bool | `false` | |
54+
| `selectionColor` | The highlight and cursor color of the text input. | String | `null` | |
55+
| `showBorder` | Show the border of the Spinner or not | Boolean | `false` | Use with `rounded={false}` |
56+
| `step` | Value to increment or decrement the current spinner value | String<br>Number | `1` | |
57+
| `style` | Container style | Object | | Could overwrite other props |
58+
| `textColor` | Custom number color | String | `#000000` | |
59+
| `type` | Type of spinner | String | `int` | Can be `int` or `real`/`float`... |
60+
| `value` | Controlled value of the Spinner | String<br>Number | `0` | |
61+
| `width` | Custom width of the Spinner | Number | `150` | |

0 commit comments

Comments
 (0)