Skip to content

Commit ecee5ed

Browse files
committed
README is updated
1 parent a363372 commit ecee5ed

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -81,12 +81,23 @@ should work of the example project.
8181

8282
# Configuration - Props
8383

84-
| Property | Type | Default | Description |
85-
| -------- | :-----: | :-----: | ------------------------------------------------------- |
86-
| outline | boolean | true | make the button outline |
87-
| solid | boolean | false | make the button with a solid background and a shadow |
88-
| gradient | boolean | false | make the button with a gradient background and a shadow |
89-
| width | number | 150 | change the button's width |
84+
## Fundamentals
85+
86+
| Property | Type | Default | Description |
87+
| ----------- | :----: | :-------: | --------------------- |
88+
| title | string | undefined | change the title |
89+
| description | string | undefined | change the descrition |
90+
91+
## Customization (Optionals)
92+
93+
| Property | Type | Default | Description |
94+
| -------------- | :-------: | :-------: | ---------------------------------------------------------------------- |
95+
| enableButton | boolean | false | let you enable the button (must use it for button) |
96+
| onPress | function | undefined | set your own logic for the button functionality when it is pressed |
97+
| buttonText | string | undefined | change the button's text |
98+
| style | ViewStyle | default | set or override the style object for the main container |
99+
| buttonStyle | ViewStyle | default | set or override the style object for the button style |
100+
| ImageComponent | Image | default | set your own component instead of default react-native Image component |
90101

91102
## Future Plans
92103

0 commit comments

Comments
 (0)