NativeScript Material Button

Material Design's Button component for NativeScript.

Contents

• NativeScript Material Button
  • Contents
  • Installation
  • Changelog
  • FAQ
  • Usage
    • Plain NativeScript
      • XML
      • CSS
  • • NativeScript + Angular
  • • NativeScript + Vue
  • API
    • Attributes

Installation

For NativeScript 7.0+

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

For NativeScript 6.x

• tns plugin add nativescript-material-button

If using tns-core-modules

• tns plugin add nativescript-material-button@2.5.4

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:mdb="@nativescript-community/ui-material-button" on the Page element

XML

<Page xmlns:mdb="@nativescript-community/ui-material-button">
    <StackLayout horizontalAlignment="center">
        <mdb:Button text="raised button"/>
        <mdb:Button variant="flat" text="flat button"/>
        <mdb:Button variant="text" text="text button"/>
        <mdb:Button elevation="5" rippleColor="red" text="raised custom button"/>
   </StackLayout>
</Page>

CSS

mdbutton {
    ripple-color: blue;
    elevation: 4;
}

NativeScript + Angular

import { NativeScriptMaterialButtonModule } from "@nativescript-community/ui-material-button/angular";

@NgModule({
    imports: [
        NativeScriptMaterialButtonModule,
        ...
    ],
    ...
})

<MDButton rippleColor="blue" text="text button"></MDButton>

NativeScript + Vue

import Vue from 'nativescript-vue';
import ButtonPlugin from '@nativescript-community/ui-material-button/vue';

Vue.use(ButtonPlugin);

<MDButton rippleColor="blue" text="text button"/>

API

Attributes

Inherite from NativeScript Button so it already has all the same attributes.

• elevation optional

An attribute to set the elevation of the button. This will increase the 'drop-shadow' of the button.

• variant optional

An attribute to set the variant of the button. Can be flat or text. No value means raised button

• rippleColor optional

An attribute to set the ripple color of the button.