Skip to content

Commit 836445e

Browse files
author
Daniil Merkulov
committed
docs: add examples for setting drawer size values
1 parent ded2637 commit 836445e

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,9 +99,9 @@ props will be passed to your custom drawer component.
9999
| direction | string | Yes | left | Direction to open the collage, one of: ["left", "right", "top", "bottom"]. |
100100
| dismissWhenTouchOutside | bool | Yes | true | Should the drawer be dismissed when a click is registered outside? |
101101
| fadeOpacity | number | Yes | 0.6 | Opacity of the screen outside the drawer. |
102-
| drawerScreenWidth | number/string | Yes | 80% | Width of drawer on portrait orientation. Use '%' for setting the width in relation to the screen or fixed values for absolute width |
103-
| drawerScreenWidthOnLandscape | number/string | Yes | 30% | Width of drawer on landscape orientation. Use '%' for setting the width in relation to the screen or fixed values for absolute width |
104-
| drawerScreenHeight | number/string | Yes | 100% | Height of drawer. Use '%' for setting the width in relation to the screen or fixed values for absolute width
102+
| drawerScreenWidth | number/string | Yes | 80% | Width of drawer on portrait orientation. Pass a string containing '%' (e.g. "80%") for setting the width in relation to the screen or a number for absolute width (e.g. 300) |
103+
| drawerScreenWidthOnLandscape | number/string | Yes | 30% | Width of drawer on landscape orientation. Pass a string containing '%' (e.g. "80%") for setting the width in relation to the screen or a number for absolute width (e.g. 300) |
104+
| drawerScreenHeight | number/string | Yes | 100% | Height of drawer. Pass a string containing '%' (e.g. "30%") for setting the height in relation to the screen or a number for absolute height (e.g. 300)
105105

106106
## SideMenuView
107107

lib/RNNDrawer.d.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,18 @@ declare interface RNNDrawerOptions {
3535
*/
3636
fadeOpacity?: number;
3737
/**
38-
* Width of drawer on portrait orientation. Use '%' for setting
39-
* the width in relation to the screen or fixed values for absolute width
38+
* Width of drawer on portrait orientation. Pass a string containing '%' (e.g. "80%")
39+
* for setting the width in relation to the screen or a number for absolute width (e.g. 300)
4040
*/
4141
drawerScreenWidth?: number | string;
4242
/**
43-
* Width of drawer on landscape orientation. Use '%' for setting
44-
* the width in relation to the screen or fixed values for absolute width
43+
* Width of drawer on landscape orientation. Pass a string containing '%' (e.g. "80%")
44+
* for setting the width in relation to the screen or a number for absolute width (e.g. 300)
4545
*/
4646
drawerScreenWidthOnLandscape?: number | string;
4747
/**
48-
* Height of drawer. Use '%' for setting the width
49-
* in relation to the screen or fixed values for absolute width
48+
* Height of drawer. Pass a string containing '%' (e.g. "30%")
49+
* for setting the height in relation to the screen or a number for absolute height (e.g. 300)
5050
*/
5151
drawerScreenHeight?: number | string;
5252
}

src/RNNDrawer.tsx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,20 +59,20 @@ declare interface RNNDrawerOptions {
5959
fadeOpacity?: number;
6060

6161
/**
62-
* Width of drawer on portrait orientation. Use '%' for setting
63-
* the width in relation to the screen or fixed values for absolute width
62+
* Width of drawer on portrait orientation. Pass a string containing '%' (e.g. "80%")
63+
* for setting the width in relation to the screen or a number for absolute width (e.g. 300)
6464
*/
6565
drawerScreenWidth?: number | string;
6666

6767
/**
68-
* Width of drawer on landscape orientation. Use '%' for setting
69-
* the width in relation to the screen or fixed values for absolute width
68+
* Width of drawer on landscape orientation. Pass a string containing '%' (e.g. "80%")
69+
* for setting the width in relation to the screen or a number for absolute width (e.g. 300)
7070
*/
7171
drawerScreenWidthOnLandscape?: number | string;
7272

7373
/**
74-
* Height of drawer. Use '%' for setting the width
75-
* in relation to the screen or fixed values for absolute width
74+
* Height of drawer. Pass a string containing '%' (e.g. "30%")
75+
* for setting the height in relation to the screen or a number for absolute height (e.g. 300)
7676
*/
7777
drawerScreenHeight?: number | string;
7878
}

0 commit comments

Comments
 (0)