Skip to content

Commit 9f47766

Browse files
committed
Merge branch 'master' of github.com:nativescript-community/ui-drawer into feature/swipe-menu
# Conflicts: # README.md # yarn.lock
2 parents e0f4ea4 + ed46f20 commit 9f47766

File tree

16 files changed

+4433
-2279
lines changed

16 files changed

+4433
-2279
lines changed

.gitmodules

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,6 @@
1313
[submodule "demo-vue"]
1414
path = demo-vue
1515
url = https://github.com/nativescript-community/plugin-seed-demo-vue.git
16+
[submodule "demo-vue3"]
17+
path = demo-vue3
18+
url = https://github.com/nativescript-community/plugin-seed-demo-vue3

README.md

Lines changed: 136 additions & 102 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
1-
<!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️--><!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️-->
1+
<!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️-->This monorepo contains multiple packages:<br><br><details>
2+
<summary><b>demo-snippets</b></summary>
3+
{{ load:packages/demo-snippets/README.md }}
4+
</details><details>
5+
<summary><b>src</b></summary>
6+
{{ load:packages/src/README.md }}
7+
</details><details>
8+
<summary><b>ui-drawer</b></summary>
9+
<!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️-->
210
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
311
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
412
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@@ -20,7 +28,7 @@
2028
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
2129
<h1 align="center">@nativescript-community/ui-drawer</h1>
2230
<p align="center">
23-
<a href="https://npmcharts.com/compare/@nativescript-community/ui-drawer?minimal=true"><img alt="Downloads per month" src="https://img.shields.io/npm/dm/@nativescript-community/ui-drawer.svg" height="20"/></a>
31+
<a href="https://npmcharts.com/compare/@nativescript-community/ui-drawer?minimal=true"><img alt="Downloads per month" src="https://img.shields.io/npm/dm/@nativescript-community/ui-drawer.svg" height="20"/></a>
2432
<a href="https://www.npmjs.com/package/@nativescript-community/ui-drawer"><img alt="NPM Version" src="https://img.shields.io/npm/v/@nativescript-community/ui-drawer.svg" height="20"/></a>
2533
</p>
2634

@@ -36,57 +44,59 @@
3644
| --- | ----------- |
3745
| iOS Demo | Android Demo |
3846

