Skip to content

Commit d0af4f3

Browse files
committed
docs(props): add skin and color as background prop
1 parent ff86735 commit d0af4f3

File tree

2 files changed

+16
-12
lines changed

2 files changed

+16
-12
lines changed

PROPS.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,13 @@
1818
| `buttonPressLeftImage` | Custom element on the button left of the spinner on pressed state | Component | | |
1919
| `buttonPressRightImage` | Custom element on the button right of the spinner on pressed state | Component | | |
2020
| `buttonPressStyle` | Button Style on Pressed state (Plus and Minus buttons) | Object | | Could overwrite other props |
21-
| `buttonPressTextColor` | Custom color of the button of the Spinner on Pressed state | String | `#FFFFFF` | |
21+
| `buttonPressTextColor` | Custom color of the button of the Spinner on Pressed state | String | Auto | |
2222
| `buttonRightDisabled` | Disable right button | Boolean | `false` | |
2323
| `buttonRightImage` | Custom element on the button right of the spinner | Component | | |
2424
| `buttonRightText` | Custom text on the button right of the spinner | String | | |
2525
| `buttonStyle` | Button Style (Plus and Minus buttons) | Object | | Could overwrite other props |
26-
| `buttonTextColor` | Custom color of the button of the Spinner | String | `#FFFFFF` | |
26+
| `buttonTextColor` | Custom color of the button of the Spinner | String | Auto | |
27+
| `colorAsBackground` | Use color as background | Bool | `false` |
2728
| `colorLeft` | Custom color of the Spinner left button | String | `#3E525F` | |
2829
| `colorMax` | Custom color of the Spinner when reach max value | String | | |
2930
| `colorMin` | Custom color of the Spinner when reach min value | String | | |
@@ -67,10 +68,11 @@
6768
| `selectionColor` | The highlight and cursor color of the text input. | String | `null` | |
6869
| `shadow` | Show container shadow | Boolean | `false` | Use with `background` like `background={"#FFF"}` |
6970
| `showBorder` | Show the border of the Spinner or not | Boolean | `false` | Use with `rounded={false}` |
71+
| `skin` | Skin layout | String | | `clean`, `modern`, `paper`, `round`, `square` |
7072
| `step` | Value to increment or decrement the current spinner value | String<br>Number | `1` | |
7173
| `style` | Container style | Object | | Could overwrite other props |
7274
| `speed` | Speed acceleration ratio of increase or decrease `onLongPress` | Number | `7` | (value from `1` to `10`) |
73-
| `textColor` | Custom number color | String | `#000000` | |
75+
| `textColor` | Custom number color | String | Auto | |
7476
| `type` | Type of spinner | String | `int` | Can be `int` or `real`/`float`... |
7577
| `typingTime` | Time before debounce and trigger `onChange` event | Number | `750` | |
7678
| `value` | Controlled value of the Spinner | String<br>Number | `0` | |

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -143,27 +143,29 @@ Check the "[Props List](PROPS.md)" file to have the complete list of component p
143143

144144
### Props Styles
145145

146-
| Property | Description | Type | Default | Note |
147-
| ------------------ | ----------------------------- | ------ | ------- | --------------------------- |
148-
| `buttonPressStyle` | Button style on Pressed state | Object | | Could overwrite other props |
149-
| `buttonStyle` | Button style | Object | | Could overwrite other props |
150-
| `inputStyle` | Text Input style | Object | | Could overwrite other props |
151-
| `style` | Container style | Object | | Could overwrite other props |
146+
| Property | Description | Type | Default | Note |
147+
| ------------------ | ----------------------------- | ------ | ------- | --------------------------------------------- |
148+
| `buttonPressStyle` | Button style on Pressed state | Object | | Could overwrite other props |
149+
| `buttonStyle` | Button style | Object | | Could overwrite other props |
150+
| `inputStyle` | Text Input style | Object | | Could overwrite other props |
151+
| `skin` | Skin layout | String | | `clean`, `modern`, `paper`, `round`, `square` |
152+
| `style` | Container style | Object | | Could overwrite other props |
152153

153154
### Props Colors
154155

155156
| Property | Description | Type | Default | Note |
156157
| ---------------------- | ---------------------------------------------------------- | ------ | ------------- | ---- |
157158
| `background` | Custom input text background color | String | `transparent` |
158-
| `buttonPressTextColor` | Custom color of the button of the Spinner on Pressed state | String | `#FFFFFF` |
159-
| `buttonTextColor` | Custom color of the labels's button of the Spinner | String | `#FFFFFF` |
159+
| `buttonPressTextColor` | Custom color of the button of the Spinner on Pressed state | String | Auto |
160+
| `buttonTextColor` | Custom color of the label's button of the Spinner | String | Auto |
161+
| `colorAsBackground` | Use color as background | Bool | `false` |
160162
| `colorLeft` | Custom color of the Spinner left button | String | `#3E525F` |
161163
| `colorMax` | Custom color of the Spinner when reach max value | String | |
162164
| `colorMin` | Custom color of the Spinner when reach min value | String | |
163165
| `colorPress` | Custom color of the Spinner button on touch press | String | `#3E525F` |
164166
| `colorRight` | Custom color of the Spinner right button | String | `#3E525F` |
165167
| `color` | Custom color of the Spinner | String | `#3E525F` |
166-
| `textColor` | Custom input text number color | String | `#000000` |
168+
| `textColor` | Custom input text number color | String | Auto |
167169

168170
#### Screenshots
169171

0 commit comments

Comments
 (0)