@nativescript-community/ui-persistent-bottomsheet
    Preparing search index...

    @nativescript-community/ui-persistent-bottomsheet

    @nativescript-community/ui-persistent-bottomsheet

    Downloads per month NPM Version

    NativeScript plugin that allows you to easily add a persistent bottomsheet to your projects.
    iOS Demo Android Demo

    Run the following command from the root of your project:

    ns plugin add @nativescript-community/ui-persistent-bottomsheet

    For gestures to work, make sure to add the following code block inside the main application file (e.g. app.ts):

    import { install } from '@nativescript-community/ui-persistent-bottomsheet';
    install();

    Property Default Type Description
    bottomSheet undefined View View containing the content for the bottomsheet
    gestureEnabled true boolean Boolean setting if swipe gestures are enabled
    stepIndex 0 number the index of current step (mutable)
    steps [70] number[] the different available steps
    backdropColor new Color('rgba(0, 0, 0, 0.7)') Color The color of the backdrop behind the drawer
    Name Return Description
    install() void Install gestures

    Import the module into your project.

    import { PBSModule } from "@nativescript-community/ui-persistent-bottomsheet/angular";

    @NgModule({
        imports: [
            PBSModule
        ]
        schemas: [
            NO_ERRORS_SCHEMA
        ]
    })

    export class AppModule { }

    Then in your component add the following:

    For a more complete example, look in the demo-ng directory.

    Register the plugin in your app.js.

    import BottomSheetPlugin from '@nativescript-community/ui-persistent-bottomsheet/vue';
    Vue.use(BottomSheetPlugin);

    Add this at the top of your webpack config file:

    const NsVueTemplateCompiler = require('nativescript-vue-template-compiler');

    NsVueTemplateCompiler.registerElement('BottomSheet', () => require('@nativescript-community/ui-persistent-bottomsheet').BottomSheet, {
        model: {
            prop: 'stepIndex',
            event: 'stepIndexChange'
        }
    });

    Then in your component add the following:

    For a more complete example, look in the demo-vue directory.

    Register the plugin in your app.ts.

    import BottomSheetElement from '@nativescript-community/ui-persistent-bottomsheet/svelte';
    BottomSheetElement.register();

    Then in your component, add the following:

    For a more complete example, look in the demo-svelte directory.

    Register the plugin in your app.ts.

    import BottomSheetElement from '@nativescript-community/ui-persistent-bottomsheet/react';
    BottomSheetElement.register();

    Then in your component, add the following:

    import { BottomSheet } from "@nativescript-community/ui-persistent-bottomsheet/react"

    For a more complete example, look in the demo-react directory.

    This repository includes Angular, Vue.js, and Svelte demos. In order to run these execute the following in your shell:

    $ git clone https://github.com/@nativescript-community/ui-persistent-bottomsheet
    $ cd ui-drawer
    $ npm run i
    $ npm run setup
    $ npm run build && npm run build.angular
    $ cd demo-ng # or demo-vue or demo-svelte or demo-react
    $ ns run ios|android

    The repo uses submodules. If you did not clone with --recursive then you need to call

    git submodule update --init

    The package manager used to install and link dependencies must be pnpm or yarn. npm wont work.

    To develop and test: if you use yarn then run yarn if you use pnpm then run pnpm i

    Interactive Menu:

    To start the interactive menu, run npm start (or yarn start or pnpm start). This will list all of the commonly used scripts.

    npm run build.all

    WARNING: it seems yarn build.all wont always work (not finding binaries in node_modules/.bin) which is why the doc explicitly uses npm run

    npm run demo.[ng|react|svelte|vue].[ios|android]

    npm run demo.svelte.ios # Example

    Demo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in demo-[ng|react|svelte|vue] Instead you work in demo-snippets/[ng|react|svelte|vue] You can start from the install.ts of each flavor to see how to register new demos

    You can update the repo files quite easily

    First update the submodules

    npm run update

    Then commit the changes Then update common files

    npm run sync

    Then you can run yarn|pnpm, commit changed files if any

    npm run readme

    npm run doc

    The publishing is completely handled by lerna (you can add -- --bump major to force a major release) Simply run

    npm run publish

    The repo uses https:// for submodules which means you won't be able to push directly into the submodules. One easy solution is t modify ~/.gitconfig and add

    [url "ssh://git@github.com/"]
    	pushInsteadOf = https://github.com/

    If you have any questions/issues/comments please feel free to create an issue or start a conversation in the NativeScript Community Discord.

    The repo uses submodules. If you did not clone with --recursive then you need to call

    git submodule update --init

    The package manager used to install and link dependencies must be pnpm or yarn. npm wont work.

    To develop and test: if you use yarn then run yarn if you use pnpm then run pnpm i

    Interactive Menu:

    To start the interactive menu, run npm start (or yarn start or pnpm start). This will list all of the commonly used scripts.

    npm run build.all

    WARNING: it seems yarn build.all wont always work (not finding binaries in node_modules/.bin) which is why the doc explicitly uses npm run

    npm run demo.[ng|react|svelte|vue].[ios|android]

    npm run demo.svelte.ios # Example

    Demo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in demo-[ng|react|svelte|vue] Instead you work in demo-snippets/[ng|react|svelte|vue] You can start from the install.ts of each flavor to see how to register new demos

    You can update the repo files quite easily

    First update the submodules

    npm run update

    Then commit the changes Then update common files

    npm run sync

    Then you can run yarn|pnpm, commit changed files if any

    npm run readme

    npm run doc

    The publishing is completely handled by lerna (you can add -- --bump major to force a major release) Simply run

    npm run publish

    The repo uses https:// for submodules which means you won't be able to push directly into the submodules. One easy solution is t modify ~/.gitconfig and add

    [url "ssh://git@github.com/"]
    	pushInsteadOf = https://github.com/

    If you have any questions/issues/comments please feel free to create an issue or start a conversation in the NativeScript Community Discord.

    Settings

    Member Visibility

    On This Page

    Table of ContentsInstallationConfigurationAPIUsage in AngularUsage in VueUsage in SvelteUsage in ReactDemosDemos and DevelopmentContributingQuestionsDemos and DevelopmentContributingQuestions