3.0.4 • Published 4 years ago

@nstudio/nativescript-floatingactionbutton v3.0.4

Weekly downloads
177
License
MIT
Repository
github
Last release
4 years ago

Installation

Nativescript 7+:

ns plugin add @nstudio/nativescript-floatingactionbutton

NativeScript lower than 7:

tns plugin add @nstudio/nativescript-floatingactionbutton@2.1.0

Screenshot


FAB Android Screenshot FAB iOS Screenshot

Multiple FAB/Swipe Animation Support

FAB Animations

Usage

Plain NativeScript

<Page xmlns="http://schemas.nativescript.org/tns.xsd" loaded="pageLoaded"
      xmlns:FAB="@nstudio/nativescript-floatingactionbutton">
    <ActionBar title="Native FAB" />
    <grid-layout rows="auto, *">
        <list-view row="1" items="{{ users }}">
            <list-view.itemTemplate>
                <label text="{{ name }}" />
            </list-view.itemTemplate>
        </list-view>
            <FAB:fab tap="fabTap"
                     row="1"
                     icon="'~/assets/ic_add_white.png'"
                     rippleColor="#f1f1f1"
                     class="fab-button" />
    </grid-layout>
</Page>

NativeScript Angular

import { registerElement } from 'nativescript-angular/element-registry';
registerElement(
  'Fab',
  () => require('@nstudio/nativescript-floatingactionbutton').Fab
);

HTML

<StackLayout>
    <FAB (tap)="fabTap()" icon="'~/assets/ic_add_white.png'" rippleColor="#f1f1f1" class="fab-button"></FAB>
</StackLayout>

NativeScript Vue

import Vue from 'nativescript-vue';

Vue.registerElement(
  'Fab',
  () => require('@nstudio/nativescript-floatingactionbutton').Fab
);

Template

<template>
  <page>
    <grid-layout rows="auto, *">
      <list-view row="1" items="{{ users }}">
        <list-view.itemTemplate>
          <label text="{{ name }}" textWrap="true" />
        </list-view.itemTemplate>
      </list-view>
      <fab
        @tap="fabTap"
        row="1"
        icon="res://ic_add_white"
        rippleColor="#f1f1f1"
        class="fab-button"
      ></fab>
    </grid-layout>
  </page>
</template>

CSS

Recommended CSS styles.

.fab-button {
  height: 70;
  width: 70; /// this is required on iOS - Android does not require width so you might need to adjust styles
  margin: 15;
  background-color: #ff4081;
  horizontal-align: right;
  vertical-align: bottom;
}

Use Icon Fonts

First you need to setup icon fonts as described in NativeScript documentation.

After this, you can use icon fonts on FAB by specifiying the unicode as text and add the fas/far class:

<FAB:fab text="&#xf02a;" class="fab-button fas" />

API

PropertyAndroidiOSDescriptionNote
backgroundColorXXSets the background color of the button
iconXXSupports the same image source options that NativeScript images supportRequired on android
textXXAllows to use text instead of imageCan be styled with font-* and color CSS properties
rippleColorXRipple color on lollipop devices, it will fill the FAB on pre-lollipop devicesNone
hideOnSwipeOfViewXXDirects the fab to animate itself in and out on scrollPass it the name of the view to monitor for a scroll event example: hideOnSwipeOfView="userListView"
hideAnimationDurationXXHow many milliseconds it takes for the button to hide.Default if not set: 300ms
swipeAnimationXXslideDown, slideUp, slideLeft, slideRight, scaleDefault is slideDown
androidScaleTypeXcenter, centerCrop, centerInside, fitCenter, fitEnd, fitStart, fitXY, matrix for more details see Android-DocsDefault is center

iOS Notes

Running Demo Apps

npm run demo.android

// or

npm run demo.ios

Changelog

Contributors

Brad MartinSteve McNiven-ScottNathanael AndersonGabriel Marinho
Alexander VakrilovLázaro Danillo MenezesJofferson Ramirez TiquezRavi
Samuel IkechukwuStanimira Vlaeva
3.0.4

4 years ago

3.0.3

4 years ago

3.0.2

4 years ago

3.0.1

4 years ago

3.0.0

4 years ago

2.1.0

4 years ago

2.0.1

4 years ago

2.0.0

4 years ago

1.1.0

5 years ago

1.0.1

5 years ago

1.0.0

5 years ago

0.1.0

5 years ago