Skip to main content
Version: 3.4.2

button

Props

Also receives all TouchableNativeFeedback (Android) or TouchableOpacity (iOS) props


Reference

buttonStyle

add additional styling for button component (optional)

TypeDefault
View style (object)none

containerStyle

styling for Component container

TypeDefault
View style (object)none

disabled

disables user interaction

TypeDefault
booleanfalse

disabledStyle

style of the button when disabled

TypeDefault
View style (object)Internal Style

disabledTitleStyle

style of the title when disabled

TypeDefault
Text style (object)Internal Style

icon

displays a centered icon (when no title) or to the left (with text). (can be used along with iconRight as well). Can be an object or a custom component.

TypeDefault
{...Icon props}
OR
component
none

iconContainerStyle

styling for Icon Component container

TypeDefault
View style (object)none

iconRight

displays Icon to the right of title. Needs to be used along with icon prop

TypeDefault
booleanfalse

iconPosition

displays Icon to the position mentioned. Needs to be used along with icon prop

TypeDefault
stringleft

linearGradientProps

displays a linear gradient. See usage.

TypeDefault
{...Gradient props}none

loading

prop to display a loading spinner (optional)

TypeDefault
booleanfalse

loadingProps

add additional props for ActivityIndicator component (optional)

TypeDefault
{...ActivityIndicator props}Internal object

loadingStyle

add additional styling for loading component (optional)

TypeDefault
View style (object)Internal Style

onPress

onPress method (optional)

TypeDefault
functionnone

raised

Add raised button styling (optional). Has no effect if type="clear".

TypeDefault
booleanfalse

title

button title (optional)

TypeDefault
string
OR
component
none

titleProps

add additional props for Text component (optional)

TypeDefault
{...Text props}none

titleStyle

add additional styling for title component (optional)

TypeDefault
Text style (object)none

TouchableComponent

component for user interaction

TypeDefault
Touchable ComponentTouchableOpacity (ios) or TouchableNativeFeedback (android) or TouchableOpacity (android, if linearGradientProps exists)

type

Type of button (optional)

TypeDefault
solid, clear, outlinesolid

ViewComponent

component for container

TypeDefault
React Native ComponentView