Skip to content

Commit 16928da

Browse files
Updating docs
1 parent de6cb20 commit 16928da

File tree

2 files changed

+19
-39
lines changed

2 files changed

+19
-39
lines changed

Diff for: src/App.vue

+7-27
Original file line numberDiff line numberDiff line change
@@ -74,31 +74,7 @@
7474
<!-- ====================================================== Navigation Drawer -->
7575
<VResizeDrawer
7676
v-model="drawer"
77-
:absolute="drawerOptions.absolute"
78-
:color="drawerOptions.color"
79-
:dark="drawerOptions.dark"
80-
:elevation="drawerOptions.elevation"
81-
:expand-on-hover="drawerOptions.expandOnHover"
82-
:floating="drawerOptions.floating"
83-
:handle-border-width="drawerOptions.handleBorderWidth"
84-
:handle-color="drawerOptions.handleColor"
85-
:handle-position="drawerOptions.handlePosition"
86-
:image="drawerOptions.image"
87-
:location="drawerOptions.location === 'left' ? 'left' : 'right'"
88-
max-width="50%"
89-
min-width="256"
90-
:rail="drawerOptions.rail"
91-
:rail-width="drawerOptions.railWidth"
92-
:resizable="drawerOptions.resizable"
93-
:save-width="drawerOptions.saveWidth"
94-
:sticky="drawerOptions.sticky"
95-
:storage-name="drawerOptions.storageName"
96-
:storage-type="drawerOptions.storageType"
97-
:tag="drawerOptions.tag"
98-
:temporary="drawerOptions.temporary"
99-
:theme="drawerOptions.theme"
100-
:touchless="drawerOptions.touchless"
101-
:width="drawerOptions.width"
77+
v-bind="drawerOptions"
10278
@close="drawerClose"
10379
@handle:click="handleClick"
10480
@handle:dblclick="handleDoubleClick"
@@ -196,11 +172,15 @@ const drawerOptions = ref({
196172
dark: true,
197173
elevation: 10,
198174
expandOnHover: true,
199-
floating: false,
175+
floating: true,
200176
handleBorderWidth: 8,
201177
handleColor: 'primary',
202178
handlePosition: 'center',
203179
location: 'left',
180+
maxHeight: "50%",
181+
maxWidth: "50%",
182+
minHeight: "256",
183+
minWidth: "256",
204184
rail: false,
205185
railWidth: 56,
206186
resizable: true,
@@ -223,8 +203,8 @@ const gridDrawerOptions = ref({
223203
maxWidth: '100%',
224204
minWidth: '256px',
225205
saveWidth: false,
206+
snapBack: true,
226207
temporary: true,
227-
widthSnapBack: true,
228208
});
229209
const gridDrawerWidth = ref('256px');
230210
const computedWidth = ref(gridDrawerWidth.value);

Diff for: src/documentation/sections/PropsSection.vue

+12-12
Original file line numberDiff line numberDiff line change
@@ -435,15 +435,15 @@ const propsSupported = reactive({
435435
},
436436
{
437437
default: 'center',
438-
desc: 'Specifies the position of the handle. Valid values are <code class="ic">border</code>, <code class="ic">center</code>, <code class="ic">top</code>, <code class="ic">bottom</code>.',
438+
desc: 'Specifies the position of the handle. Valid values are <code class="ic">border</code>, <code class="ic">center</code>, <code class="ic">top</code>, <code class="ic">bottom</code>. If <code class="ic">location</code> prop is set to <code class="ic">top</code> or <code class="ic">bottom</code>, the handle position <code class="ic">top</code> and <code class="ic">bottom</code> are not allowed.',
439439
name: 'handle-position',
440-
type: 'string',
440+
type: "'bottom' | 'border' | 'center' | 'top'",
441441
},
442442
{
443443
default: 'start',
444-
desc: 'Places the navigation drawer position on the the screen. *<code class="ic">top</code> and <code class="ic">bottom</code> are not supported',
444+
desc: 'Places the navigation drawer position on the the screen.',
445445
name: 'location',
446-
type: 'string',
446+
type: "'bottom' | 'end' | 'start' | 'left' | 'right' | 'top' | undefined",
447447
},
448448
{
449449
default: '100%',
@@ -469,30 +469,30 @@ const propsSupported = reactive({
469469
name: 'save-width',
470470
type: 'boolean',
471471
},
472+
{
473+
default: 'true',
474+
desc: 'Determines if the width or height of the navigation drawer should snap back if the <code class="ic">min-width</code>, <code class="ic">max-width</code>, <code class="ic">min-height</code> or <code class="ic">max-height</code> prop values pass their respective thresholds. (previously <code class="ic">width-snap-back</code>. Backwards compatible)',
475+
name: 'snap-back',
476+
type: 'boolean',
477+
},
472478
{
473479
default: 'v-resize-drawer-width',
474-
desc: 'Determines the name of the local/session storage item',
480+
desc: 'Determines the name of the local/session storage item. The value is appended with the <code class="ic">location</code> prop value.',
475481
name: 'storage-name',
476482
type: 'string',
477483
},
478484
{
479485
default: 'local',
480486
desc: 'Determines the type of storage to use when the <code class="ic">save-width</code> is <code class="ic">true</code>. Valid values are <code class="ic">local</code> and <code class="ic">session</code>',
481487
name: 'storage-type',
482-
type: 'string',
488+
type: "'local' | 'session'",
483489
},
484490
{
485491
default: 'false',
486492
desc: 'Hides the resize handle on mobile devices. <br /><span class="text-danger">*</span> The <code class="ic">touchless</code> prop does not function the same as the <code class="ic">v-navigation-drawer</code> prop which is not supported',
487493
name: 'touchless',
488494
type: 'boolean',
489495
},
490-
{
491-
default: 'true',
492-
desc: 'Determines if the width of he navigation drawer should snap back if the <code class="ic">min-width</code> or <code class="ic">max-width</code> prop values pass their respective thresholds',
493-
name: 'width-snap-back',
494-
type: 'boolean',
495-
},
496496
],
497497
});
498498
const propsNotSupported = reactive({

0 commit comments

Comments
 (0)