Skip to main content
Version: 7.37.0

Fab

Controls the FAB button styling on Android.

const options = {
fab: {
id: 'id',
icon: require('path-to-fab-icon'),
backgroundColor: 'coral',
actions: [
{
id: 'id2',
icon: require('path-to-fab-icon-2),
}
]
},
};

id#

Button id for reference press event.

Note

This option is mandatory when you are initiating the FAB button. However you do not need to pass in id when updating the Fab button options with Navigation.mergeOptions.

TypeRequiredPlatform
stringNoAndroid

icon#

Change the default back button icon.

TypeRequiredPlatform
numberNoAndroid

iconColor#

Change the icon color of the FAB button.

TypeRequiredPlatform
colorNoAndroid

backgroundColor#

Change the background color of the FAB button.

TypeRequiredPlatform
colorNoAndroid

clickColor#

Change the on-clicked background color of the FAB button.

TypeRequiredPlatform
colorNoAndroid

rippleColor#

Change the ripple color of the FAB button.

TypeRequiredPlatform
colorNoAndroid

visible#

Show or hide the FAB button.

TypeRequiredPlatform
booleanNoAndroid

alignHorizontally#

Set the horizontal position of the FAB button on the screen.

TypeRequiredPlatform
'left' or 'right'NoAndroid

hideOnScroll#

Hide the FAB button on scroll.

TypeRequiredPlatform
booleanNoAndroid

size#

Set the size of the FAB button.

TypeRequiredPlatform
'mini' or 'regular'NoAndroid