Skip to content

Commit 4c39461

Browse files
authored
Merge pull request #3 from kevinboosten/master
docs: update info about how to run the demo
2 parents 116efd4 + 20b314b commit 4c39461

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

README.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ NativeScript plugin that allows you to easily add persistent bottomsheet to your
77
[![npm downloads](https://img.shields.io/npm/dt/@nativescript-community/ui-persistent-bottomsheet.svg)](https://www.npmjs.com/package/@nativescript-community/ui-persistent-bottomsheet)
88

99
---
10+
1011
## Table of Contents
12+
1113
1. [Installation](#installation)
1214
2. [Configuration](#configuration)
1315
3. [API](#api)
@@ -24,6 +26,7 @@ ns plugin add @nativescript-community/ui-persistent-bottomsheet
2426
```
2527

2628
## Configuration
29+
2730
For gestures to work, make sure to add the following code block inside the main application file (e.g. app.ts):
2831

2932
```typescript
@@ -43,15 +46,14 @@ install();
4346
| steps | `[70]` | `number[]` | the different available steps |
4447
| backdropColor | `new Color('rgba(0, 0, 0, 0.7)')` | `Color` | The color of the backdrop behind the drawer |
4548

46-
47-
4849
### Methods
4950

5051
| Name | Return | Description |
5152
| ------------ | ------ | ----------------------------------------------- |
5253
| install() | `void` | Install gestures |
5354

5455
## Usage in Angular
56+
5557
Import the module into your project.
5658

5759
```typescript
@@ -83,6 +85,7 @@ Then in your component add the following:
8385

8486
</BottomSheet>
8587
```
88+
8689
For a more complete example, look in the `demo-ng` directory.
8790

8891
## Usage in Vue
@@ -107,6 +110,7 @@ Then in your component add the following:
107110

108111
</BottomSheet>
109112
```
113+
110114
For a more complete example, look in the `demo-vue` directory.
111115

112116
## Usage in Svelte
@@ -131,6 +135,7 @@ Then in your component, add the following:
131135

132136
</bottomsheet>
133137
```
138+
134139
For a more complete example, look in the `demo-svelte` directory.
135140

136141
## Usage in React
@@ -143,6 +148,7 @@ BottomSheetElement.register();
143148
```
144149

145150
Then in your component, add the following:
151+
146152
```ts
147153
import { BottomSheet } from "@nativescript-community/ui-persistent-bottomsheet/react"
148154
```
@@ -158,16 +164,19 @@ import { BottomSheet } from "@nativescript-community/ui-persistent-bottomsheet/r
158164

159165
</BottomSheet>
160166
```
167+
161168
For a more complete example, look in the `demo-react` directory.
162169

163170
## Demos
171+
164172
This repository includes Angular, Vue.js, and Svelte demos. In order to run these execute the following in your shell:
173+
165174
```shell
166-
$ git clone https://github.com/@nativescript-community/ui-persistent-bottomsheet
167-
$ cd ui-drawer
168-
$ npm run i
169-
$ npm run setup
170-
$ npm run build && npm run build.angular
171-
$ cd demo-ng # or demo-vue or demo-svelte or demo-react
172-
$ ns run ios|android
173-
```
175+
git clone https://github.com/nativescript-community/ui-persistent-bottomsheet
176+
cd ui-persistent-bottomsheet
177+
npm i
178+
npm run setup
179+
npm run build && npm run build.angular
180+
cd demo-ng # or demo-vue or demo-svelte or demo-react
181+
ns run ios|android # or run `npx nativescript run ios|android` when you do not have nativescript installed globally
182+
```

0 commit comments

Comments
 (0)