Wondering what’s next for npm?Check out our public roadmap! »

    @nativescript-community/ui-material-button
    TypeScript icon, indicating that this package has built-in type declarations

    5.3.5 • Public • Published

    NativeScript Material Button

    Material Design's Button component for NativeScript.

    npm npm

    Contents

    1. Installation
    2. Changelog
    3. FAQ
    4. Usage
    5. API

    Installation

    ⚠️ Warning ⚠️

    From NativeScript 5.x using this component will break the NativeScript 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 material-tabs (clone of the NativeScript one, but with a little less features).

    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.

    Install

    npm i @nativescript-community/ui-material-button

    DownloadsWeekly Downloads

    121

    Version

    5.3.5

    License

    Apache-2.0

    Unpacked Size

    149 kB

    Total Files

    41

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar