Back to React Native Paper

AnimatedFAB

docs/public/4.0/animated-fab.html

5.15.11.9 KB
Original Source

AnimatedFAB

Props

icon (required) Type: IconSource

Icon to display for the FAB.

label (required) Type: string

Label for extended FAB.

uppercase Type: boolean

Default value: true

Make the label text uppercased.

accessibilityLabel Type: string

Default value: label

Accessibility label for the FAB. This is read by the screen reader when the user taps the FAB. Uses label by default if specified.

accessibilityState Type: AccessibilityState

Accessibility state for the FAB. This is read by the screen reader when the user taps the FAB.

color Type: string

Custom color for the icon and label of the FAB.

disabled Type: boolean

Whether FAB is disabled. A disabled button is greyed out and onPress is not called on touch.

visible Type: boolean

Default value: true

Whether FAB is currently visible.

onPress Type: () => void

Function to execute on press.

onLongPress Type: () => void

Function to execute on long press.

iconMode Type: 'static' | 'dynamic'

Default value: 'dynamic'

Whether icon should be translated to the end of extended FAB or be static and stay in the same place. The default value is dynamic.

animateFrom Type: 'left' | 'right'

Default value: 'right'

Indicates from which direction animation should be performed. The default value is right.

extended Type: boolean

Default value: false

Whether FAB should start animation to extend.

style Type: StyleProp<ViewStyle>

theme Type: ReactNativePaper.Theme

testID Type: string

Edit this page