Skip to content

Latest commit

 

History

History
94 lines (62 loc) · 3.37 KB

File metadata and controls

94 lines (62 loc) · 3.37 KB

npm npm GitHub forks GitHub stars

Installation

Warning ⚠️ ⚠️

From 5.x using material component will break N tab component on iOS (which is bound to be removed). This is needed to allow using the latest native iOS features. If needed you can use either bottomnavigationbar (this one is the best choice, closest to material design) or tabs (clone of N one, but with a little less features)

For N 7.0

  • tns plugin add @nativescript-community/ui-material-floatingactionbutton

For N 6.x

  • tns plugin add nativescript-material-floatingactionbutton

If using tns-core-modules

  • tns plugin add nativescript-material-floatingactionbutton@2.5.4

Be sure to run a new build after adding plugins to avoid any issues.


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

mdcfloatingactionbutton {
    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"/>

Attributes

Inherite from Nativescript Button so it already has all the same attributes

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.