UNPKG

w-component-vue

Version:
432 lines (307 loc) 18.2 kB
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>WDrawer - Documentation</title> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="styles/prettify.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc.css"> <script src="scripts/nav.js" defer></script> <meta name="viewport" content="width=device-width, initial-scale=1.0"> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger" /> <label for="nav-trigger" class="navicon-button x"> <div class="navicon"></div> </label> <label for="nav-trigger" class="overlay"></label> <nav > <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-WAggridVueDyn.html">WAggridVueDyn</a></li><li><a href="module-WBadge.html">WBadge</a></li><li><a href="module-WButtonChip.html">WButtonChip</a></li><li><a href="module-WButtonCircle.html">WButtonCircle</a></li><li><a href="module-WCheckbox.html">WCheckbox</a></li><li><a href="module-WCkeditorVueDyn.html">WCkeditorVueDyn</a></li><li><a href="module-WColorPickAlpha.html">WColorPickAlpha</a></li><li><a href="module-WColorPickHexagon.html">WColorPickHexagon</a></li><li><a href="module-WColorPickHexagonGray.html">WColorPickHexagonGray</a></li><li><a href="module-WColorPickHsv.html">WColorPickHsv</a></li><li><a href="module-WColorPickHue.html">WColorPickHue</a></li><li><a href="module-WColorPickStripe.html">WColorPickStripe</a></li><li><a href="module-WColorSelect.html">WColorSelect</a></li><li><a href="module-WColorSelectInput.html">WColorSelectInput</a></li><li><a href="module-WColorSelectPanel.html">WColorSelectPanel</a></li><li><a href="module-WColorSelectPanelBlock.html">WColorSelectPanelBlock</a></li><li><a href="module-WColorSelectPanelHsva.html">WColorSelectPanelHsva</a></li><li><a href="module-WConfirm.html">WConfirm</a></li><li><a href="module-WDialog.html">WDialog</a></li><li><a href="module-WDrawer.html">WDrawer</a></li><li><a href="module-WDropfiles.html">WDropfiles</a></li><li><a href="module-WDynamicList.html">WDynamicList</a></li><li><a href="module-WEchartsVueDyn.html">WEchartsVueDyn</a></li><li><a href="module-WExplorer.html">WExplorer</a></li><li><a href="module-WGroupBaggage.html">WGroupBaggage</a></li><li><a href="module-WGroupChipCheck.html">WGroupChipCheck</a></li><li><a href="module-WGroupChipRadio.html">WGroupChipRadio</a></li><li><a href="module-WGroupDragdrop.html">WGroupDragdrop</a></li><li><a href="module-WGroupIconCheck.html">WGroupIconCheck</a></li><li><a href="module-WGroupIconRadio.html">WGroupIconRadio</a></li><li><a href="module-WGroupTags.html">WGroupTags</a></li><li><a href="module-WHighchartsBitmapDyn.html">WHighchartsBitmapDyn</a></li><li><a href="module-WHighchartsVueDyn.html">WHighchartsVueDyn</a></li><li><a href="module-WHighstockVueDyn.html">WHighstockVueDyn</a></li><li><a href="module-WIcon.html">WIcon</a></li><li><a href="module-WIconLoading.html">WIconLoading</a></li><li><a href="module-WImageCascadingDyn.html">WImageCascadingDyn</a></li><li><a href="module-WImageLazy.html">WImageLazy</a></li><li><a href="module-WImageViewerDyn.html">WImageViewerDyn</a></li><li><a href="module-WInputCheckbox.html">WInputCheckbox</a></li><li><a href="module-WInputRadio.html">WInputRadio</a></li><li><a href="module-WJsonView.html">WJsonView</a></li><li><a href="module-WLeafletVueDyn.html">WLeafletVueDyn</a></li><li><a href="module-WLevelGrade.html">WLevelGrade</a></li><li><a href="module-WListCheck.html">WListCheck</a></li><li><a href="module-WListExpand.html">WListExpand</a></li><li><a href="module-WListExpandItem.html">WListExpandItem</a></li><li><a href="module-WListHorizontal.html">WListHorizontal</a></li><li><a href="module-WListItem.html">WListItem</a></li><li><a href="module-WListRadio.html">WListRadio</a></li><li><a href="module-WListVertical.html">WListVertical</a></li><li><a href="module-WPanelAvatar.html">WPanelAvatar</a></li><li><a href="module-WPanelBulge.html">WPanelBulge</a></li><li><a href="module-WPanelDivideHorizontal.html">WPanelDivideHorizontal</a></li><li><a href="module-WPanelDivideVertical.html">WPanelDivideVertical</a></li><li><a href="module-WPanelLabelItem.html">WPanelLabelItem</a></li><li><a href="module-WPanelScale.html">WPanelScale</a></li><li><a href="module-WPanelScrolly.html">WPanelScrolly</a></li><li><a href="module-WPanelScrollyCore.html">WPanelScrollyCore</a></li><li><a href="module-WPanelStripe.html">WPanelStripe</a></li><li><a href="module-WPopup.html">WPopup</a></li><li><a href="module-WPopupEditText.html">WPopupEditText</a></li><li><a href="module-WProgressBar.html">WProgressBar</a></li><li><a href="module-WProgressCircle.html">WProgressCircle</a></li><li><a href="module-WQuillVueDyn.html">WQuillVueDyn</a></li><li><a href="module-WSegmentsVertical.html">WSegmentsVertical</a></li><li><a href="module-WShellBottomLine.html">WShellBottomLine</a></li><li><a href="module-WShellEllipse.html">WShellEllipse</a></li><li><a href="module-WSlider.html">WSlider</a></li><li><a href="module-WSwitch.html">WSwitch</a></li><li><a href="module-WTableDyn.html">WTableDyn</a></li><li><a href="module-WText.html">WText</a></li><li><a href="module-WTextCore.html">WTextCore</a></li><li><a href="module-WTextInt.html">WTextInt</a></li><li><a href="module-WTextIntCore.html">WTextIntCore</a></li><li><a href="module-WTextSelect.html">WTextSelect</a></li><li><a href="module-WTextSuggest.html">WTextSuggest</a></li><li><a href="module-WTextSuggestCore.html">WTextSuggestCore</a></li><li><a href="module-WTextarea.html">WTextarea</a></li><li><a href="module-WTextareaCore.html">WTextareaCore</a></li><li><a href="module-WThreejsVueDyn.html">WThreejsVueDyn</a></li><li><a href="module-WTimeday.html">WTimeday</a></li><li><a href="module-WTimedayCore.html">WTimedayCore</a></li><li><a href="module-WTimedayCoreRe.html">WTimedayCoreRe</a></li><li><a href="module-WTimedayRange.html">WTimedayRange</a></li><li><a href="module-WTimedayRangeCore.html">WTimedayRangeCore</a></li><li><a href="module-WTimeminute.html">WTimeminute</a></li><li><a href="module-WTimeminuteCore.html">WTimeminuteCore</a></li><li><a href="module-WTimeminuteRange.html">WTimeminuteRange</a></li><li><a href="module-WTimeminuteRangeCore.html">WTimeminuteRangeCore</a></li><li><a href="module-WTinymceVueDyn.html">WTinymceVueDyn</a></li><li><a href="module-WTooltip.html">WTooltip</a></li><li><a href="module-WTree.html">WTree</a></li><li><a href="module-WTreeIconCheckbox.html">WTreeIconCheckbox</a></li><li><a href="module-WTreeIconToggle.html">WTreeIconToggle</a></li><li><a href="module-WVditorDyn.html">WVditorDyn</a></li></ul><h3>Global</h3><ul><li><a href="global.html#binarySearch">binarySearch</a></li><li><a href="global.html#convertColor">convertColor</a></li></ul> </nav> <div id="main"> <h1 class="page-title">WDrawer</h1> <section> <header> </header> <article> <div class="container-overview"> <dl class="details"> <dt class="tag-description">Description:</dt> <dd class="tag-description"><ul class="dummy"><li></p></div></div> <h3 class="subsection-title" style="margin-top: 1em" data-jsdoc-vuejs="section-props">Props</h3> <table data-jsdoc-vuejs="table-props"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Default value</th> <th>Required?</th> <th>Description</th> </tr> </thead> <tbody><tr> <td><code>value</code></td> <td>Boolean</td> <td><code>false</code></td> <td>No</td> <td>輸入是否顯示布林值,預設false</td> </tr><tr> <td><code>mode</code></td> <td>String</td> <td><code>'from-left'</code></td> <td>No</td> <td>輸入抽屜顯示位置字串,可使用'from-left'與'from-right',預設'from-left'</td> </tr><tr> <td><code>drawerWidth</code></td> <td>Number</td> <td><code>200</code></td> <td>No</td> <td>輸入抽屜寬度數字,單位為px,預設200</td> </tr><tr> <td><code>drawerWidthMin</code></td> <td>Number</td> <td><code>null</code></td> <td>No</td> <td>輸入使用拖曳抽屜寬度分隔條(dragDrawerWidth=true)時,拖曳抽屜寬度分隔條最小值數字,預設null</td> </tr><tr> <td><code>drawerWidthMax</code></td> <td>Number</td> <td><code>null</code></td> <td>No</td> <td>輸入使用拖曳抽屜寬度分隔條(dragDrawerWidth=true)時,拖曳抽屜寬度分隔條最大值數字,預設null</td> </tr><tr> <td><code>afloat</code></td> <td>Boolean</td> <td><code>false</code></td> <td>No</td> <td>輸入是否為浮動顯示布林值,設為true時浮在內容區上故不壓縮內容區寬度,預設false</td> </tr><tr> <td><code>afloatByFix</code></td> <td>Boolean</td> <td><code>false</code></td> <td>No</td> <td>輸入浮動顯示時是否使用fixed布林值,若為true使用'fixed'反之使用'absolute',預設false</td> </tr><tr> <td><code>overlayOpacity</code></td> <td>Number</td> <td><code>0.45</code></td> <td>No</td> <td>輸入浮動顯示時抽屜外側陰影層之透明度數字,預設0.45</td> </tr><tr> <td><code>overlayColor</code></td> <td>String</td> <td><code>'grey darken-2'</code></td> <td>No</td> <td>輸入浮動顯示時抽屜外側陰影層背景顏色字串,預設'grey darken-2'</td> </tr><tr> <td><code>drawerZIndex</code></td> <td>Number</td> <td><code>1000</code></td> <td>No</td> <td>輸入浮動顯示時抽屜使用z-index數字,預設1000</td> </tr><tr> <td><code>dragDrawerWidth</code></td> <td>Boolean</td> <td><code>false</code></td> <td>No</td> <td>輸入是否使用拖曳抽屜寬度分隔條布林值,預設false</td> </tr><tr> <td><code>drawerBarColor</code></td> <td>String</td> <td><code>'#ddd'</code></td> <td>No</td> <td>輸入分隔條顏色字串,預設'#ddd'</td> </tr><tr> <td><code>drawerBarSize</code></td> <td>Number</td> <td><code>2</code></td> <td>No</td> <td>輸入分隔條尺寸數字,為分隔條寬度,單位為px,預設2</td> </tr><tr> <td><code>drawerBarBorderColor</code></td> <td>String</td> <td><code>'transparent'</code></td> <td>No</td> <td>輸入分隔條框線顏色字串,預設'transparent'</td> </tr><tr> <td><code>drawerBarBorderSize</code></td> <td>Number</td> <td><code>3</code></td> <td>No</td> <td>輸入分隔條框線寬度數字,單位為px,預設3,通常配合barBorderColor='transparent'使可拖曳區加大又不遮蔽可視區</td> </tr><tr> <td><code>autoSwitchToHide</code></td> <td>Boolean</td> <td><code>false</code></td> <td>No</td> <td>輸入是否自動切換至隱藏布林值,當抽屜顯示時且組件寬度過小時則隱藏,預設false</td> </tr><tr> <td><code>autoSwitchToFloat</code></td> <td>Boolean</td> <td><code>false</code></td> <td>No</td> <td>輸入是否自動切換至浮動布林值,當抽屜顯示時且組件寬度過小時則浮動,預設false</td> </tr><tr> <td><code>autoSwitchToShow</code></td> <td>Boolean</td> <td><code>false</code></td> <td>No</td> <td>輸入是否自動切換至顯示布林值,當抽屜隱藏時且組件寬度過大時則顯示,預設false</td> </tr><tr> <td><code>switchWidth</code></td> <td>Number</td> <td><code>340</code></td> <td>No</td> <td>輸入當自動顯隱時判斷組件寬度過小之門檻寬度數字,單位為px,預設340</td> </tr></tbody> </table> <div class="container-overview"><div><p> </li></ul></dd> </dl> <div class="description usertext"></p></div></div> <h3 class="subsection-title" style="margin-top: 1em" data-jsdoc-vuejs="section-props">Props</h3> <table data-jsdoc-vuejs="table-props"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Default value</th> <th>Required?</th> <th>Description</th> </tr> </thead> <tbody><tr> <td><code>value</code></td> <td>Boolean</td> <td><code>false</code></td> <td>No</td> <td>輸入是否顯示布林值,預設false</td> </tr><tr> <td><code>mode</code></td> <td>String</td> <td><code>'from-left'</code></td> <td>No</td> <td>輸入抽屜顯示位置字串,可使用'from-left'與'from-right',預設'from-left'</td> </tr><tr> <td><code>drawerWidth</code></td> <td>Number</td> <td><code>200</code></td> <td>No</td> <td>輸入抽屜寬度數字,單位為px,預設200</td> </tr><tr> <td><code>drawerWidthMin</code></td> <td>Number</td> <td><code>null</code></td> <td>No</td> <td>輸入使用拖曳抽屜寬度分隔條(dragDrawerWidth=true)時,拖曳抽屜寬度分隔條最小值數字,預設null</td> </tr><tr> <td><code>drawerWidthMax</code></td> <td>Number</td> <td><code>null</code></td> <td>No</td> <td>輸入使用拖曳抽屜寬度分隔條(dragDrawerWidth=true)時,拖曳抽屜寬度分隔條最大值數字,預設null</td> </tr><tr> <td><code>afloat</code></td> <td>Boolean</td> <td><code>false</code></td> <td>No</td> <td>輸入是否為浮動顯示布林值,設為true時浮在內容區上故不壓縮內容區寬度,預設false</td> </tr><tr> <td><code>afloatByFix</code></td> <td>Boolean</td> <td><code>false</code></td> <td>No</td> <td>輸入浮動顯示時是否使用fixed布林值,若為true使用'fixed'反之使用'absolute',預設false</td> </tr><tr> <td><code>overlayOpacity</code></td> <td>Number</td> <td><code>0.45</code></td> <td>No</td> <td>輸入浮動顯示時抽屜外側陰影層之透明度數字,預設0.45</td> </tr><tr> <td><code>overlayColor</code></td> <td>String</td> <td><code>'grey darken-2'</code></td> <td>No</td> <td>輸入浮動顯示時抽屜外側陰影層背景顏色字串,預設'grey darken-2'</td> </tr><tr> <td><code>drawerZIndex</code></td> <td>Number</td> <td><code>1000</code></td> <td>No</td> <td>輸入浮動顯示時抽屜使用z-index數字,預設1000</td> </tr><tr> <td><code>dragDrawerWidth</code></td> <td>Boolean</td> <td><code>false</code></td> <td>No</td> <td>輸入是否使用拖曳抽屜寬度分隔條布林值,預設false</td> </tr><tr> <td><code>drawerBarColor</code></td> <td>String</td> <td><code>'#ddd'</code></td> <td>No</td> <td>輸入分隔條顏色字串,預設'#ddd'</td> </tr><tr> <td><code>drawerBarSize</code></td> <td>Number</td> <td><code>2</code></td> <td>No</td> <td>輸入分隔條尺寸數字,為分隔條寬度,單位為px,預設2</td> </tr><tr> <td><code>drawerBarBorderColor</code></td> <td>String</td> <td><code>'transparent'</code></td> <td>No</td> <td>輸入分隔條框線顏色字串,預設'transparent'</td> </tr><tr> <td><code>drawerBarBorderSize</code></td> <td>Number</td> <td><code>3</code></td> <td>No</td> <td>輸入分隔條框線寬度數字,單位為px,預設3,通常配合barBorderColor='transparent'使可拖曳區加大又不遮蔽可視區</td> </tr><tr> <td><code>autoSwitchToHide</code></td> <td>Boolean</td> <td><code>false</code></td> <td>No</td> <td>輸入是否自動切換至隱藏布林值,當抽屜顯示時且組件寬度過小時則隱藏,預設false</td> </tr><tr> <td><code>autoSwitchToFloat</code></td> <td>Boolean</td> <td><code>false</code></td> <td>No</td> <td>輸入是否自動切換至浮動布林值,當抽屜顯示時且組件寬度過小時則浮動,預設false</td> </tr><tr> <td><code>autoSwitchToShow</code></td> <td>Boolean</td> <td><code>false</code></td> <td>No</td> <td>輸入是否自動切換至顯示布林值,當抽屜隱藏時且組件寬度過大時則顯示,預設false</td> </tr><tr> <td><code>switchWidth</code></td> <td>Number</td> <td><code>340</code></td> <td>No</td> <td>輸入當自動顯隱時判斷組件寬度過小之門檻寬度數字,單位為px,預設340</td> </tr></tbody> </table> <div class="container-overview"><div><p> </div> </div> </article> </section> </div> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Aug 12 2025 20:19:43 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme. </footer> <script>prettyPrint();</script> <script src="scripts/polyfill.js"></script> <script src="scripts/linenumber.js"></script> </body> </html>