diff --git a/README.md b/README.md index b73023d3..8e287439 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,7 @@ Exported modules: * Components * [`ActivityIndicator`](docs/components/ActivityIndicator.md) + * [`Button`](docs/components/Button.md) * [`Image`](docs/components/Image.md) * [`ListView`](docs/components/ListView.md) * [`ProgressBar`](docs/components/ProgressBar.md) diff --git a/docs/components/Button.md b/docs/components/Button.md new file mode 100644 index 00000000..df92c51e --- /dev/null +++ b/docs/components/Button.md @@ -0,0 +1,39 @@ +# Button + +A basic button component. Supports a minimal level of customization. You can +build your own custom button using `TouchableOpacity` or +`TouchableNativeFeedback`. + +## Props + +**accessibilityLabel**: string + +Defines the text available to assistive technologies upon interaction with the +element. (This is implemented using `aria-label`.) + +**color**: string + +Background color of the button. + +**disabled**: bool = false + +If true, disable all interactions for this component + +**onPress**: function + +This function is called on press. + +**title**: string + +Text to display inside the button. + +## Examples + +```js +