@nativescript-community/ui-material-floatingactionbutton
v7.2.67
Published
Material Design FAB performs the primary, or most common, action on a screen. It appears in front of all screen content, typically as a circular shape with an icon in its center.
Downloads
1,118
Readme
NativeScript Material Floating action button
Material Design's Floating action button component for NativeScript.
Contents
Installation
For NativeScript 7.0+
tns plugin add @nativescript-community/ui-material-floatingactionbutton
For NativeScript 6.x
tns plugin add nativescript-material-floatingactionbutton
If using tns-core-modules
tns plugin add [email protected]
Be sure to run a new build after adding plugins to avoid any issues.
Changelog
FAQ
Usage
Plain NativeScript
IMPORTANT: Make sure you include xmlns:mdf="@nativescript-community/ui-material-floatingactionbutton"
on the Page element
XML
<Page xmlns:mdf="@nativescript-community/ui-material-floatingactionbutton">
<StackLayout horizontalAlignment="center">
<mdf:FloatingActionButton src="res://ic_action_add"/>
<mdf:FloatingActionButton elevation="5" src="res://ic_action_add"/>
</StackLayout>
</Page>
CSS
mdfloatingactionbutton {
ripple-color: blue;
elevation: 4;
}
NativeScript + Angular
import { registerElement } from '@nativescript/angular/element-registry';
import { FloatingActionButton } from '@nativescript-community/ui-material-floatingactionbutton';
registerElement('MDFloatingActionButton', () => FloatingActionButton);
<MDFloatingActionButton rippleColor="blue" src="res://ic_action_add"></MDFloatingActionButton>
NativeScript + Vue
import Vue from 'nativescript-vue';
import FloatingActionButtonPlugin from '@nativescript-community/ui-material-floatingactionbutton/vue';
Vue.use(FloatingActionButtonPlugin);
<MDFloatingActionButton rippleColor="blue" src="res://ic_action_add"/>
API
Attributes
Inherite from NativeScript Button so it already has all the same attributes.
- src optional
An attribute to set the floatingactionbutton icon. For now FAB only support images as icon
- elevation optional
An attribute to set the elevation of the floatingactionbutton. This will increase the 'drop-shadow' of the floatingactionbutton.
- rippleColor optional
An attribute to set the ripple color of the floatingactionbutton.