Gathering detailed insights and metrics for @nativescript-community/ui-drawer
Gathering detailed insights and metrics for @nativescript-community/ui-drawer
NativeScript plugin that allows you to easily add a side drawer (side menu) to your projects.
Installations
npm install @nativescript-community/ui-drawerDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
20.9.0
NPM Version
lerna/3.10.1/node@v20.9.0+x64 (linux)
Score
75.3
Supply Chain
97.5
Quality
84.3
Maintenance
100
Vulnerability
100
License
Releases
59
Languages
6
TypeScript
Vue
Svelte
HTML
SCSS
JavaScript
TypeScript (60.27%)
Vue (20.25%)
Svelte (14.33%)
HTML (3.13%)
SCSS (1.39%)
JavaScript (0.63%)
Developer
Download Statistics
Total Downloads
78,787
Last Day
10
Last Week
388
Last Month
1,251
Last Year
28,921
GitHub Statistics
Apache-2.0 License
25 Stars
312 Commits
11 Forks
2 Watchers
2 Branches
16 Contributors
Updated on May 17, 2025
Bundle Size
17.18 kB
Minified
4.19 kB
Minified + Gzipped
Maintainers
20
Package Meta Information
Latest Version
0.1.29
Package Id
@nativescript-community/ui-drawer@0.1.29
Unpacked Size
159.34 kB
Size
32.63 kB
File Count
33
NPM Version
lerna/3.10.1/node@v20.9.0+x64 (linux)
Node Version
20.9.0
Published on
Dec 18, 2024
Total Downloads
Cumulative downloads
Total Downloads
78,787
Last Day
0%
10
Compared to previous day
Last Week
13.1%
388
Compared to previous week
Last Month
2%
1,251
Compared to previous month
Last Year
42%
28,921
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
@nativescript-community/ui-drawer
Easily add a side drawer (side menu) to your projects.
 |  |