39-
40-
[](#table-of-contents)
41-
42-
43-
[](#table-of-contents)
44-
47+
48+
[](#table-of-contents)
49+
50+
51+
[](#table-of-contents)
52+
4553
## Table of Contents
4654

47-
* [Installation](#installation)
48-
* [Configuration](#configuration)
49-
* [API](#api)
50-
* [Properties](#properties)
51-
* [Methods](#methods)
52-
* [Events](#events)
53-
* [Usage in Angular](#usage-in-angular)
54-
* [Examples:](#examples)
55-
* [Usage in React](#usage-in-react)
56-
* [Examples:](#examples-1)
57-
* [Usage in Svelte](#usage-in-svelte)
58-
* [Examples:](#examples-2)
59-
* [Usage in Vue](#usage-in-vue)
60-
* [Examples:](#examples-3)
61-
* [Demos and Development](#demos-and-development)
62-
* [Repo Setup](#repo-setup)
63-
* [Build](#build)
64-
* [Demos](#demos)
65-
* [Contributing](#contributing)
66-
* [Update repo ](#update-repo-)
67-
* [Update readme ](#update-readme-)
68-
* [Update doc ](#update-doc-)
69-
* [Publish](#publish)
70-
* [modifying submodules](#modifying-submodules)
55+
* [Installation](#installation)
56+
* [Configuration](#configuration)
57+
* [API](#api)
58+
* [Properties](#properties)
59+
* [Methods](#methods)
60+
* [Events](#events)
61+
* [Usage in Angular](#usage-in-angular)
62+
* [Examples:](#examples)
63+
* [Usage in React](#usage-in-react)
64+
* [Examples:](#examples-1)
65+
* [Usage in Svelte](#usage-in-svelte)
66+
* [Examples:](#examples-2)
67+
* [Usage in Vue](#usage-in-vue)
68+
* [Examples:](#examples-3)
69+
* [Usage in Vue3](#usage-in-vue3)
70+
* [Examples:](#examples-4)
71+
* [Demos and Development](#demos-and-development)
72+
* [Repo Setup](#repo-setup)
73+
* [Build](#build)
74+
* [Demos](#demos)
75+
* [Contributing](#contributing)
76+
* [Update repo ](#update-repo-)
77+
* [Update readme ](#update-readme-)
78+
* [Update doc ](#update-doc-)
79+
* [Publish](#publish)
80+
* [modifying submodules](#modifying-submodules)
7181
* [Questions](#questions)
7282

73-
74-
[](#installation)
75-
76-
77-
[](#installation)
78-
83+
84+
[](#installation)
85+
86+
87+
[](#installation)
88+
7989
## Installation
8090
Run the following command from the root of your project:
8191

8292
`ns plugin add @nativescript-community/ui-drawer`
8393

84-
85-
[](#configuration)
86-
87-
88-
[](#configuration)
89-
94+
95+
[](#configuration)
96+
97+
98+
[](#configuration)
99+
90100
## Configuration
91101
For gestures to work, make sure to add the following code block inside the main application file (e.g. app.ts):
92102

@@ -95,12 +105,12 @@ import { install } from '@nativescript-community/ui-drawer';
95105
install();
96106
```
97107

98-
99-
[](#api)
100-
101-
102-
[](#api)
103-
108+
109+
[](#api)
110+
111+
112+
[](#api)
113+
104114
## API
105115

106116
### Properties
@@ -146,12 +156,12 @@ install();
146156
| open | `side`, `duration` | Drawer opens |
147157
| close | `side`, `duration` | Drawer closes |
148158

149-
150-
[](#usage-in-angular)
151-
152-
153-
[](#usage-in-angular)
154-
159+
160+
[](#usage-in-angular)
161+
162+
163+
[](#usage-in-angular)
164+
155165
## Usage in Angular
156166
Import the module into your project.
157167

@@ -178,12 +188,12 @@ export class AppModule { }
178188
- An example of drawers on all sides: left, right, top, bottom.
179189

180190

181-
182-
[](#usage-in-react)
183-
184-
185-
[](#usage-in-react)
186-
191+
192+
[](#usage-in-react)
193+
194+
195+
[](#usage-in-react)
196+
187197
## Usage in React
188198

189199
Register the plugin in your `app.ts`.
@@ -200,12 +210,12 @@ DrawerElement.register();
200210
- [All Sides](demo-snippets/react/AllSides.tsx)
201211
- An example of drawers on all sides: left, right, top, bottom.
202212

203-
204-
[](#usage-in-svelte)
205-
206-
207-
[](#usage-in-svelte)
208-
213+
214+
[](#usage-in-svelte)
215+
216+
217+
[](#usage-in-svelte)
218+
209219
## Usage in Svelte
210220

211221
Register the plugin in your `app.ts`.
@@ -222,12 +232,12 @@ DrawerElement.register();
222232
- [All Sides](demo-snippets/svelte/AllSides.svelte)
223233
- An example of drawers on all sides: left, right, top, bottom.
224234

225-
226-
[](#usage-in-vue)
227-
228-
229-
[](#usage-in-vue)
230-
235+
236+
[](#usage-in-vue)
237+
238+
239+
[](#usage-in-vue)
240+
231241
## Usage in Vue
232242

233243
Register the plugin in your `app.js`.
@@ -244,12 +254,35 @@ Vue.use(DrawerPlugin);
244254
- [All Sides](demo-snippets/vue/AllSides.vue)
245255
- An example of drawers on all sides: left, right, top, bottom.
246256

247-
248-
[](#demos-and-development)
249-
250-
251-
[](#demos-and-development)
252-
257+
258+
[](#usage-in-vue3)
259+
260+
261+
[](#usage-in-vue3)
262+
263+
## Usage in Vue3
264+
265+
Register the plugin in your `app.js`.
266+
267+
```typescript
268+
import DrawerPlugin from '@nativescript-community/ui-drawer/vue3'
269+
270+
app.use(DrawerPlugin);
271+
```
272+
273+
### Examples:
274+
275+
- [Basic Drawer](demo-snippets/vue3/BasicDrawer.vue)
276+
- A basic sliding drawer.
277+
- [All Sides](demo-snippets/vue3/AllSides.vue)
278+
- An example of drawers on all sides: left, right, top, bottom.
279+
280+
281+
[](#demos-and-development)
282+
283+
284+
[](#demos-and-development)
285+
253286
## Demos and Development
254287

255288

@@ -289,12 +322,12 @@ Demo setup is a bit special in the sense that if you want to modify/add demos yo
289322
Instead you work in `demo-snippets/[ng|react|svelte|vue]`
290323
You can start from the `install.ts` of each flavor to see how to register new demos
291324

292-
293-
[](#contributing)
294-
295-
296-
[](#contributing)
297-
325+
326+
[](#contributing)
327+
328+
329+
[](#contributing)
330+
298331
## Contributing
299332

300333
### Update repo
@@ -342,18 +375,19 @@ One easy solution is t modify `~/.gitconfig` and add
342375
pushInsteadOf = https://github.com/
343376
```
344377

345-
346-
[](#questions)
347-
348-
349-
[](#questions)
350-
378+
379+
[](#questions)
380+
381+
382+
[](#questions)
383+
351384
## Questions
352385

353386
If you have any questions/issues/comments please feel free to create an issue or start a conversation in the [NativeScript Community Discord](https://nativescript.org/discord).
354-
355-
[](#demos-and-development)
356-
387+
388+
389+
[](#demos-and-development)
390+
357391
## Demos and Development
358392

359393

@@ -393,9 +427,9 @@ Demo setup is a bit special in the sense that if you want to modify/add demos yo
393427
Instead you work in `demo-snippets/[ng|react|svelte|vue]`
394428
You can start from the `install.ts` of each flavor to see how to register new demos
395429

396-
397-
[](#contributing)
398-
430+
431+
[](#contributing)
432+
399433
## Contributing
400434

401435
### Update repo
@@ -442,9 +476,9 @@ One easy solution is t modify `~/.gitconfig` and add
442476
[url "ssh://[email protected]/"]
443477
pushInsteadOf = https://github.com/
444478
```
445-
446-
[](#questions)
447-
479+
480+
[](#questions)
481+
448482
## Questions
449483

450-
If you have any questions/issues/comments please feel free to create an issue or start a conversation in the [NativeScript Community Discord](https://nativescript.org/discord).
484+
If you have any questions/issues/comments please feel free to create an issue or start a conversation in the [NativeScript Community Discord](https://nativescript.org/discord).

0 commit comments

Comments
 (0)