|---|---|
| iOS Demo | Android Demo |
Table of Contents
- Installation
- Configuration
- API
- Usage in Angular
- Usage in React
- Usage in Svelte
- Usage in Vue
- Usage in Vue3
- Demos and Development
- Contributing
- Questions
Installation
Run the following command from the root of your project:
ns plugin add @nativescript-community/ui-drawer
Configuration
For gestures to work, make sure to add the following code block inside the main application file (e.g. app.ts):
1import { install } from '@nativescript-community/ui-drawer'; 2install();
API
Properties
| Property | Default | Type | Description |
|---|---|---|---|
| leftDrawer | undefined | View | View containing the content for the left side drawer |
| rightDrawer | undefined | View | View containing the content for the right side drawer |
| topDrawer | undefined | View | View containing the content for the top side drawer |
| bottomDrawer | undefined | View | View containing the content for the bottom side drawer |
| mainContent | undefined | View | View containing the main content of the app |
| gestureEnabled | true | boolean | Boolean setting if swipe gestures are enabled |
| backdropTapGestureEnabled | true | boolean | Allow tapping the backdrop to close the drawer |
| backdropColor | new Color('rgba(0, 0, 0, 0.7)') | Color | The color of the backdrop behind the drawer |
| leftDrawerMode | slide | Mode ('under' or 'slide') | The drawer's enter-animation behavior |
| rightDrawerMode | slide | Mode ('under' or 'slide') | The drawer's enter-animation behavior |
| gestureMinDist | 10 | number | The min "swipe" distance to trigger the menu gesture |
| gestureHandlerOptions | null | PanGestureHandlerOptions | Options to customize the pan gesture handler |
| leftSwipeDistance | 40 | number | The "left" zone size from where the gesture is recognized |
| rightSwipeDistance | 40 | number | The "right" zone size from where the gesture is recognized |
| topSwipeDistance | 40 | number | The "top" zone size from where the gesture is recognized |
| bottomSwipeDistance | 40 | number | The "bottom" zone size from where the gesture is recognized |
| leftOpenedDrawerAllowDraging | true | boolean | Allow dragging the opened menu |
| rightOpenedDrawerAllowDraging | true | boolean | Allow dragging the opened menu |
| topOpenedDrawerAllowDraging | true | boolean | Allow dragging the opened menu |
| bottomOpenedDrawerAllowDraging | true | boolean | Allow dragging the opened menu |
Methods
| Name | Return | Description |
|---|---|---|
| open() | void | Programatically open the drawer |
| close() | void | Programatically close the drawer |
| toggle() | void | Programatically toggle the state of the drawer |
| install() | void | Install gestures |
Events
| Name | Event Data | Description |
|---|---|---|
| open | side, duration | Drawer opens |
| close | side, duration | Drawer closes |
Usage in Angular
Import the module into your project.
1import { DrawerModule } from "@nativescript-community/ui-drawer/angular"; 2 3@NgModule({ 4 imports: [ 5 DrawerModule 6 ] 7 schemas: [ 8 NO_ERRORS_SCHEMA 9 ] 10}) 11 12export class AppModule { }
Examples:
- Basic Drawer
- A basic sliding drawer.
- All Sides
- An example of drawers on all sides: left, right, top, bottom.
Usage in React
Register the plugin in your app.ts.
1import DrawerElement from '@nativescript-community/ui-drawer/react'; 2DrawerElement.register();
Examples:
- Basic Drawer
- A basic sliding drawer.
- All Sides
- An example of drawers on all sides: left, right, top, bottom.
Usage in Svelte
Register the plugin in your app.ts.
1import DrawerElement from '@nativescript-community/ui-drawer/svelte'; 2DrawerElement.register();
Examples:
- Basic Drawer
- A basic sliding drawer.
- All Sides
- An example of drawers on all sides: left, right, top, bottom.
Usage in Vue
Register the plugin in your app.js.
1import DrawerPlugin from '@nativescript-community/ui-drawer/vue' 2Vue.use(DrawerPlugin);
Examples:
- Basic Drawer
- A basic sliding drawer.
- All Sides
- An example of drawers on all sides: left, right, top, bottom.
Usage in Vue3
Register the plugin in your app.js.
1import DrawerPlugin from '@nativescript-community/ui-drawer/vue3' 2 3app.use(DrawerPlugin);
Examples:
- Basic Drawer
- A basic sliding drawer.
- All Sides
- An example of drawers on all sides: left, right, top, bottom.
Demos and Development
Repo Setup
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.
Build
1npm 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
Demos
1npm run demo.[ng|react|svelte|vue].[ios|android] 2 3npm 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
Contributing
Update repo
You can update the repo files quite easily
First update the submodules
1npm run update
Then commit the changes Then update common files
1npm run sync
Then you can run yarn|pnpm, commit changed files if any
Update readme
1npm run readme
Update doc
1npm run doc
Publish
The publishing is completely handled by lerna (you can add -- --bump major to force a major release)
Simply run
1npm run publish
modifying submodules
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/
Questions
If you have any questions/issues/comments please feel free to create an issue or start a conversation in the NativeScript Community Discord.
Demos and Development
Repo Setup
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.
Build
1npm 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
Demos
1npm run demo.[ng|react|svelte|vue].[ios|android] 2 3npm 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
Contributing
Update repo
You can update the repo files quite easily
First update the submodules
1npm run update
Then commit the changes Then update common files
1npm run sync
Then you can run yarn|pnpm, commit changed files if any
Update readme
1npm run readme
Update doc
1npm run doc
Publish
The publishing is completely handled by lerna (you can add -- --bump major to force a major release)
Simply run
1npm run publish
modifying submodules
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/
Questions
If you have any questions/issues/comments please feel free to create an issue or start a conversation in the NativeScript Community Discord.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/release.yml:1
- Info: no jobLevel write permissions found
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
no SAST tool detected
Details
- Warn: no pull requests merged into dev branch
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/nativescript-community/ui-drawer/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/nativescript-community/ui-drawer/release.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/nativescript-community/ui-drawer/release.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/nativescript-community/ui-drawer/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/nativescript-community/ui-drawer/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:68: update your workflow using https://app.stepsecurity.io/secureworkflow/nativescript-community/ui-drawer/release.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:80: update your workflow using https://app.stepsecurity.io/secureworkflow/nativescript-community/ui-drawer/release.yml/master?enable=pin
- Info: 0 out of 4 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 3 third-party GitHubAction dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
56 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-x4c5-c7rf-jjgv
- Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q
- Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38
- Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc
- Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-p7v2-p9m8-qqg7
- Warn: Project is vulnerable to: GHSA-7x97-j373-85x5
- Warn: Project is vulnerable to: GHSA-7m48-wc93-9g85
- Warn: Project is vulnerable to: GHSA-qqvq-6xgj-jw8g
- Warn: Project is vulnerable to: GHSA-67mh-4wv8-2f99
- Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
- Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
- Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
- Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
- Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
- Warn: Project is vulnerable to: GHSA-4www-5p9h-95mh
- Warn: Project is vulnerable to: GHSA-9gqv-wp59-fq42
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
- Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
- Warn: Project is vulnerable to: GHSA-76p7-773f-r4q5
- Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
- Warn: Project is vulnerable to: GHSA-8266-84wp-wv5c
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-c76h-2ccp-4975
- Warn: Project is vulnerable to: GHSA-cxrh-j4jr-qwg3
- Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986 / GHSA-64vr-g452-qvp3
- Warn: Project is vulnerable to: GHSA-9cwx-2883-4wfx
- Warn: Project is vulnerable to: GHSA-vg6x-rcgg-rjx6
- Warn: Project is vulnerable to: GHSA-x574-m823-4x7w
- Warn: Project is vulnerable to: GHSA-4r4m-qw57-chr8
- Warn: Project is vulnerable to: GHSA-xcj6-pq6g-qj4x
- Warn: Project is vulnerable to: GHSA-356w-63v5-8wf4
- Warn: Project is vulnerable to: GHSA-859w-5945-r5v3
- Warn: Project is vulnerable to: GHSA-5j4c-8p2g-v4jx
- Warn: Project is vulnerable to: GHSA-hc6q-2mpp-qw7j
- Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
- Warn: Project is vulnerable to: GHSA-4v9v-hfq4-rm2v
- Warn: Project is vulnerable to: GHSA-9jgg-88mc-972h
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Score
2.5
/10
Last Scanned on 2025-06-16
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More