quasar 2.15.2 → 2.15.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api/AddressbarColor.json +1 -1
- package/dist/api/AppFullscreen.json +1 -1
- package/dist/api/BottomSheet.json +1 -1
- package/dist/api/Cookies.json +1 -1
- package/dist/api/Dark.json +1 -1
- package/dist/api/Dialog.json +1 -1
- package/dist/api/IconSet.json +1 -0
- package/dist/api/Lang.json +1 -1
- package/dist/api/Loading.json +1 -1
- package/dist/api/LoadingBar.json +1 -1
- package/dist/api/LocalStorage.json +1 -1
- package/dist/api/Morph.json +1 -1
- package/dist/api/Notify.json +1 -1
- package/dist/api/Platform.json +1 -1
- package/dist/api/QAjaxBar.json +1 -1
- package/dist/api/QBreadcrumbsEl.json +1 -1
- package/dist/api/QBtn.json +1 -1
- package/dist/api/QBtnDropdown.json +1 -1
- package/dist/api/QBtnToggle.json +1 -1
- package/dist/api/QCard.json +1 -1
- package/dist/api/QCardSection.json +1 -1
- package/dist/api/QCarousel.json +1 -1
- package/dist/api/QCarouselControl.json +1 -1
- package/dist/api/QCheckbox.json +1 -1
- package/dist/api/QChip.json +1 -1
- package/dist/api/QDate.json +1 -1
- package/dist/api/QDialog.json +1 -1
- package/dist/api/QDrawer.json +1 -1
- package/dist/api/QEditor.json +1 -1
- package/dist/api/QExpansionItem.json +1 -1
- package/dist/api/QFab.json +1 -1
- package/dist/api/QFabAction.json +1 -1
- package/dist/api/QField.json +1 -1
- package/dist/api/QFile.json +1 -1
- package/dist/api/QForm.json +1 -1
- package/dist/api/QFormChildMixin.json +1 -1
- package/dist/api/QIcon.json +1 -1
- package/dist/api/QInfiniteScroll.json +1 -1
- package/dist/api/QInput.json +1 -1
- package/dist/api/QIntersection.json +1 -1
- package/dist/api/QItem.json +1 -1
- package/dist/api/QList.json +1 -1
- package/dist/api/QMenu.json +1 -1
- package/dist/api/QNoSsr.json +1 -1
- package/dist/api/QOptionGroup.json +1 -1
- package/dist/api/QPageScroller.json +1 -1
- package/dist/api/QPageSticky.json +1 -1
- package/dist/api/QPagination.json +1 -1
- package/dist/api/QParallax.json +1 -1
- package/dist/api/QPopupEdit.json +1 -1
- package/dist/api/QPopupProxy.json +1 -1
- package/dist/api/QPullToRefresh.json +1 -1
- package/dist/api/QRadio.json +1 -1
- package/dist/api/QRating.json +1 -1
- package/dist/api/QResizeObserver.json +1 -1
- package/dist/api/QScrollArea.json +1 -1
- package/dist/api/QScrollObserver.json +1 -1
- package/dist/api/QSelect.json +1 -1
- package/dist/api/QSkeleton.json +1 -1
- package/dist/api/QSlideItem.json +1 -1
- package/dist/api/QSplitter.json +1 -1
- package/dist/api/QStepper.json +1 -1
- package/dist/api/QTabPanel.json +1 -1
- package/dist/api/QTabPanels.json +1 -1
- package/dist/api/QTable.json +1 -1
- package/dist/api/QTime.json +1 -1
- package/dist/api/QTimelineEntry.json +1 -1
- package/dist/api/QToggle.json +1 -1
- package/dist/api/QTooltip.json +1 -1
- package/dist/api/QTree.json +1 -1
- package/dist/api/QUploader.json +1 -1
- package/dist/api/QVirtualScroll.json +1 -1
- package/dist/api/Ripple.json +1 -1
- package/dist/api/Screen.json +1 -1
- package/dist/api/ScrollFire.json +1 -1
- package/dist/api/SessionStorage.json +1 -1
- package/dist/icon-set/bootstrap-icons.umd.prod.js +2 -2
- package/dist/icon-set/eva-icons.umd.prod.js +2 -2
- package/dist/icon-set/fontawesome-v5-pro.umd.prod.js +2 -2
- package/dist/icon-set/fontawesome-v5.umd.prod.js +2 -2
- package/dist/icon-set/fontawesome-v6-pro.umd.prod.js +2 -2
- package/dist/icon-set/fontawesome-v6.umd.prod.js +2 -2
- package/dist/icon-set/ionicons-v4.umd.prod.js +2 -2
- package/dist/icon-set/line-awesome.umd.prod.js +2 -2
- package/dist/icon-set/material-icons-outlined.umd.prod.js +2 -2
- package/dist/icon-set/material-icons-round.umd.prod.js +2 -2
- package/dist/icon-set/material-icons-sharp.umd.prod.js +2 -2
- package/dist/icon-set/material-icons.umd.prod.js +2 -2
- package/dist/icon-set/material-symbols-outlined.umd.prod.js +2 -2
- package/dist/icon-set/material-symbols-rounded.umd.prod.js +2 -2
- package/dist/icon-set/material-symbols-sharp.umd.prod.js +2 -2
- package/dist/icon-set/mdi-v3.umd.prod.js +2 -2
- package/dist/icon-set/mdi-v4.umd.prod.js +2 -2
- package/dist/icon-set/mdi-v5.umd.prod.js +2 -2
- package/dist/icon-set/mdi-v6.umd.prod.js +2 -2
- package/dist/icon-set/mdi-v7.umd.prod.js +2 -2
- package/dist/icon-set/svg-bootstrap-icons.umd.prod.js +2 -2
- package/dist/icon-set/svg-eva-icons.umd.prod.js +2 -2
- package/dist/icon-set/svg-fontawesome-v5.umd.prod.js +2 -2
- package/dist/icon-set/svg-fontawesome-v6.umd.prod.js +2 -2
- package/dist/icon-set/svg-ionicons-v4.umd.prod.js +2 -2
- package/dist/icon-set/svg-ionicons-v5.umd.prod.js +2 -2
- package/dist/icon-set/svg-ionicons-v6.umd.prod.js +2 -2
- package/dist/icon-set/svg-line-awesome.umd.prod.js +2 -2
- package/dist/icon-set/svg-material-icons-outlined.umd.prod.js +2 -2
- package/dist/icon-set/svg-material-icons-round.umd.prod.js +2 -2
- package/dist/icon-set/svg-material-icons-sharp.umd.prod.js +2 -2
- package/dist/icon-set/svg-material-icons.umd.prod.js +2 -2
- package/dist/icon-set/svg-material-symbols-outlined.umd.prod.js +2 -2
- package/dist/icon-set/svg-material-symbols-rounded.umd.prod.js +2 -2
- package/dist/icon-set/svg-material-symbols-sharp.umd.prod.js +2 -2
- package/dist/icon-set/svg-mdi-v6.umd.prod.js +2 -2
- package/dist/icon-set/svg-mdi-v7.umd.prod.js +2 -2
- package/dist/icon-set/svg-themify.umd.prod.js +2 -2
- package/dist/icon-set/themify.umd.prod.js +2 -2
- package/dist/lang/ar-TN.umd.prod.js +2 -2
- package/dist/lang/ar.umd.prod.js +2 -2
- package/dist/lang/az-Latn.umd.prod.js +2 -2
- package/dist/lang/bg.umd.prod.js +2 -2
- package/dist/lang/bn.umd.prod.js +2 -2
- package/dist/lang/ca.umd.prod.js +2 -2
- package/dist/lang/cs.umd.prod.js +2 -2
- package/dist/lang/da.umd.prod.js +2 -2
- package/dist/lang/de-CH.umd.prod.js +2 -2
- package/dist/lang/de-DE.umd.prod.js +2 -2
- package/dist/lang/de.umd.prod.js +2 -2
- package/dist/lang/el.umd.prod.js +2 -2
- package/dist/lang/en-GB.umd.prod.js +2 -2
- package/dist/lang/en-US.umd.prod.js +2 -2
- package/dist/lang/eo.umd.prod.js +2 -2
- package/dist/lang/es.umd.prod.js +2 -2
- package/dist/lang/et.umd.prod.js +2 -2
- package/dist/lang/eu.umd.prod.js +2 -2
- package/dist/lang/fa-IR.umd.prod.js +2 -2
- package/dist/lang/fa.umd.prod.js +2 -2
- package/dist/lang/fi.umd.prod.js +2 -2
- package/dist/lang/fr.umd.prod.js +2 -2
- package/dist/lang/gn.umd.prod.js +2 -2
- package/dist/lang/he.umd.prod.js +2 -2
- package/dist/lang/hi.umd.prod.js +2 -2
- package/dist/lang/hr.umd.prod.js +2 -2
- package/dist/lang/hu.umd.prod.js +2 -2
- package/dist/lang/id.umd.prod.js +2 -2
- package/dist/lang/is.umd.prod.js +2 -2
- package/dist/lang/it.umd.prod.js +2 -2
- package/dist/lang/ja.umd.prod.js +2 -2
- package/dist/lang/kk.umd.prod.js +2 -2
- package/dist/lang/km.umd.prod.js +2 -2
- package/dist/lang/ko-KR.umd.prod.js +2 -2
- package/dist/lang/kur-CKB.umd.prod.js +2 -2
- package/dist/lang/lt.umd.prod.js +2 -2
- package/dist/lang/lu.umd.prod.js +2 -2
- package/dist/lang/lv.umd.prod.js +2 -2
- package/dist/lang/mk.umd.prod.js +2 -2
- package/dist/lang/ml.umd.prod.js +2 -2
- package/dist/lang/mm.umd.prod.js +2 -2
- package/dist/lang/ms-MY.umd.prod.js +2 -2
- package/dist/lang/ms.umd.prod.js +2 -2
- package/dist/lang/my.umd.prod.js +2 -2
- package/dist/lang/nb-NO.umd.prod.js +2 -2
- package/dist/lang/nl.umd.prod.js +2 -2
- package/dist/lang/pl.umd.prod.js +2 -2
- package/dist/lang/pt-BR.umd.prod.js +2 -2
- package/dist/lang/pt.umd.prod.js +2 -2
- package/dist/lang/ro.umd.prod.js +2 -2
- package/dist/lang/ru.umd.prod.js +2 -2
- package/dist/lang/sk.umd.prod.js +2 -2
- package/dist/lang/sl.umd.prod.js +2 -2
- package/dist/lang/sm.umd.prod.js +2 -2
- package/dist/lang/sr-CYR.umd.prod.js +2 -2
- package/dist/lang/sr.umd.prod.js +2 -2
- package/dist/lang/sv.umd.prod.js +2 -2
- package/dist/lang/ta.umd.prod.js +2 -2
- package/dist/lang/th.umd.prod.js +2 -2
- package/dist/lang/tl.umd.prod.js +2 -2
- package/dist/lang/tr.umd.prod.js +2 -2
- package/dist/lang/ug.umd.prod.js +2 -2
- package/dist/lang/uk.umd.prod.js +2 -2
- package/dist/lang/uz-Cyrl.umd.prod.js +2 -2
- package/dist/lang/uz-Latn.umd.prod.js +2 -2
- package/dist/lang/vi.umd.prod.js +2 -2
- package/dist/lang/zh-CN.umd.prod.js +2 -2
- package/dist/lang/zh-TW.umd.prod.js +2 -2
- package/dist/quasar.addon.prod.css +1 -1
- package/dist/quasar.addon.rtl.prod.css +1 -1
- package/dist/quasar.cjs.prod.js +12 -12
- package/dist/quasar.esm.js +567 -520
- package/dist/quasar.esm.prod.js +17 -17
- package/dist/quasar.prod.css +1 -1
- package/dist/quasar.rtl.prod.css +1 -1
- package/dist/quasar.sass +1 -1
- package/dist/quasar.umd.js +554 -506
- package/dist/quasar.umd.prod.js +22 -22
- package/dist/transforms/api-list.json +1 -1
- package/dist/transforms/import-map.json +1 -1
- package/dist/types/config.d.ts +3 -3
- package/dist/types/globals.d.ts +1 -1
- package/dist/types/index.d.ts +1921 -102
- package/dist/vetur/quasar-attributes.json +1 -1
- package/dist/vetur/quasar-tags.json +1 -1
- package/dist/web-types/web-types.json +1 -1
- package/lang/uk.js +1 -1
- package/lang/uk.mjs +1 -1
- package/package.json +18 -17
- package/src/api.extends.json +7 -5
- package/src/components/ajax-bar/QAjaxBar.js +2 -2
- package/src/components/ajax-bar/QAjaxBar.json +1 -0
- package/src/components/avatar/QAvatar.js +3 -3
- package/src/components/avatar/QAvatar.json +1 -1
- package/src/components/avatar/QAvatar.test.js +169 -83
- package/src/components/badge/QBadge.js +2 -2
- package/src/components/badge/QBadge.test.js +200 -100
- package/src/components/banner/QBanner.js +3 -3
- package/src/components/banner/QBanner.test.js +88 -50
- package/src/components/bar/QBar.js +3 -3
- package/src/components/bar/QBar.test.js +44 -19
- package/src/components/breadcrumbs/QBreadcrumbs.js +6 -4
- package/src/components/breadcrumbs/QBreadcrumbs.test.js +134 -59
- package/src/components/breadcrumbs/QBreadcrumbsEl.js +3 -3
- package/src/components/breadcrumbs/QBreadcrumbsEl.json +1 -1
- package/src/components/breadcrumbs/QBreadcrumbsEl.test.js +491 -61
- package/src/components/btn/QBtn.js +11 -5
- package/src/components/btn/QBtn.json +2 -1
- package/src/components/btn/QBtn.test.js +1391 -212
- package/src/components/btn/use-btn.js +8 -6
- package/src/components/btn/use-btn.json +1 -1
- package/src/components/btn/use-btn.test.js +86 -542
- package/src/components/btn-dropdown/QBtnDropdown.js +9 -10
- package/src/components/btn-dropdown/QBtnDropdown.json +3 -3
- package/src/components/btn-group/QBtnGroup.js +2 -2
- package/src/components/btn-toggle/QBtnToggle.js +3 -3
- package/src/components/btn-toggle/QBtnToggle.json +2 -2
- package/src/components/card/QCard.js +3 -3
- package/src/components/card/QCardActions.js +3 -3
- package/src/components/card/QCardSection.js +2 -2
- package/src/components/carousel/QCarousel.js +6 -6
- package/src/components/carousel/QCarousel.json +1 -1
- package/src/components/carousel/QCarouselControl.js +2 -2
- package/src/components/carousel/QCarouselControl.json +1 -1
- package/src/components/carousel/QCarouselSlide.js +3 -3
- package/src/components/carousel/QCarouselSlide.json +1 -1
- package/src/components/chat/QChatMessage.js +2 -2
- package/src/components/checkbox/QCheckbox.js +1 -1
- package/src/components/checkbox/use-checkbox.js +8 -8
- package/src/components/checkbox/use-checkbox.json +5 -3
- package/src/components/chip/QChip.js +6 -5
- package/src/components/chip/QChip.json +4 -0
- package/src/components/chip/QChip.test.js +685 -317
- package/src/components/circular-progress/QCircularProgress.js +5 -5
- package/src/components/circular-progress/QCircularProgress.json +1 -1
- package/src/components/circular-progress/{use-circular-progress.js → circular-progress.js} +1 -1
- package/src/components/circular-progress/circular-progress.test.js +14 -0
- package/src/components/color/QColor.js +10 -10
- package/src/components/color/QColor.json +1 -1
- package/src/components/date/QDate.js +9 -9
- package/src/components/date/QDate.json +17 -11
- package/src/components/date/use-datetime.js +2 -2
- package/src/components/date/use-datetime.json +6 -6
- package/src/components/dialog/QDialog.js +33 -22
- package/src/components/dialog/QDialog.json +5 -3
- package/src/components/dialog/QDialog.test.js +1094 -220
- package/src/components/drawer/QDrawer.js +9 -9
- package/src/components/drawer/QDrawer.json +7 -4
- package/src/components/editor/QEditor.js +9 -9
- package/src/components/editor/QEditor.json +11 -5
- package/src/components/editor/editor-caret.js +1 -1
- package/src/components/editor/editor-utils.js +3 -3
- package/src/components/expansion-item/QExpansionItem.js +9 -9
- package/src/components/expansion-item/QExpansionItem.json +2 -2
- package/src/components/fab/QFab.js +5 -5
- package/src/components/fab/QFab.json +1 -1
- package/src/components/fab/QFabAction.js +4 -4
- package/src/components/fab/QFabAction.json +2 -1
- package/src/components/fab/use-fab.json +1 -1
- package/src/components/field/QField.js +2 -2
- package/src/components/field/QField.json +7 -3
- package/src/components/file/QFile.js +9 -9
- package/src/components/file/QFile.json +11 -4
- package/src/components/footer/QFooter.js +3 -3
- package/src/components/form/QForm.js +6 -6
- package/src/components/form/QForm.json +11 -4
- package/src/components/form/QFormChildMixin.js +2 -2
- package/src/components/form/QFormChildMixin.json +4 -1
- package/src/components/header/QHeader.js +3 -3
- package/src/components/icon/QIcon.js +3 -3
- package/src/components/icon/QIcon.json +1 -1
- package/src/components/img/QImg.js +5 -5
- package/src/components/img/QImg.json +1 -1
- package/src/components/infinite-scroll/QInfiniteScroll.js +6 -6
- package/src/components/infinite-scroll/QInfiniteScroll.json +20 -7
- package/src/components/inner-loading/QInnerLoading.js +3 -3
- package/src/components/inner-loading/QInnerLoading.json +1 -1
- package/src/components/input/QInput.js +9 -9
- package/src/components/input/QInput.json +16 -5
- package/src/components/input/use-mask.js +1 -1
- package/src/components/intersection/QIntersection.js +2 -2
- package/src/components/item/QItem.js +6 -6
- package/src/components/item/QItem.json +1 -1
- package/src/components/item/QItemLabel.js +2 -2
- package/src/components/item/QItemSection.js +2 -2
- package/src/components/item/QList.js +3 -3
- package/src/components/knob/QKnob.js +6 -6
- package/src/components/knob/QKnob.json +1 -1
- package/src/components/layout/QLayout.js +4 -4
- package/src/components/linear-progress/QLinearProgress.js +4 -4
- package/src/components/linear-progress/QLinearProgress.json +1 -1
- package/src/components/markup-table/QMarkupTable.js +3 -3
- package/src/components/menu/QMenu.js +20 -20
- package/src/components/menu/QMenu.json +8 -4
- package/src/components/no-ssr/QNoSsr.js +3 -3
- package/src/components/option-group/QOptionGroup.js +2 -2
- package/src/components/option-group/QOptionGroup.json +4 -4
- package/src/components/page/QPage.js +3 -3
- package/src/components/page/QPageContainer.js +3 -3
- package/src/components/page-scroller/QPageScroller.js +2 -2
- package/src/components/page-sticky/QPageSticky.js +1 -1
- package/src/components/page-sticky/QPageSticky.json +1 -1
- package/src/components/page-sticky/use-page-sticky.js +2 -2
- package/src/components/pagination/QPagination.js +4 -4
- package/src/components/pagination/QPagination.json +5 -3
- package/src/components/parallax/QParallax.js +6 -6
- package/src/components/popup-edit/QPopupEdit.js +4 -4
- package/src/components/popup-edit/QPopupEdit.json +30 -14
- package/src/components/popup-proxy/QPopupProxy.js +3 -3
- package/src/components/popup-proxy/QPopupProxy.json +9 -5
- package/src/components/pull-to-refresh/QPullToRefresh.js +5 -5
- package/src/components/pull-to-refresh/QPullToRefresh.json +6 -2
- package/src/components/radio/QRadio.js +9 -9
- package/src/components/radio/QRadio.json +4 -2
- package/src/components/range/QRange.js +3 -3
- package/src/components/rating/QRating.js +6 -6
- package/src/components/rating/QRating.json +2 -2
- package/src/components/resize-observer/QResizeObserver.js +3 -3
- package/src/components/resize-observer/QResizeObserver.json +2 -1
- package/src/components/responsive/QResponsive.js +3 -3
- package/src/components/responsive/QResponsive.json +1 -1
- package/src/components/scroll-area/QScrollArea.js +6 -6
- package/src/components/scroll-area/QScrollArea.json +8 -2
- package/src/components/scroll-observer/QScrollObserver.js +3 -3
- package/src/components/scroll-observer/QScrollObserver.json +5 -2
- package/src/components/select/QSelect.js +10 -10
- package/src/components/select/QSelect.json +38 -17
- package/src/components/separator/QSeparator.js +2 -2
- package/src/components/skeleton/QSkeleton.js +3 -3
- package/src/components/slide-item/QSlideItem.js +4 -4
- package/src/components/slide-item/QSlideItem.json +3 -1
- package/src/components/slide-transition/QSlideTransition.js +1 -1
- package/src/components/slider/QSlider.js +4 -4
- package/src/components/slider/use-slider.js +6 -6
- package/src/components/slider/use-slider.json +1 -1
- package/src/components/space/QSpace.js +1 -1
- package/src/components/space/QSpace.test.js +17 -0
- package/src/components/spinner/QSpinner.js +1 -1
- package/src/components/spinner/QSpinner.json +1 -1
- package/src/components/spinner/QSpinnerAudio.js +1 -1
- package/src/components/spinner/QSpinnerBall.js +1 -1
- package/src/components/spinner/QSpinnerBars.js +1 -1
- package/src/components/spinner/QSpinnerBox.js +1 -1
- package/src/components/spinner/QSpinnerClock.js +1 -1
- package/src/components/spinner/QSpinnerComment.js +1 -1
- package/src/components/spinner/QSpinnerCube.js +1 -1
- package/src/components/spinner/QSpinnerDots.js +1 -1
- package/src/components/spinner/QSpinnerFacebook.js +1 -1
- package/src/components/spinner/QSpinnerGears.js +1 -1
- package/src/components/spinner/QSpinnerGrid.js +1 -1
- package/src/components/spinner/QSpinnerHearts.js +1 -1
- package/src/components/spinner/QSpinnerHourglass.js +1 -1
- package/src/components/spinner/QSpinnerInfinity.js +1 -1
- package/src/components/spinner/QSpinnerIos.js +1 -1
- package/src/components/spinner/QSpinnerOrbit.js +1 -1
- package/src/components/spinner/QSpinnerOval.js +1 -1
- package/src/components/spinner/QSpinnerPie.js +1 -1
- package/src/components/spinner/QSpinnerPuff.js +1 -1
- package/src/components/spinner/QSpinnerRadio.js +1 -1
- package/src/components/spinner/QSpinnerRings.js +1 -1
- package/src/components/spinner/QSpinnerTail.js +1 -1
- package/src/components/spinner/spinner.json +1 -1
- package/src/components/spinner/use-spinner.js +1 -1
- package/src/components/splitter/QSplitter.js +3 -3
- package/src/components/splitter/QSplitter.json +4 -4
- package/src/components/stepper/QStep.js +5 -5
- package/src/components/stepper/QStep.json +1 -1
- package/src/components/stepper/QStepper.js +5 -5
- package/src/components/stepper/QStepper.json +1 -1
- package/src/components/stepper/QStepperNavigation.js +2 -2
- package/src/components/stepper/StepHeader.js +1 -1
- package/src/components/tab-panels/QTabPanel.js +3 -3
- package/src/components/tab-panels/QTabPanel.json +1 -7
- package/src/components/tab-panels/QTabPanels.js +4 -4
- package/src/components/tab-panels/QTabPanels.json +1 -1
- package/src/components/table/QTable.js +7 -7
- package/src/components/table/QTable.json +41 -22
- package/src/components/table/QTd.js +2 -2
- package/src/components/table/QTh.js +2 -2
- package/src/components/table/QTr.js +2 -2
- package/src/components/table/table-column-selection.js +1 -1
- package/src/components/table/table-sort.js +2 -2
- package/src/components/tabs/QRouteTab.js +2 -2
- package/src/components/tabs/QRouteTab.json +1 -1
- package/src/components/tabs/QTab.js +1 -1
- package/src/components/tabs/QTabs.js +6 -6
- package/src/components/tabs/use-tab.js +6 -6
- package/src/components/time/QTime.js +8 -8
- package/src/components/time/QTime.json +5 -3
- package/src/components/timeline/QTimeline.js +4 -4
- package/src/components/timeline/QTimelineEntry.js +3 -3
- package/src/components/toggle/QToggle.js +1 -1
- package/src/components/toolbar/QToolbar.js +2 -2
- package/src/components/toolbar/QToolbarTitle.js +2 -2
- package/src/components/tooltip/QTooltip.js +15 -15
- package/src/components/tooltip/QTooltip.json +6 -5
- package/src/components/tree/QTree.js +5 -5
- package/src/components/tree/QTree.json +12 -4
- package/src/components/uploader/QUploader.js +1 -1
- package/src/components/uploader/QUploader.json +25 -10
- package/src/components/uploader/QUploaderAddTrigger.js +2 -2
- package/src/components/uploader/uploader-core.js +8 -8
- package/src/components/uploader/xhr-uploader-plugin.js +3 -1
- package/src/components/uploader/xhr-uploader-plugin.json +9 -9
- package/src/components/video/QVideo.js +2 -2
- package/src/components/video/QVideo.json +1 -1
- package/src/components/video/QVideo.test.js +183 -0
- package/src/components/virtual-scroll/QVirtualScroll.js +4 -4
- package/src/components/virtual-scroll/QVirtualScroll.json +1 -0
- package/src/components/virtual-scroll/use-virtual-scroll.js +3 -3
- package/src/components/virtual-scroll/use-virtual-scroll.json +7 -3
- package/src/composables/private.use-align/use-align.test.js +62 -0
- package/src/composables/{private → private.use-anchor}/use-anchor.js +3 -3
- package/src/composables/{private → private.use-anchor}/use-anchor.json +0 -1
- package/src/composables/private.use-dark/use-dark.test.js +68 -0
- package/src/composables/{private → private.use-field}/use-field.js +8 -8
- package/src/composables/{private → private.use-field}/use-field.json +7 -10
- package/src/composables/{private → private.use-file}/use-file.js +1 -1
- package/src/composables/{private → private.use-file}/use-file.json +4 -2
- package/src/composables/{private → private.use-fullscreen}/use-fullscreen.js +2 -2
- package/src/composables/{private → private.use-fullscreen}/use-fullscreen.json +9 -3
- package/src/composables/{private → private.use-history}/use-history.js +1 -1
- package/src/composables/private.use-history/use-history.test.js +116 -0
- package/src/composables/{private → private.use-model-toggle}/use-model-toggle.js +1 -1
- package/src/composables/{private → private.use-panel}/use-panel.js +3 -3
- package/src/composables/{private → private.use-panel}/use-panel.json +10 -5
- package/src/composables/{private → private.use-portal}/use-portal.js +6 -6
- package/src/composables/{private → private.use-prevent-scroll}/use-prevent-scroll.js +1 -1
- package/src/composables/private.use-ratio/use-ratio.test.js +40 -0
- package/src/composables/{private → private.use-router-link}/use-router-link.js +1 -1
- package/src/composables/{private → private.use-scroll-target}/use-scroll-target.js +2 -5
- package/src/composables/private.use-size/use-size.test.js +40 -0
- package/src/composables/private.use-transition/use-transition.test.js +118 -0
- package/src/composables/{private → private.use-validate}/use-validate.js +4 -4
- package/src/composables/{private → private.use-validate}/use-validate.json +3 -1
- package/src/composables/{use-dialog-plugin-component.js → use-dialog-plugin-component/use-dialog-plugin-component.js} +2 -4
- package/src/composables/use-form/private.use-form.test.js +107 -0
- package/src/composables/{use-form-child.js → use-form/use-form-child.js} +1 -1
- package/src/composables/{use-hydration.js → use-hydration/use-hydration.js} +1 -1
- package/src/composables/use-hydration/use-hydration.test.js +27 -0
- package/src/composables/{use-id.js → use-id/use-id.js} +2 -2
- package/src/composables/use-id/use-id.test.js +72 -0
- package/src/composables/{use-interval.js → use-interval/use-interval.js} +1 -1
- package/src/composables/{use-meta.js → use-meta/use-meta.js} +1 -1
- package/src/composables/{use-quasar.js → use-quasar/use-quasar.js} +2 -1
- package/src/composables/use-quasar/use-quasar.test.js +35 -0
- package/src/composables/{use-tick.js → use-tick/use-tick.js} +1 -1
- package/src/composables/{use-timeout.js → use-timeout/use-timeout.js} +1 -1
- package/src/composables.js +11 -11
- package/src/css/index.sass +1 -1
- package/src/directives/close-popup/ClosePopup.js +4 -4
- package/src/directives/intersection/Intersection.js +3 -3
- package/src/directives/morph/Morph.js +2 -2
- package/src/directives/morph/Morph.json +1 -1
- package/src/directives/mutation/Mutation.js +2 -2
- package/src/directives/ripple/Ripple.js +6 -6
- package/src/directives/ripple/Ripple.json +2 -2
- package/src/directives/ripple/Ripple.test.js +340 -0
- package/src/directives/scroll/Scroll.js +4 -4
- package/src/directives/scroll-fire/ScrollFire.js +6 -6
- package/src/directives/scroll-fire/ScrollFire.json +1 -1
- package/src/directives/touch-hold/TouchHold.js +4 -4
- package/src/directives/touch-pan/TouchPan.js +5 -5
- package/src/directives/touch-repeat/TouchRepeat.js +5 -5
- package/src/directives/touch-swipe/TouchSwipe.js +5 -5
- package/src/index.dev.js +10 -4
- package/src/index.prod.js +11 -4
- package/src/index.ssr.js +11 -4
- package/src/index.umd.js +12 -4
- package/src/install-quasar.js +14 -9
- package/src/plugins/addressbar/AddressbarColor.js +2 -2
- package/src/plugins/addressbar/AddressbarColor.json +2 -1
- package/src/plugins/app-fullscreen/AppFullscreen.js +3 -3
- package/src/plugins/app-fullscreen/AppFullscreen.json +1 -0
- package/src/plugins/app-visibility/AppVisibility.js +3 -3
- package/src/plugins/bottom-sheet/BottomSheet.js +2 -5
- package/src/plugins/bottom-sheet/BottomSheet.json +1 -1
- package/src/plugins/bottom-sheet/component/BottomSheetComponent.js +2 -2
- package/src/plugins/cookies/Cookies.json +5 -2
- package/src/plugins/dark/Dark.js +2 -2
- package/src/plugins/dark/Dark.json +5 -2
- package/src/plugins/dialog/Dialog.js +2 -5
- package/src/plugins/dialog/Dialog.json +3 -3
- package/src/plugins/dialog/component/DialogPluginComponent.js +4 -4
- package/src/{icon-set.js → plugins/icon-set/IconSet.js} +29 -10
- package/src/plugins/icon-set/IconSet.json +1417 -0
- package/src/plugins/icon-set/IconSet.test.js +346 -0
- package/src/{lang.js → plugins/lang/Lang.js} +25 -15
- package/src/plugins/lang/Lang.json +1100 -0
- package/src/plugins/lang/Lang.test.js +267 -0
- package/src/plugins/loading/Loading.js +5 -5
- package/src/plugins/loading/Loading.json +4 -2
- package/src/plugins/loading-bar/LoadingBar.js +5 -5
- package/src/plugins/loading-bar/LoadingBar.json +9 -4
- package/src/plugins/meta/Meta.js +1 -1
- package/src/plugins/notify/Notify.js +4 -4
- package/src/plugins/notify/Notify.json +8 -6
- package/src/plugins/platform/Platform.js +3 -4
- package/src/plugins/platform/Platform.json +6 -0
- package/src/plugins/platform/Platform.test.js +104 -0
- package/src/{body.js → plugins/private.body/Body.js} +5 -4
- package/src/{history.js → plugins/private.history/History.js} +2 -2
- package/src/plugins/screen/Screen.js +4 -4
- package/src/plugins/screen/Screen.json +4 -2
- package/src/plugins/{local-storage → storage}/LocalStorage.js +1 -1
- package/src/plugins/storage/LocalStorage.json +5 -0
- package/src/plugins/storage/LocalStorage.test.js +323 -0
- package/src/plugins/{session-storage → storage}/SessionStorage.js +1 -1
- package/src/plugins/storage/SessionStorage.json +5 -0
- package/src/plugins/storage/SessionStorage.test.js +323 -0
- package/src/{utils/private → plugins/storage/engine}/web-storage.js +21 -10
- package/src/{utils/private → plugins/storage/engine}/web-storage.json +22 -11
- package/src/plugins/storage/engine/web-storage.test.js +43 -0
- package/src/plugins.js +8 -4
- package/src/utils/EventBus/EventBus.test.js +108 -0
- package/src/utils/clone/clone.test.js +111 -0
- package/src/utils/colors/colors.test.js +459 -0
- package/src/utils/{copy-to-clipboard.js → copy-to-clipboard/copy-to-clipboard.js} +1 -1
- package/src/utils/{create-meta-mixin.js → create-meta-mixin/create-meta-mixin.js} +1 -1
- package/src/utils/{create-uploader-component.js → create-uploader-component/create-uploader-component.js} +4 -4
- package/src/utils/css-var/get-css-var.test.js +32 -0
- package/src/utils/css-var/set-css-var.test.js +36 -0
- package/src/utils/{date.js → date/date.js} +6 -6
- package/src/utils/debounce/debounce.test.js +188 -0
- package/src/utils/extend/extend.test.js +93 -0
- package/src/utils/{format.js → format/format.js} +2 -2
- package/src/utils/format/format.test.js +107 -0
- package/src/utils/{frame-debounce.js → frame-debounce/frame-debounce.js} +1 -1
- package/src/utils/frame-debounce/frame-debounce.test.js +127 -0
- package/src/utils/is/is.test.js +125 -0
- package/src/utils/{morph.js → morph/morph.js} +1 -1
- package/src/utils/{open-url.js → open-url/open-url.js} +3 -3
- package/src/utils/patterns/patterns.test.js +403 -0
- package/src/utils/{private → private.click-outside}/click-outside.js +2 -2
- package/src/utils/{private/define-reactive-plugin.js → private.create/create.js} +6 -3
- package/src/utils/private.create/create.test.js +58 -0
- package/src/utils/private.focus/focus-manager.test.js +190 -0
- package/src/utils/private.focus/focusout.test.js +114 -0
- package/src/utils/private.get-emits-object/get-emits-object.test.js +29 -0
- package/src/utils/private.global/global-config.test.js +54 -0
- package/src/utils/{private → private.global}/global-dialog.js +1 -1
- package/src/utils/{private → private.global}/global-dialog.json +1 -1
- package/src/utils/{private → private.global}/global-nodes.js +1 -1
- package/src/utils/private.global/global-nodes.test.js +110 -0
- package/src/utils/private.inject-obj-prop/inject-obj-prop.test.js +104 -0
- package/src/utils/{private → private.keyboard}/escape-key.js +1 -1
- package/src/utils/private.keyboard/escape-key.test.js +117 -0
- package/src/utils/private.noop-ssr-directive-transform/noop-ssr-directive-transform.test.js +14 -0
- package/src/utils/{private → private.portal}/portal.js +1 -1
- package/src/utils/{private → private.position-engine}/position-engine.js +1 -1
- package/src/utils/private.rtl/rtl.test.js +13 -0
- package/src/utils/private.sort/sort.test.js +25 -0
- package/src/utils/{private → private.symbols}/symbols.js +1 -1
- package/src/utils/private.touch/touch.test.js +102 -0
- package/src/utils/{prevent-scroll.js → scroll/prevent-scroll.js} +3 -3
- package/src/utils/{scroll.js → scroll/scroll.js} +1 -1
- package/src/utils/throttle/throttle.test.js +146 -0
- package/src/utils/uid/uid.test.js +17 -0
- package/src/utils.js +24 -24
- package/src/vue-plugin.js +12 -4
- package/src/Lang.json +0 -19
- package/src/api-file-example.json +0 -94
- package/src/composables/private/__tests__/use-form.cy.js +0 -11
- package/src/composables/private/__tests__/use-size.cy.js +0 -36
- package/src/composables/private/__tests__/use-transition.cy.js +0 -111
- package/src/composables/private/use-form.test.js +0 -93
- package/src/composables/private/use-ratio.test.js +0 -27
- package/src/composables/private/use-size.test.js +0 -22
- package/src/composables/use-id.test.js +0 -55
- package/src/plugins/local-storage/LocalStorage.json +0 -5
- package/src/plugins/session-storage/SessionStorage.json +0 -5
- package/src/utils/private/create.js +0 -4
- /package/src/composables/{private/__tests__ → __tests__}/FieldWrapper.vue +0 -0
- /package/src/composables/{private/__tests__ → __tests__}/use-anchor.cy.js +0 -0
- /package/src/composables/{private/__tests__ → __tests__}/use-field.cy.js +0 -0
- /package/src/composables/{private/__tests__ → __tests__}/use-file.cy.js +0 -0
- /package/src/composables/{private/__tests__ → __tests__}/use-fullscreen.cy.js +0 -0
- /package/src/composables/{private/__tests__ → __tests__}/use-model-toggle.cy.js +0 -0
- /package/src/composables/{private/__tests__ → __tests__}/use-portal.cy.js +0 -0
- /package/src/composables/{private/__tests__ → __tests__}/use-router-link.cy.js +0 -0
- /package/src/composables/{private/__tests__ → __tests__}/use-validate.cy.js +0 -0
- /package/src/composables/{private → private.use-align}/use-align.js +0 -0
- /package/src/composables/{private → private.use-dark}/use-dark.js +0 -0
- /package/src/composables/{private → private.use-file}/use-file-dom-props.js +0 -0
- /package/src/composables/{private → private.use-key-composition}/use-key-composition.js +0 -0
- /package/src/composables/{private → private.use-model-toggle}/use-model-toggle.json +0 -0
- /package/src/composables/{private → private.use-panel}/use-panel.child.json +0 -0
- /package/src/composables/{private → private.use-panel}/use-panel.sass +0 -0
- /package/src/composables/{private → private.use-portal}/use-portal.json +0 -0
- /package/src/composables/{private → private.use-ratio}/use-ratio.js +0 -0
- /package/src/composables/{private → private.use-ratio}/use-ratio.json +0 -0
- /package/src/composables/{private → private.use-refocus-target}/use-refocus-target.js +0 -0
- /package/src/composables/{private → private.use-router-link}/use-router-link.json +0 -0
- /package/src/composables/{private → private.use-size}/use-size.js +0 -0
- /package/src/composables/{private → private.use-size}/use-size.json +0 -0
- /package/src/composables/{private → private.use-transition}/use-transition.js +0 -0
- /package/src/composables/{private → private.use-transition}/use-transition.json +0 -0
- /package/src/composables/{private/use-form.js → use-form/private.use-form.js} +0 -0
- /package/src/composables/{private/use-form.json → use-form/private.use-form.json} +0 -0
- /package/src/composables/{use-render-cache.js → use-render-cache/use-render-cache.js} +0 -0
- /package/src/composables/{use-split-attrs.js → use-split-attrs/use-split-attrs.js} +0 -0
- /package/src/utils/{EventBus.js → EventBus/EventBus.js} +0 -0
- /package/src/utils/{clone.js → clone/clone.js} +0 -0
- /package/src/utils/{colors.js → colors/colors.js} +0 -0
- /package/src/utils/{get-css-var.js → css-var/get-css-var.js} +0 -0
- /package/src/utils/{set-css-var.js → css-var/set-css-var.js} +0 -0
- /package/src/utils/{private/date-persian.js → date/private.persian.js} +0 -0
- /package/src/utils/{debounce.js → debounce/debounce.js} +0 -0
- /package/src/utils/{dom.js → dom/dom.js} +0 -0
- /package/src/utils/{event.js → event/event.js} +0 -0
- /package/src/utils/{export-file.js → export-file/export-file.js} +0 -0
- /package/src/utils/{extend.js → extend/extend.js} +0 -0
- /package/src/utils/{is.js → is/is.js} +0 -0
- /package/src/utils/{patterns.js → patterns/patterns.js} +0 -0
- /package/src/utils/{private → private.focus}/focus-manager.js +0 -0
- /package/src/utils/{private → private.focus}/focusout.js +0 -0
- /package/src/utils/{private → private.get-emits-object}/get-emits-object.js +0 -0
- /package/src/utils/{private → private.global}/global-config.js +0 -0
- /package/src/utils/{private → private.inject-obj-prop}/inject-obj-prop.js +0 -0
- /package/src/utils/{private → private.keyboard}/key-composition.js +0 -0
- /package/src/utils/{private → private.noop-ssr-directive-transform}/noop-ssr-directive-transform.js +0 -0
- /package/src/utils/{private → private.option-sizes}/option-sizes.js +0 -0
- /package/src/utils/{private → private.render}/render.js +0 -0
- /package/src/utils/{private → private.rtl}/rtl.js +0 -0
- /package/src/utils/{private → private.selection}/selection.js +0 -0
- /package/src/utils/{private → private.sort}/sort.js +0 -0
- /package/src/utils/{private → private.touch}/touch.js +0 -0
- /package/src/utils/{private → private.vm}/vm.js +0 -0
- /package/src/utils/{run-sequential-promises.js → run-sequential-promises/run-sequential-promises.js} +0 -0
- /package/src/utils/{throttle.js → throttle/throttle.js} +0 -0
- /package/src/utils/{uid.js → uid/uid.js} +0 -0
package/dist/api/Notify.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"type":"plugin","meta":{"docsUrl":"https://v2.quasar.dev/quasar-plugins/notify"},"injection":"$q.notify","quasarConfOptions":{"propName":"notify","type":"Object","definition":{"type":{"type":"String","desc":"Optional type (that has been previously registered) or one of the out of the box ones ('positive', 'negative', 'warning', 'info', 'ongoing')","examples":["'negative'","'custom-type'"]},"color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"textColor":{"type":"String","tsType":"NamedColor","desc":"Overrides text color (if needed); Color name from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"message":{"type":"String","desc":"The content of your message","examples":["'John Doe pinged you'"]},"caption":{"type":"String","desc":"The content of your optional caption","examples":["'5 minutes ago'"]},"html":{"type":"Boolean","desc":"Render the message as HTML; This can lead to XSS attacks, so make sure that you sanitize the message first"},"icon":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"iconColor":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style","addedIn":"v2.5.5"},"iconSize":{"type":"String","desc":"Size in CSS units, including unit name","examples":["'16px'","'2rem'"],"category":"style","addedIn":"v2.5.5"},"avatar":{"type":"String","desc":"URL to an avatar/image; Suggestion: use public folder","examples":["# (public folder) 'img/something.png'","# (relative path format) require('./my_img.jpg')","# (URL) https://some-site.net/some-img.gif"]},"spinner":{"type":["Boolean","Component"],"configFileType":["Boolean","String"],"desc":"Useful for notifications that are updated; Displays a Quasar spinner instead of an avatar or icon; If value is Boolean 'true' then the default QSpinner is shown","examples":["true","QSpinnerBars"]},"spinnerColor":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style","addedIn":"v2.5.5"},"spinnerSize":{"type":"String","desc":"Size in CSS units, including unit name","examples":["'16px'","'2rem'"],"category":"style","addedIn":"v2.5.5"},"position":{"type":"String","desc":"Window side/corner to stick to","default":"'bottom'","values":["'top-left'","'top-right'","'bottom-left'","'bottom-right'","'top'","'bottom'","'left'","'right'","'center'"],"required":false},"group":{"type":["Boolean","String","Number"],"desc":"Override the auto generated group with custom one; Grouped notifications cannot be updated; String or number value inform this is part of a specific group, regardless of its options; When a new notification is triggered with same group name, it replaces the old one and shows a badge with how many times the notification was triggered","default":"# message + caption + multiline + actions labels + position","examples":["'my-group'"],"required":false},"badgeColor":{"type":"String","tsType":"NamedColor","desc":"Color name for the badge from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"badgeTextColor":{"type":"String","tsType":"NamedColor","desc":"Color name for the badge text from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"badgePosition":{"type":"String","desc":"Notification corner to stick badge to; If notification is on the left side then default is top-right otherwise it is top-left","default":"# top-left/top-right","values":["'top-left'","'top-right'","'bottom-left'","'bottom-right'"],"required":false},"badgeStyle":{"type":["String","Array","Object"],"tsType":"VueStyleProp","desc":"Style definitions to be attributed to the badge","examples":["'background-color: #ff0000'","{ backgroundColor: '#ff0000' }"]},"badgeClass":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"Class definitions to be attributed to the badge","examples":["'my-special-class'","{ 'my-special-class': <condition> }"]},"progress":{"type":"Boolean","desc":"Show progress bar to detail when notification will disappear automatically (unless timeout is 0)"},"progressClass":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"Class definitions to be attributed to the progress bar","examples":["'my-special-class'","{ 'my-special-class': <condition> }"]},"classes":{"type":"String","desc":"Add CSS class(es) to the notification for easier customization","examples":["'my-notif-class'"]},"attrs":{"type":"Object","desc":"Key-value for attributes to be set on the notification","examples":["{ role: 'alertdialog' }"]},"timeout":{"type":"Number","desc":"Amount of time to display (in milliseconds). Set to 0 to never dismiss automatically.","default":"5000","required":false},"actions":{"type":"Array","tsType":"QNotifyAction","desc":"Notification actions (buttons); Unless 'noDismiss' is true, clicking/tapping on the button will close the notification; Also check 'closeBtn' convenience prop","definition":{"handler":{"type":"Function","configFileType":null,"desc":"Function to be executed when the button is clicked/tapped","params":null,"returns":null,"examples":["() => { console.log('button clicked') }"]},"noDismiss":{"type":"Boolean","desc":"Do not dismiss the notification when the button is clicked/tapped"},"...":{"type":"Any","desc":"Any other QBtn prop expect 'onClick' (use 'handler' instead, only possible with UI config)","examples":["label: 'Learn more'","color: 'primary'"]}},"examples":["[ { label: 'Show', handler: () => {}, 'aria-label': 'Button label' }, { icon: 'map', handler: () => {}, color: 'yellow' }, { label: 'Learn more', noDismiss: true, handler: () => {} } ]"]},"onDismiss":{"type":"Function","configFileType":null,"desc":"Function to call when notification gets dismissed","params":null,"returns":null,"examples":["() => { console.log('Dismissed') }"]},"closeBtn":{"type":["Boolean","String"],"desc":"Convenient way to add a dismiss button with a specific label, without using the 'actions' prop; If set to true, it uses a label according to the current Quasar language","examples":["'Close me'"]},"multiLine":{"type":"Boolean","desc":"Put notification into multi-line mode; If this prop isn't used and more than one 'action' is specified then notification goes into multi-line mode by default"}}},"methods":{"create":{"tsInjectionPoint":true,"desc":"Creates a notification; Same as calling $q.notify(...)","params":{"opts":{"type":["Object","String"],"tsType":"QNotifyCreateOptions","autoDefineTsType":true,"required":true,"desc":"Notification options","definition":{"type":{"type":"String","desc":"Optional type (that has been previously registered) or one of the out of the box ones ('positive', 'negative', 'warning', 'info', 'ongoing')","examples":["'negative'","'custom-type'"]},"color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"textColor":{"type":"String","tsType":"NamedColor","desc":"Overrides text color (if needed); Color name from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"message":{"type":"String","desc":"The content of your message","examples":["'John Doe pinged you'"]},"caption":{"type":"String","desc":"The content of your optional caption","examples":["'5 minutes ago'"]},"html":{"type":"Boolean","desc":"Render the message as HTML; This can lead to XSS attacks, so make sure that you sanitize the message first"},"icon":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"iconColor":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style","addedIn":"v2.5.5"},"iconSize":{"type":"String","desc":"Size in CSS units, including unit name","examples":["'16px'","'2rem'"],"category":"style","addedIn":"v2.5.5"},"avatar":{"type":"String","desc":"URL to an avatar/image; Suggestion: use public folder","examples":["# (public folder) 'img/something.png'","# (relative path format) require('./my_img.jpg')","# (URL) https://some-site.net/some-img.gif"]},"spinner":{"type":["Boolean","Component"],"desc":"Useful for notifications that are updated; Displays a Quasar spinner instead of an avatar or icon; If value is Boolean 'true' then the default QSpinner is shown","examples":["true","QSpinnerBars"]},"spinnerColor":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style","addedIn":"v2.5.5"},"spinnerSize":{"type":"String","desc":"Size in CSS units, including unit name","examples":["'16px'","'2rem'"],"category":"style","addedIn":"v2.5.5"},"position":{"type":"String","desc":"Window side/corner to stick to","default":"'bottom'","values":["'top-left'","'top-right'","'bottom-left'","'bottom-right'","'top'","'bottom'","'left'","'right'","'center'"],"required":false},"group":{"type":["Boolean","String","Number"],"desc":"Override the auto generated group with custom one; Grouped notifications cannot be updated; String or number value inform this is part of a specific group, regardless of its options; When a new notification is triggered with same group name, it replaces the old one and shows a badge with how many times the notification was triggered","default":"# message + caption + multiline + actions labels + position","examples":["'my-group'"],"required":false},"badgeColor":{"type":"String","tsType":"NamedColor","desc":"Color name for the badge from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"badgeTextColor":{"type":"String","tsType":"NamedColor","desc":"Color name for the badge text from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"badgePosition":{"type":"String","desc":"Notification corner to stick badge to; If notification is on the left side then default is top-right otherwise it is top-left","default":"# top-left/top-right","values":["'top-left'","'top-right'","'bottom-left'","'bottom-right'"],"required":false},"badgeStyle":{"type":["String","Array","Object"],"tsType":"VueStyleProp","desc":"Style definitions to be attributed to the badge","examples":["'background-color: #ff0000'","{ backgroundColor: '#ff0000' }"]},"badgeClass":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"Class definitions to be attributed to the badge","examples":["'my-special-class'","{ 'my-special-class': <condition> }"]},"progress":{"type":"Boolean","desc":"Show progress bar to detail when notification will disappear automatically (unless timeout is 0)"},"progressClass":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"Class definitions to be attributed to the progress bar","examples":["'my-special-class'","{ 'my-special-class': <condition> }"]},"classes":{"type":"String","desc":"Add CSS class(es) to the notification for easier customization","examples":["'my-notif-class'"]},"attrs":{"type":"Object","desc":"Key-value for attributes to be set on the notification","examples":["{ role: 'alertdialog' }"]},"timeout":{"type":"Number","desc":"Amount of time to display (in milliseconds). Set to 0 to never dismiss automatically.","default":"5000","examples":["2500"],"required":false},"actions":{"type":"Array","tsType":"QNotifyAction","desc":"Notification actions (buttons); Unless 'noDismiss' is true, clicking/tapping on the button will close the notification; Also check 'closeBtn' convenience prop","definition":{"handler":{"type":"Function","desc":"Function to be executed when the button is clicked/tapped","params":null,"returns":null,"examples":["() => { console.log('button clicked') }"]},"noDismiss":{"type":"Boolean","desc":"Do not dismiss the notification when the button is clicked/tapped"},"...":{"type":"Any","desc":"Any other QBtn prop expect 'onClick' (use 'handler' instead)","examples":["label: 'Learn more'","color: 'primary'"]}},"examples":["[ { label: 'Show', handler: () => {}, 'aria-label': 'Button label' }, { icon: 'map', handler: () => {}, color: 'yellow' }, { label: 'Learn more', noDismiss: true, handler: () => {} } ]"]},"onDismiss":{"type":"Function","desc":"Function to call when notification gets dismissed","params":null,"returns":null,"examples":["() => { console.log('Dismissed') }"]},"closeBtn":{"type":["Boolean","String"],"desc":"Convenient way to add a dismiss button with a specific label, without using the 'actions' prop; If set to true, it uses a label according to the current Quasar language","examples":["'Close me'"]},"multiLine":{"type":"Boolean","desc":"Put notification into multi-line mode; If this prop isn't used and more than one 'action' is specified then notification goes into multi-line mode by default"},"ignoreDefaults":{"type":"Boolean","desc":"Ignore the default configuration (set by setDefaults()) for this instance only"}}}},"returns":{"type":"Function","desc":"Calling this function with no parameters hides the notification; When called with one Object parameter (the original notification must NOT be grouped), it updates the notification (specified properties are shallow merged with previous ones; note that group and position cannot be changed while updating and so they are ignored)","params":{"props":{"type":"Object","tsType":"QNotifyUpdateOptions","required":false,"desc":"Notification properties that will be shallow merged to previous ones in order to update the non-grouped notification; (See 'opts' param of 'create()' for object properties, except 'group' and 'position')"}},"returns":null}},"setDefaults":{"desc":"Merge options into the default ones","params":{"opts":{"type":"Object","tsType":"QNotifyOptions","required":true,"desc":"Notification options except 'ignoreDefaults' (See 'opts' param of 'create()' for object properties)"}}},"registerType":{"desc":"Register a new type of notification (or override an existing one)","params":{"typeName":{"type":"String","required":true,"desc":"Name of the type (to be used as 'type' prop later on)","examples":["'my-type'"]},"typeOpts":{"type":"Object","tsType":"QNotifyOptions","required":true,"desc":"Notification options except 'ignoreDefaults' (See 'opts' param of 'create()' for object properties)"}}}}}
|
|
1
|
+
{"type":"plugin","meta":{"docsUrl":"https://v2.quasar.dev/quasar-plugins/notify"},"injection":"$q.notify","quasarConfOptions":{"propName":"notify","type":"Object","definition":{"type":{"type":"String","desc":"Optional type (that has been previously registered) or one of the out of the box ones ('positive', 'negative', 'warning', 'info', 'ongoing')","examples":["'negative'","'custom-type'"]},"color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"textColor":{"type":"String","tsType":"NamedColor","desc":"Overrides text color (if needed); Color name from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"message":{"type":"String","desc":"The content of your message","examples":["'John Doe pinged you'"]},"caption":{"type":"String","desc":"The content of your optional caption","examples":["'5 minutes ago'"]},"html":{"type":"Boolean","desc":"Render the message as HTML; This can lead to XSS attacks, so make sure that you sanitize the message first"},"icon":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"iconColor":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style","addedIn":"v2.5.5"},"iconSize":{"type":"String","desc":"Size in CSS units, including unit name","examples":["'16px'","'2rem'"],"category":"style","addedIn":"v2.5.5"},"avatar":{"type":"String","desc":"URL to an avatar/image; Suggestion: use public folder","examples":["# (public folder) 'img/something.png'","# (relative path format) require('./my_img.jpg')","# (URL) https://some-site.net/some-img.gif"]},"spinner":{"type":["Boolean","Component"],"configFileType":["Boolean","String"],"desc":"Useful for notifications that are updated; Displays a Quasar spinner instead of an avatar or icon; If value is Boolean 'true' then the default QSpinner is shown","examples":["true","QSpinnerBars"]},"spinnerColor":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style","addedIn":"v2.5.5"},"spinnerSize":{"type":"String","desc":"Size in CSS units, including unit name","examples":["'16px'","'2rem'"],"category":"style","addedIn":"v2.5.5"},"position":{"type":"String","desc":"Window side/corner to stick to","default":"'bottom'","values":["'top-left'","'top-right'","'bottom-left'","'bottom-right'","'top'","'bottom'","'left'","'right'","'center'"],"required":false},"group":{"type":["Boolean","String","Number"],"desc":"Override the auto generated group with custom one; Grouped notifications cannot be updated; String or number value inform this is part of a specific group, regardless of its options; When a new notification is triggered with same group name, it replaces the old one and shows a badge with how many times the notification was triggered","default":"# message + caption + multiline + actions labels + position","examples":["'my-group'"],"required":false},"badgeColor":{"type":"String","tsType":"NamedColor","desc":"Color name for the badge from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"badgeTextColor":{"type":"String","tsType":"NamedColor","desc":"Color name for the badge text from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"badgePosition":{"type":"String","desc":"Notification corner to stick badge to; If notification is on the left side then default is top-right otherwise it is top-left","default":"# top-left/top-right","values":["'top-left'","'top-right'","'bottom-left'","'bottom-right'"],"required":false},"badgeStyle":{"type":["String","Array","Object"],"tsType":"VueStyleProp","desc":"Style definitions to be attributed to the badge","examples":["'background-color: #ff0000'","{ backgroundColor: '#ff0000' }"]},"badgeClass":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"Class definitions to be attributed to the badge","examples":["'my-special-class'","{ 'my-special-class': true }"]},"progress":{"type":"Boolean","desc":"Show progress bar to detail when notification will disappear automatically (unless timeout is 0)"},"progressClass":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"Class definitions to be attributed to the progress bar","examples":["'my-special-class'","{ 'my-special-class': true }"]},"classes":{"type":"String","desc":"Add CSS class(es) to the notification for easier customization","examples":["'my-notif-class'"]},"attrs":{"type":"Object","desc":"Key-value for attributes to be set on the notification","examples":["{ role: 'alertdialog' }"]},"timeout":{"type":"Number","desc":"Amount of time to display (in milliseconds). Set to 0 to never dismiss automatically.","default":"5000","required":false},"actions":{"type":"Array","tsType":"QNotifyAction","desc":"Notification actions (buttons); Unless 'noDismiss' is true, clicking/tapping on the button will close the notification; Also check 'closeBtn' convenience prop","definition":{"handler":{"type":"Function","configFileType":null,"desc":"Function to be executed when the button is clicked/tapped","params":null,"returns":null,"examples":["() => { console.log('button clicked') }"]},"noDismiss":{"type":"Boolean","desc":"Do not dismiss the notification when the button is clicked/tapped"},"...":{"type":"Any","desc":"Any other QBtn prop expect 'onClick' (use 'handler' instead, only possible with UI config)","examples":["label: 'Learn more'","color: 'primary'"]}},"examples":["[ { label: 'Show', handler: () => {}, 'aria-label': 'Button label' }, { icon: 'map', handler: () => {}, color: 'yellow' }, { label: 'Learn more', noDismiss: true, handler: () => {} } ]"]},"onDismiss":{"type":"Function","configFileType":null,"desc":"Function to call when notification gets dismissed","params":null,"returns":null,"examples":["() => { console.log('Dismissed') }"]},"closeBtn":{"type":["Boolean","String"],"desc":"Convenient way to add a dismiss button with a specific label, without using the 'actions' prop; If set to true, it uses a label according to the current Quasar language","examples":["'Close me'"]},"multiLine":{"type":"Boolean","desc":"Put notification into multi-line mode; If this prop isn't used and more than one 'action' is specified then notification goes into multi-line mode by default"}}},"methods":{"create":{"tsInjectionPoint":true,"desc":"Creates a notification; Same as calling $q.notify(...)","params":{"opts":{"type":["Object","String"],"tsType":"QNotifyCreateOptions","autoDefineTsType":true,"required":true,"desc":"Notification options","definition":{"type":{"type":"String","desc":"Optional type (that has been previously registered) or one of the out of the box ones ('positive', 'negative', 'warning', 'info', 'ongoing')","examples":["'negative'","'custom-type'"]},"color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"textColor":{"type":"String","tsType":"NamedColor","desc":"Overrides text color (if needed); Color name from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"message":{"type":"String","desc":"The content of your message","examples":["'John Doe pinged you'"]},"caption":{"type":"String","desc":"The content of your optional caption","examples":["'5 minutes ago'"]},"html":{"type":"Boolean","desc":"Render the message as HTML; This can lead to XSS attacks, so make sure that you sanitize the message first"},"icon":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"iconColor":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style","addedIn":"v2.5.5"},"iconSize":{"type":"String","desc":"Size in CSS units, including unit name","examples":["'16px'","'2rem'"],"category":"style","addedIn":"v2.5.5"},"avatar":{"type":"String","desc":"URL to an avatar/image; Suggestion: use public folder","examples":["# (public folder) 'img/something.png'","# (relative path format) require('./my_img.jpg')","# (URL) https://some-site.net/some-img.gif"]},"spinner":{"type":["Boolean","Component"],"desc":"Useful for notifications that are updated; Displays a Quasar spinner instead of an avatar or icon; If value is Boolean 'true' then the default QSpinner is shown","examples":["true","QSpinnerBars"]},"spinnerColor":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style","addedIn":"v2.5.5"},"spinnerSize":{"type":"String","desc":"Size in CSS units, including unit name","examples":["'16px'","'2rem'"],"category":"style","addedIn":"v2.5.5"},"position":{"type":"String","desc":"Window side/corner to stick to","default":"'bottom'","values":["'top-left'","'top-right'","'bottom-left'","'bottom-right'","'top'","'bottom'","'left'","'right'","'center'"],"required":false},"group":{"type":["Boolean","String","Number"],"desc":"Override the auto generated group with custom one; Grouped notifications cannot be updated; String or number value inform this is part of a specific group, regardless of its options; When a new notification is triggered with same group name, it replaces the old one and shows a badge with how many times the notification was triggered","default":"# message + caption + multiline + actions labels + position","examples":["'my-group'"],"required":false},"badgeColor":{"type":"String","tsType":"NamedColor","desc":"Color name for the badge from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"badgeTextColor":{"type":"String","tsType":"NamedColor","desc":"Color name for the badge text from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"badgePosition":{"type":"String","desc":"Notification corner to stick badge to; If notification is on the left side then default is top-right otherwise it is top-left","default":"# top-left/top-right","values":["'top-left'","'top-right'","'bottom-left'","'bottom-right'"],"required":false},"badgeStyle":{"type":["String","Array","Object"],"tsType":"VueStyleProp","desc":"Style definitions to be attributed to the badge","examples":["'background-color: #ff0000'","{ backgroundColor: '#ff0000' }"]},"badgeClass":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"Class definitions to be attributed to the badge","examples":["'my-special-class'","{ 'my-special-class': true }"]},"progress":{"type":"Boolean","desc":"Show progress bar to detail when notification will disappear automatically (unless timeout is 0)"},"progressClass":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"Class definitions to be attributed to the progress bar","examples":["'my-special-class'","{ 'my-special-class': true }"]},"classes":{"type":"String","desc":"Add CSS class(es) to the notification for easier customization","examples":["'my-notif-class'"]},"attrs":{"type":"Object","desc":"Key-value for attributes to be set on the notification","examples":["{ role: 'alertdialog' }"]},"timeout":{"type":"Number","desc":"Amount of time to display (in milliseconds). Set to 0 to never dismiss automatically.","default":"5000","examples":["2500"],"required":false},"actions":{"type":"Array","tsType":"QNotifyAction","desc":"Notification actions (buttons); Unless 'noDismiss' is true, clicking/tapping on the button will close the notification; Also check 'closeBtn' convenience prop","definition":{"handler":{"type":"Function","desc":"Function to be executed when the button is clicked/tapped","params":null,"returns":null,"examples":["() => { console.log('button clicked') }"]},"noDismiss":{"type":"Boolean","desc":"Do not dismiss the notification when the button is clicked/tapped"},"...":{"type":"Any","desc":"Any other QBtn prop expect 'onClick' (use 'handler' instead)","examples":["label: 'Learn more'","color: 'primary'"]}},"examples":["[ { label: 'Show', handler: () => {}, 'aria-label': 'Button label' }, { icon: 'map', handler: () => {}, color: 'yellow' }, { label: 'Learn more', noDismiss: true, handler: () => {} } ]"]},"onDismiss":{"type":"Function","desc":"Function to call when notification gets dismissed","params":null,"returns":null,"examples":["() => { console.log('Dismissed') }"]},"closeBtn":{"type":["Boolean","String"],"desc":"Convenient way to add a dismiss button with a specific label, without using the 'actions' prop; If set to true, it uses a label according to the current Quasar language","examples":["'Close me'"]},"multiLine":{"type":"Boolean","desc":"Put notification into multi-line mode; If this prop isn't used and more than one 'action' is specified then notification goes into multi-line mode by default"},"ignoreDefaults":{"type":"Boolean","desc":"Ignore the default configuration (set by setDefaults()) for this instance only"}}}},"returns":{"type":"Function","desc":"Calling this function with no parameters hides the notification; When called with one Object parameter (the original notification must NOT be grouped), it updates the notification (specified properties are shallow merged with previous ones; note that group and position cannot be changed while updating and so they are ignored)","params":{"props":{"type":"Object","tsType":"QNotifyUpdateOptions","required":false,"desc":"Notification properties that will be shallow merged to previous ones in order to update the non-grouped notification; (See 'opts' param of 'create()' for object properties, except 'group' and 'position')"}},"returns":null}},"setDefaults":{"desc":"Merge options into the default ones","params":{"opts":{"type":"Object","tsType":"QNotifyOptions","required":true,"desc":"Notification options except 'ignoreDefaults' (See 'opts' param of 'create()' for object properties)"}},"returns":null},"registerType":{"desc":"Register a new type of notification (or override an existing one)","params":{"typeName":{"type":"String","required":true,"desc":"Name of the type (to be used as 'type' prop later on)","examples":["'my-type'"]},"typeOpts":{"type":"Object","tsType":"QNotifyOptions","required":true,"desc":"Notification options except 'ignoreDefaults' (See 'opts' param of 'create()' for object properties)"}},"returns":null}}}
|
package/dist/api/Platform.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"type":"plugin","meta":{"docsUrl":"https://v2.quasar.dev/options/platform-detection"},"injection":"$q.platform","props":{"userAgent":{"type":"String","desc":"Client browser User Agent","examples":["'mozilla/5.0 (macintosh; intel mac os x 10_14_5) applewebkit/537.36 (khtml, like gecko) chrome/75.0.3770.100 safari/537.36'"]},"is":{"type":"Object","desc":"Client browser details (property names depend on browser)","definition":{"name":{"type":"String","desc":"Browser name","examples":["'chrome'"]},"platform":{"type":"String","desc":"Platform name","examples":["'mac'"]},"version":{"type":"String","required":false,"desc":"Detailed browser version","examples":["'71.0.3578.98'"]},"versionNumber":{"type":"Number","required":false,"desc":"Major browser version as a number"},"desktop":{"type":"Boolean","required":false,"desc":"Whether the platform is desktop"},"mobile":{"type":"Boolean","required":false,"desc":"Whether the platform is mobile"},"electron":{"type":"Boolean","required":false,"desc":"Whether the platform is Electron"},"bex":{"type":"Boolean","required":false,"desc":"Whether the platform is BEX(Browser Extension)"},"capacitor":{"type":"Boolean","required":false,"desc":"Whether the platform is Capacitor"},"cordova":{"type":"Boolean","required":false,"desc":"Whether the platform is Cordova"},"nativeMobile":{"type":"Boolean","required":false,"desc":"Whether the platform is a native mobile wrapper"},"nativeMobileWrapper":{"type":"String","required":false,"values":["'cordova'","'capacitor'"],"desc":"Type of the native mobile wrapper"},"chrome":{"type":"Boolean","required":false,"desc":"Whether the browser is Google Chrome"},"firefox":{"type":"Boolean","required":false,"desc":"Whether the browser is Firefox"},"safari":{"type":"Boolean","required":false,"desc":"Whether the browser is Safari"},"edgeChromium":{"type":"Boolean","required":false,"desc":"Whether the browser is Microsoft Edge (Chromium)"},"edge":{"type":"Boolean","required":false,"desc":"Whether the browser is Microsoft Edge Legacy"},"opera":{"type":"Boolean","required":false,"desc":"Whether the browser is Opera"},"vivaldi":{"type":"Boolean","required":false,"desc":"Whether the browser is Vivaldi"},"win":{"type":"Boolean","required":false,"desc":"Whether the operating system is Windows"},"linux":{"type":"Boolean","required":false,"desc":"Whether the operating system is Linux"},"mac":{"type":"Boolean","required":false,"desc":"Whether the operating system is Mac OS"},"cros":{"type":"Boolean","required":false,"desc":"Whether the operating system is Chrome OS"},"android":{"type":"Boolean","required":false,"desc":"Whether the operating system is Android"},"ios":{"type":"Boolean","required":false,"desc":"Whether the operating system is iOS"},"winphone":{"type":"Boolean","required":false,"desc":"Whether the operating system is Windows Phone"},"iphone":{"type":"Boolean","required":false,"desc":"Whether the device is an iPhone"},"ipad":{"type":"Boolean","required":false,"desc":"Whether the device is an iPad"},"ipod":{"type":"Boolean","required":false,"desc":"Whether the device is an iPod"},"kindle":{"type":"Boolean","required":false,"desc":"Whether the device is a Kindle"},"silk":{"type":"Boolean","required":false,"desc":"Whether the browser is Amazon Silk"}},"examples":["{ chrome: true, version: '71.0.3578.98', versionNumber: 71, mac: true, desktop: true, webkit: true, name: 'chrome', platform: 'mac' }"]},"has":{"type":"Object","desc":"Client browser detectable properties","definition":{"touch":{"type":"Boolean","desc":"Client browser runs on device with touch support"},"webStorage":{"type":"Boolean","desc":"Client browser has Web Storage support"}},"examples":["{ touch: false, webStorage: true }"]},"within":{"type":"Object","desc":"Client browser environment","definition":{"iframe":{"type":"Boolean","desc":"Does the app run under an iframe?"}},"examples":["{ iframe: false }"]}},"methods":{"parseSSR":{"desc":"For SSR usage only, and only on the global import (not on $q.platform)","params":{"ssrContext":{"type":"Object","desc":"SSR Context Object","required":true}},"returns":{"type":"Object","tsType":"Platform","desc":"Platform object (like $q.platform) for SSR usage purposes"}}}}
|
|
1
|
+
{"type":"plugin","meta":{"docsUrl":"https://v2.quasar.dev/options/platform-detection"},"injection":"$q.platform","props":{"userAgent":{"type":"String","desc":"Client browser User Agent","examples":["'mozilla/5.0 (macintosh; intel mac os x 10_14_5) applewebkit/537.36 (khtml, like gecko) chrome/75.0.3770.100 safari/537.36'"]},"is":{"type":"Object","desc":"Client browser details (property names depend on browser)","definition":{"name":{"type":"String","desc":"Browser name","examples":["'chrome'"]},"platform":{"type":"String","desc":"Platform name","examples":["'mac'"]},"version":{"type":"String","required":false,"desc":"Detailed browser version","examples":["'71.0.3578.98'"]},"versionNumber":{"type":"Number","required":false,"desc":"Major browser version as a number"},"desktop":{"type":"Boolean","required":false,"desc":"Whether the platform is desktop"},"mobile":{"type":"Boolean","required":false,"desc":"Whether the platform is mobile"},"electron":{"type":"Boolean","required":false,"desc":"Whether the platform is Electron"},"bex":{"type":"Boolean","required":false,"desc":"Whether the platform is BEX(Browser Extension)"},"capacitor":{"type":"Boolean","required":false,"desc":"Whether the platform is Capacitor"},"cordova":{"type":"Boolean","required":false,"desc":"Whether the platform is Cordova"},"nativeMobile":{"type":"Boolean","required":false,"desc":"Whether the platform is a native mobile wrapper"},"nativeMobileWrapper":{"type":"String","required":false,"values":["'cordova'","'capacitor'"],"desc":"Type of the native mobile wrapper"},"webkit":{"type":"Boolean","required":false,"desc":"Whether the browser is a Webkit one"},"chrome":{"type":"Boolean","required":false,"desc":"Whether the browser is Google Chrome"},"firefox":{"type":"Boolean","required":false,"desc":"Whether the browser is Firefox"},"safari":{"type":"Boolean","required":false,"desc":"Whether the browser is Safari"},"edgeChromium":{"type":"Boolean","required":false,"desc":"Whether the browser is Microsoft Edge (Chromium)"},"edge":{"type":"Boolean","required":false,"desc":"Whether the browser is Microsoft Edge Legacy"},"opera":{"type":"Boolean","required":false,"desc":"Whether the browser is Opera"},"vivaldi":{"type":"Boolean","required":false,"desc":"Whether the browser is Vivaldi"},"win":{"type":"Boolean","required":false,"desc":"Whether the operating system is Windows"},"linux":{"type":"Boolean","required":false,"desc":"Whether the operating system is Linux"},"mac":{"type":"Boolean","required":false,"desc":"Whether the operating system is Mac OS"},"cros":{"type":"Boolean","required":false,"desc":"Whether the operating system is Chrome OS"},"android":{"type":"Boolean","required":false,"desc":"Whether the operating system is Android"},"ios":{"type":"Boolean","required":false,"desc":"Whether the operating system is iOS"},"winphone":{"type":"Boolean","required":false,"desc":"Whether the operating system is Windows Phone"},"iphone":{"type":"Boolean","required":false,"desc":"Whether the device is an iPhone"},"ipad":{"type":"Boolean","required":false,"desc":"Whether the device is an iPad"},"ipod":{"type":"Boolean","required":false,"desc":"Whether the device is an iPod"},"kindle":{"type":"Boolean","required":false,"desc":"Whether the device is a Kindle"},"silk":{"type":"Boolean","required":false,"desc":"Whether the browser is Amazon Silk"}},"examples":["{ chrome: true, version: '71.0.3578.98', versionNumber: 71, mac: true, desktop: true, webkit: true, name: 'chrome', platform: 'mac' }"]},"has":{"type":"Object","desc":"Client browser detectable properties","definition":{"touch":{"type":"Boolean","desc":"Client browser runs on device with touch support"},"webStorage":{"type":"Boolean","desc":"Client browser has Web Storage support"}},"examples":["{ touch: false, webStorage: true }"]},"within":{"type":"Object","desc":"Client browser environment","definition":{"iframe":{"type":"Boolean","desc":"Does the app run under an iframe?"}},"examples":["{ iframe: false }"]}},"methods":{"parseSSR":{"desc":"For SSR usage only, and only on the global import (not on $q.platform)","params":{"ssrContext":{"type":"Object","desc":"SSR Context Object","required":true}},"returns":{"type":"Object","tsType":"Platform","desc":"Platform object (like $q.platform) for SSR usage purposes"}}}}
|
package/dist/api/QAjaxBar.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/ajax-bar"},"props":{"position":{"type":"String","desc":"Position within window of where QAjaxBar should be displayed","default":"'top'","values":["'top'","'right'","'bottom'","'left'"],"category":"style","required":false},"size":{"type":"String","desc":"Size in CSS units, including unit name","examples":["'16px'","'2rem'"],"category":"style","default":"'2px'","required":false},"color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"reverse":{"type":"Boolean","desc":"Reverse direction of progress","category":"behavior"},"skip-hijack":{"type":"Boolean","desc":"Skip Ajax hijacking (not a reactive prop)","category":"behavior"},"hijack-filter":{"type":"Function","desc":"Filter which URL should trigger start() + stop()","params":{"url":{"type":"String","desc":"The URL being triggered","examples":["'https://some.url/path'"]}},"returns":{"type":"Boolean","desc":"Should the URL received as param trigger start() + stop()?"},"category":"behavior","addedIn":"v2.4.5"}},"events":{"start":{"desc":"Emitted when bar is triggered to appear"},"stop":{"desc":"Emitted when bar has finished its job"}},"methods":{"start":{"desc":"Notify bar you are waiting for a new process to finish","params":{"speed":{"type":"Number","default":"300","desc":"Delay (in milliseconds) between progress auto-increments; If delay is 0 then it disables auto-incrementing","required":false}},"returns":{"type":"Number","desc":"Number of active simultaneous sessions"}},"increment":{"desc":"Manually trigger a bar progress increment","params":{"amount":{"type":"Number","desc":"Amount (0 < x <= 100) to increment with"}},"returns":{"type":"Number","desc":"Number of active simultaneous sessions"}},"stop":{"desc":"Notify bar that one process you were waiting has finished","returns":{"type":"Number","desc":"Number of active simultaneous sessions"}}}}
|
|
1
|
+
{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/ajax-bar"},"props":{"position":{"type":"String","desc":"Position within window of where QAjaxBar should be displayed","default":"'top'","values":["'top'","'right'","'bottom'","'left'"],"category":"style","required":false},"size":{"type":"String","desc":"Size in CSS units, including unit name","examples":["'16px'","'2rem'"],"category":"style","default":"'2px'","required":false},"color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"reverse":{"type":"Boolean","desc":"Reverse direction of progress","category":"behavior"},"skip-hijack":{"type":"Boolean","desc":"Skip Ajax hijacking (not a reactive prop)","category":"behavior"},"hijack-filter":{"type":"Function","desc":"Filter which URL should trigger start() + stop()","params":{"url":{"type":"String","desc":"The URL being triggered","examples":["'https://some.url/path'"]}},"returns":{"type":"Boolean","desc":"Should the URL received as param trigger start() + stop()?"},"category":"behavior","addedIn":"v2.4.5"}},"events":{"start":{"desc":"Emitted when bar is triggered to appear"},"stop":{"desc":"Emitted when bar has finished its job"}},"methods":{"start":{"desc":"Notify bar you are waiting for a new process to finish","params":{"speed":{"type":"Number","default":"300","desc":"Delay (in milliseconds) between progress auto-increments; If delay is 0 then it disables auto-incrementing","required":false}},"returns":{"type":"Number","desc":"Number of active simultaneous sessions"}},"increment":{"desc":"Manually trigger a bar progress increment","params":{"amount":{"type":"Number","desc":"Amount (0 < x <= 100) to increment with"}},"returns":{"type":"Number","desc":"Number of active simultaneous sessions"}},"stop":{"desc":"Notify bar that one process you were waiting has finished","params":null,"returns":{"type":"Number","desc":"Number of active simultaneous sessions"}}}}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/breadcrumbs"},"props":{"to":{"type":["String","Object"],"desc":"Equivalent to Vue Router <router-link> 'to' property; Superseded by 'href' prop if used","examples":["'/home/dashboard'","{ name: 'my-route-name' }"],"category":"navigation"},"exact":{"type":"Boolean","desc":"Equivalent to Vue Router <router-link> 'exact' property; Superseded by 'href' prop if used","category":"navigation"},"replace":{"type":"Boolean","desc":"Equivalent to Vue Router <router-link> 'replace' property; Superseded by 'href' prop if used","category":"navigation"},"active-class":{"type":"String","desc":"Equivalent to Vue Router <router-link> 'active-class' property; Superseded by 'href' prop if used","examples":["'my-active-class'"],"category":"navigation"},"exact-active-class":{"type":"String","desc":"Equivalent to Vue Router <router-link> 'active-class' property; Superseded by 'href' prop if used","examples":["'my-exact-active-class'"],"category":"navigation"},"href":{"type":"String","desc":"Native <a> link href attribute; Has priority over the 'to'/'exact'/'replace'/'active-class'/'exact-active-class' props","examples":["'https://quasar.dev'"],"category":"navigation","addedIn":"v2.4"},"target":{"type":"String","desc":"Native <a> link target attribute; Use it only along with 'href' prop; Has priority over the 'to'/'exact'/'replace'/'active-class'/'exact-active-class' props","examples":["'_blank'","'_self'","'_parent'","'_top'"],"category":"navigation","addedIn":"v2.4"},"disable":{"type":"Boolean","desc":"Put component in disabled mode","category":"state"},"label":{"type":"String","desc":"The label text for the breadcrumb","examples":["'Home'","'Index'"],"category":"content"},"icon":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"tag":{"type":"String","desc":"HTML tag to use","
|
|
1
|
+
{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/breadcrumbs"},"props":{"to":{"type":["String","Object"],"desc":"Equivalent to Vue Router <router-link> 'to' property; Superseded by 'href' prop if used","examples":["'/home/dashboard'","{ name: 'my-route-name' }"],"category":"navigation"},"exact":{"type":"Boolean","desc":"Equivalent to Vue Router <router-link> 'exact' property; Superseded by 'href' prop if used","category":"navigation"},"replace":{"type":"Boolean","desc":"Equivalent to Vue Router <router-link> 'replace' property; Superseded by 'href' prop if used","category":"navigation"},"active-class":{"type":"String","desc":"Equivalent to Vue Router <router-link> 'active-class' property; Superseded by 'href' prop if used","examples":["'my-active-class'"],"category":"navigation"},"exact-active-class":{"type":"String","desc":"Equivalent to Vue Router <router-link> 'active-class' property; Superseded by 'href' prop if used","examples":["'my-exact-active-class'"],"category":"navigation"},"href":{"type":"String","desc":"Native <a> link href attribute; Has priority over the 'to'/'exact'/'replace'/'active-class'/'exact-active-class' props","examples":["'https://quasar.dev'"],"category":"navigation","addedIn":"v2.4"},"target":{"type":"String","desc":"Native <a> link target attribute; Use it only along with 'href' prop; Has priority over the 'to'/'exact'/'replace'/'active-class'/'exact-active-class' props","examples":["'_blank'","'_self'","'_parent'","'_top'"],"category":"navigation","addedIn":"v2.4"},"disable":{"type":"Boolean","desc":"Put component in disabled mode","category":"state"},"label":{"type":"String","desc":"The label text for the breadcrumb","examples":["'Home'","'Index'"],"category":"content"},"icon":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"tag":{"type":"String","desc":"HTML tag to use","category":"content","default":"'span'","examples":["'div'","'span'"],"required":false}},"slots":{"default":{"desc":"This is where custom content goes, unless 'icon' and 'label' props are not enough"}},"events":{"click":{"desc":"Emitted when the component is clicked","params":{"evt":{"type":"Event","desc":"JS event object; If you are using route navigation ('to'/'replace' props) and you want to cancel navigation then call evt.preventDefault() synchronously in your event handler"},"go":{"type":"Function","desc":"Available ONLY if you are using route navigation ('to'/'replace' props); When you need to control the time at which the component should trigger the route navigation then call evt.preventDefault() synchronously and then call this function at your convenience; Useful if you have async work to be done before the actual route navigation or if you want to redirect somewhere else","required":false,"addedIn":"v2.9","params":{"opts":{"type":"Object","desc":"Optional options","required":false,"definition":{"to":{"type":["String","Object"],"desc":"Equivalent to Vue Router <router-link> 'to' property; Specify it explicitly otherwise it will be set with same value as component's 'to' prop","required":false,"examples":["'/home/dashboard'","{ name: 'my-route-name' }"]},"replace":{"type":"Boolean","desc":"Equivalent to Vue Router <router-link> 'replace' property; Specify it explicitly otherwise it will be set with same value as component's 'replace' prop","required":false},"returnRouterError":{"type":"Boolean","desc":"Return the router error, if any; Otherwise the returned Promise will always fulfill","required":false}}}},"returns":{"type":"Promise<any>","desc":"Returns the router's navigation promise"}}}}}}
|
package/dist/api/QBtn.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/button"},"props":{"size":{"type":"String","desc":"Size in CSS units, including unit name or standard size name (xs|sm|md|lg|xl)","examples":["'16px'","'2rem'","'xs'","'md'"],"category":"style"},"type":{"type":"String","desc":"1) Define the button native type attribute (submit, reset, button) or 2) render component with <a> tag so you can access events even if disable or 3) Use 'href' prop and specify 'type' as a media tag","default":"'button'","examples":["'a'","'submit'","'button'","'reset'","'image/png'","# href=\"https://quasar.dev\" target=\"_blank\""],"category":"general","required":false},"to":{"type":["String","Object"],"desc":"Equivalent to Vue Router <router-link> 'to' property; Superseded by 'href' prop if used","examples":["'/home/dashboard'","{ name: 'my-route-name' }"],"category":"navigation"},"replace":{"type":"Boolean","desc":"Equivalent to Vue Router <router-link> 'replace' property; Superseded by 'href' prop if used","category":"navigation"},"href":{"type":"String","desc":"Native <a> link href attribute; Has priority over the 'to' and 'replace' props","examples":["'https://quasar.dev'","# href=\"https://quasar.dev\" target=\"_blank\""],"category":"navigation","addedIn":"v2.4"},"target":{"type":"String","desc":"Native <a> link target attribute; Use it only with 'to' or 'href' props","examples":["'_blank'","'_self'","'_parent'","'_top'"],"category":"navigation","addedIn":"v2.4"},"label":{"type":["String","Number"],"desc":"The text that will be shown on the button","examples":["'Button Label'"],"category":"content"},"icon":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"icon-right":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"outline":{"type":"Boolean","desc":"Use 'outline' design","category":"style"},"flat":{"type":"Boolean","desc":"Use 'flat' design","category":"style"},"unelevated":{"type":"Boolean","desc":"Remove shadow","category":"style"},"rounded":{"type":"Boolean","desc":"Applies a more prominent border-radius for a squared shape button","category":"style"},"push":{"type":"Boolean","desc":"Use 'push' design","category":"style"},"square":{"type":"Boolean","desc":"Removes border-radius so borders are squared","category":"style","addedIn":"v2.7.6"},"glossy":{"type":"Boolean","desc":"Applies a glossy effect","category":"style"},"fab":{"type":"Boolean","desc":"Makes button size and shape to fit a Floating Action Button","category":"style"},"fab-mini":{"type":"Boolean","desc":"Makes button size and shape to fit a small Floating Action Button","category":"style"},"padding":{"type":"String","desc":"Apply custom padding (vertical [horizontal]); Size in CSS units, including unit name or standard size name (none|xs|sm|md|lg|xl); Also removes the min width and height when set","examples":["'16px'","'10px 5px'","'2rem'","'xs'","'md lg'","'2px 2px 5px 7px'"],"category":"style"},"color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"text-color":{"type":"String","tsType":"NamedColor","desc":"Overrides text color (if needed); Color name from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"no-caps":{"type":"Boolean","desc":"Avoid turning label text into caps (which happens by default)","category":"content"},"no-wrap":{"type":"Boolean","desc":"Avoid label text wrapping","category":"content"},"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style"},"ripple":{"type":["Boolean","Object"],"desc":"Configure material ripple (disable it by setting it to 'false' or supply a config object)","default":"true","examples":["false","{ early: true, center: true, color: 'teal', keyCodes: [] }"],"category":"style","required":false},"tabindex":{"type":["Number","String"],"desc":"Tabindex HTML attribute value","examples":["100","'0'"],"category":"general"},"align":{"type":"String","desc":"Label or content alignment","default":"'center'","values":["'left'","'right'","'center'","'around'","'between'","'evenly'"],"category":"content","required":false},"stack":{"type":"Boolean","desc":"Stack icon and label vertically instead of on same line (like it is by default)","category":"content"},"stretch":{"type":"Boolean","desc":"When used on flexbox parent, button will stretch to parent's height","category":"content"},"loading":{"type":["Boolean","null"],"default":"null","desc":"Put button into loading state (displays a QSpinner -- can be overridden by using a 'loading' slot)","category":"behavior|state","required":false},"disable":{"type":"Boolean","desc":"Put component in disabled mode","category":"state"},"round":{"type":"Boolean","desc":"Makes a circle shaped button","category":"style"},"percentage":{"type":"Number","desc":"Percentage (0.0 < x < 100.0); To be used along 'loading' prop; Display a progress bar on the background","category":"behavior"},"dark-percentage":{"type":"Boolean","desc":"Progress bar on the background should have dark color; To be used along with 'percentage' and 'loading' props","category":"behavior"}},"slots":{"default":{"desc":"Use for custom content, instead of relying on 'icon' and 'label' props"},"loading":{"desc":"Override the default QSpinner when in 'loading' state"}},"events":{"click":{"desc":"Emitted when the component is clicked","params":{"evt":{"type":"Event","desc":"JS event object; If you are using route navigation ('to'/'replace' props) and you want to cancel navigation then call evt.preventDefault() synchronously in your event handler"},"go":{"type":"Function","desc":"Available ONLY if you are using route navigation ('to'/'replace' props); When you need to control the time at which the component should trigger the route navigation then call evt.preventDefault() synchronously and then call this function at your convenience; Useful if you have async work to be done before the actual route navigation or if you want to redirect somewhere else","required":false,"addedIn":"v2.9","params":{"opts":{"type":"Object","desc":"Optional options","required":false,"definition":{"to":{"type":["String","Object"],"desc":"Equivalent to Vue Router <router-link> 'to' property; Specify it explicitly otherwise it will be set with same value as component's 'to' prop","required":false,"examples":["'/home/dashboard'","{ name: 'my-route-name' }"]},"replace":{"type":"Boolean","desc":"Equivalent to Vue Router <router-link> 'replace' property; Specify it explicitly otherwise it will be set with same value as component's 'replace' prop","required":false},"returnRouterError":{"type":"Boolean","desc":"Return the router error, if any; Otherwise the returned Promise will always fulfill","required":false}}}},"returns":{"type":"Promise<any>","desc":"Returns the router's navigation promise"}}}}},"methods":{"click":{"desc":"Emulate click on QBtn","params":{"evt":{"type":"Event","desc":"JS event object"}}}}}
|
|
1
|
+
{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/button"},"props":{"size":{"type":"String","desc":"Size in CSS units, including unit name or standard size name (xs|sm|md|lg|xl)","examples":["'16px'","'2rem'","'xs'","'md'"],"category":"style"},"type":{"type":"String","desc":"1) Define the button native type attribute (submit, reset, button) or 2) render component with <a> tag so you can access events even if disable or 3) Use 'href' prop and specify 'type' as a media tag","default":"'button'","examples":["'a'","'submit'","'button'","'reset'","'image/png'","# href=\"https://quasar.dev\" target=\"_blank\""],"category":"general","required":false},"to":{"type":["String","Object"],"desc":"Equivalent to Vue Router <router-link> 'to' property; Superseded by 'href' prop if used","examples":["'/home/dashboard'","{ name: 'my-route-name' }"],"category":"navigation"},"replace":{"type":"Boolean","desc":"Equivalent to Vue Router <router-link> 'replace' property; Superseded by 'href' prop if used","category":"navigation"},"href":{"type":"String","desc":"Native <a> link href attribute; Has priority over the 'to' and 'replace' props","examples":["'https://quasar.dev'","# href=\"https://quasar.dev\" target=\"_blank\""],"category":"navigation","addedIn":"v2.4"},"target":{"type":"String","desc":"Native <a> link target attribute; Use it only with 'to' or 'href' props","examples":["'_blank'","'_self'","'_parent'","'_top'"],"category":"navigation","addedIn":"v2.4"},"label":{"type":["String","Number"],"desc":"The text that will be shown on the button","examples":["'Button Label'"],"category":"content"},"icon":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"icon-right":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"outline":{"type":"Boolean","desc":"Use 'outline' design","category":"style"},"flat":{"type":"Boolean","desc":"Use 'flat' design","category":"style"},"unelevated":{"type":"Boolean","desc":"Remove shadow","category":"style"},"rounded":{"type":"Boolean","desc":"Applies a more prominent border-radius for a squared shape button","category":"style"},"push":{"type":"Boolean","desc":"Use 'push' design","category":"style"},"square":{"type":"Boolean","desc":"Removes border-radius so borders are squared","category":"style","addedIn":"v2.7.6"},"glossy":{"type":"Boolean","desc":"Applies a glossy effect","category":"style"},"fab":{"type":"Boolean","desc":"Makes button size and shape to fit a Floating Action Button","category":"style"},"fab-mini":{"type":"Boolean","desc":"Makes button size and shape to fit a small Floating Action Button","category":"style"},"padding":{"type":"String","desc":"Apply custom padding (vertical [horizontal]); Size in CSS units, including unit name or standard size name (none|xs|sm|md|lg|xl); Also removes the min width and height when set","examples":["'16px'","'10px 5px'","'2rem'","'xs'","'md lg'","'2px 2px 5px 7px'"],"category":"style"},"color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"text-color":{"type":"String","tsType":"NamedColor","desc":"Overrides text color (if needed); Color name from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"no-caps":{"type":"Boolean","desc":"Avoid turning label text into caps (which happens by default)","category":"content"},"no-wrap":{"type":"Boolean","desc":"Avoid label text wrapping","category":"content"},"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style"},"ripple":{"type":["Boolean","Object"],"desc":"Configure material ripple (disable it by setting it to 'false' or supply a config object)","default":"true","examples":["false","{ early: true, center: true, color: 'teal', keyCodes: [] }"],"category":"style","required":false},"tabindex":{"type":["Number","String"],"desc":"Tabindex HTML attribute value","examples":["100","'0'"],"category":"general"},"align":{"type":"String","desc":"Label or content alignment","default":"'center'","values":["'left'","'right'","'center'","'around'","'between'","'evenly'"],"category":"content","required":false},"stack":{"type":"Boolean","desc":"Stack icon and label vertically instead of on same line (like it is by default)","category":"content"},"stretch":{"type":"Boolean","desc":"When used on flexbox parent, button will stretch to parent's height","category":"content"},"loading":{"type":["Boolean","null"],"default":"null","desc":"Put button into loading state (displays a QSpinner -- can be overridden by using a 'loading' slot)","category":"behavior|state","required":false},"disable":{"type":"Boolean","desc":"Put component in disabled mode","category":"state"},"round":{"type":"Boolean","desc":"Makes a circle shaped button","category":"style"},"percentage":{"type":"Number","desc":"Percentage (0.0 < x < 100.0); To be used along 'loading' prop; Display a progress bar on the background","category":"behavior"},"dark-percentage":{"type":"Boolean","desc":"Progress bar on the background should have dark color; To be used along with 'percentage' and 'loading' props","category":"behavior"}},"slots":{"default":{"desc":"Use for custom content, instead of relying on 'icon' and 'label' props"},"loading":{"desc":"Override the default QSpinner when in 'loading' state"}},"events":{"click":{"desc":"Emitted when the component is clicked","params":{"evt":{"type":"Event","desc":"JS event object; If you are using route navigation ('to'/'replace' props) and you want to cancel navigation then call evt.preventDefault() synchronously in your event handler"},"go":{"type":"Function","desc":"Available ONLY if you are using route navigation ('to'/'replace' props); When you need to control the time at which the component should trigger the route navigation then call evt.preventDefault() synchronously and then call this function at your convenience; Useful if you have async work to be done before the actual route navigation or if you want to redirect somewhere else","required":false,"addedIn":"v2.9","params":{"opts":{"type":"Object","desc":"Optional options","required":false,"definition":{"to":{"type":["String","Object"],"desc":"Equivalent to Vue Router <router-link> 'to' property; Specify it explicitly otherwise it will be set with same value as component's 'to' prop","required":false,"examples":["'/home/dashboard'","{ name: 'my-route-name' }"]},"replace":{"type":"Boolean","desc":"Equivalent to Vue Router <router-link> 'replace' property; Specify it explicitly otherwise it will be set with same value as component's 'replace' prop","required":false},"returnRouterError":{"type":"Boolean","desc":"Return the router error, if any; Otherwise the returned Promise will always fulfill","required":false}}}},"returns":{"type":"Promise<any>","desc":"Returns the router's navigation promise"}}}}},"methods":{"click":{"desc":"Emulate click on QBtn","params":{"evt":{"type":"Event","desc":"JS event object"}},"returns":null}}}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/button-dropdown"},"props":{"transition-show":{"type":"String","desc":"One of Quasar's embedded transitions","examples":["'fade'","'slide-down'"],"category":"transition","default":"'fade'","required":false},"transition-hide":{"type":"String","desc":"One of Quasar's embedded transitions","examples":["'fade'","'slide-down'"],"category":"transition","default":"'fade'","required":false},"transition-duration":{"type":["String","Number"],"desc":"Transition duration (in milliseconds, without unit)","default":"300","category":"transition","required":false},"model-value":{"desc":"Controls Menu show/hidden state; Either use this property (along with a listener for 'update:modelValue' event) OR use v-model directive","required":false,"syncable":true,"category":"model","type":"Boolean","examples":["# v-model=\"menuState\""]},"size":{"type":"String","desc":"Size in CSS units, including unit name or standard size name (xs|sm|md|lg|xl)","examples":["'16px'","'2rem'","'xs'","'md'"],"category":"style"},"type":{"type":"String","desc":"1) Define the button native type attribute (submit, reset, button) or 2) render component with <a> tag so you can access events even if disable or 3) Use 'href' prop and specify 'type' as a media tag","default":"'button'","examples":["'a'","'submit'","'button'","'reset'","'image/png'","# href=\"https://quasar.dev\" target=\"_blank\""],"category":"general","required":false},"to":{"type":["String","Object"],"desc":"Equivalent to Vue Router <router-link> 'to' property; Superseded by 'href' prop if used","examples":["'/home/dashboard'","{ name: 'my-route-name' }"],"category":"navigation"},"replace":{"type":"Boolean","desc":"Equivalent to Vue Router <router-link> 'replace' property; Superseded by 'href' prop if used","category":"navigation"},"href":{"type":"String","desc":"Native <a> link href attribute; Has priority over the 'to' and 'replace' props","examples":["'https://quasar.dev'","# href=\"https://quasar.dev\" target=\"_blank\""],"category":"navigation","addedIn":"v2.4"},"target":{"type":"String","desc":"Native <a> link target attribute; Use it only with 'to' or 'href' props","examples":["'_blank'","'_self'","'_parent'","'_top'"],"category":"navigation","addedIn":"v2.4"},"label":{"type":["String","Number"],"desc":"The text that will be shown on the button","examples":["'Button Label'"],"category":"content"},"icon":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"icon-right":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"outline":{"type":"Boolean","desc":"Use 'outline' design","category":"style"},"flat":{"type":"Boolean","desc":"Use 'flat' design","category":"style"},"unelevated":{"type":"Boolean","desc":"Remove shadow","category":"style"},"rounded":{"type":"Boolean","desc":"Applies a more prominent border-radius for a squared shape button","category":"style"},"push":{"type":"Boolean","desc":"Use 'push' design","category":"style"},"square":{"type":"Boolean","desc":"Removes border-radius so borders are squared","category":"style","addedIn":"v2.7.6"},"glossy":{"type":"Boolean","desc":"Applies a glossy effect","category":"style"},"fab":{"type":"Boolean","desc":"Makes button size and shape to fit a Floating Action Button","category":"style"},"fab-mini":{"type":"Boolean","desc":"Makes button size and shape to fit a small Floating Action Button","category":"style"},"padding":{"type":"String","desc":"Apply custom padding (vertical [horizontal]); Size in CSS units, including unit name or standard size name (none|xs|sm|md|lg|xl); Also removes the min width and height when set","examples":["'16px'","'10px 5px'","'2rem'","'xs'","'md lg'","'2px 2px 5px 7px'"],"category":"style"},"color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"text-color":{"type":"String","tsType":"NamedColor","desc":"Overrides text color (if needed); Color name from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"no-caps":{"type":"Boolean","desc":"Avoid turning label text into caps (which happens by default)","category":"content"},"no-wrap":{"type":"Boolean","desc":"Avoid label text wrapping","category":"content"},"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style"},"ripple":{"type":["Boolean","Object"],"desc":"Configure material ripple (disable it by setting it to 'false' or supply a config object)","default":"true","examples":["false","{ early: true, center: true, color: 'teal', keyCodes: [] }"],"category":"style","required":false},"tabindex":{"type":["Number","String"],"desc":"Tabindex HTML attribute value","examples":["100","'0'"],"category":"general"},"align":{"type":"String","desc":"Label or content alignment","default":"'center'","values":["'left'","'right'","'center'","'around'","'between'","'evenly'"],"category":"content","required":false},"stack":{"type":"Boolean","desc":"Stack icon and label vertically instead of on same line (like it is by default)","category":"content"},"stretch":{"type":"Boolean","desc":"When used on flexbox parent, button will stretch to parent's height","category":"content"},"loading":{"type":["Boolean","null"],"default":"null","desc":"Put button into loading state (displays a QSpinner -- can be overridden by using a 'loading' slot)","category":"behavior|state","required":false},"disable":{"type":"Boolean","desc":"Put component in disabled mode","category":"state"},"split":{"type":"Boolean","desc":"Split dropdown icon into its own button","category":"content|behavior"},"dropdown-icon":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"disable-main-btn":{"type":"Boolean","desc":"Disable main button (useful along with 'split' prop)","category":"behavior"},"disable-dropdown":{"type":"Boolean","desc":"Disables dropdown (dropdown button if using along 'split' prop)","category":"behavior"},"no-icon-animation":{"type":"Boolean","desc":"Disables the rotation of the dropdown icon when state is toggled","category":"style"},"content-style":{"type":["String","Array","Object"],"tsType":"VueStyleProp","desc":"Style definitions to be attributed to the menu","examples":["'background-color: #ff0000'","{ backgroundColor: '#ff0000' }"],"category":"style"},"content-class":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"Class definitions to be attributed to the menu","examples":["'my-special-class'","{ 'my-special-class': <condition> }"],"category":"style"},"cover":{"type":"Boolean","desc":"Allows the menu to cover the button. When used, the 'menu-self' and 'menu-fit' props are no longer effective","category":"position"},"persistent":{"type":"Boolean","desc":"Allows the menu to not be dismissed by a click/tap outside of the menu or by hitting the ESC key; Also, an app route change won't dismiss it","category":"behavior"},"no-route-dismiss":{"type":"Boolean","desc":"Changing route app won't dismiss the popup; No need to set it if 'persistent' prop is also set","category":"behavior"},"auto-close":{"type":"Boolean","desc":"Allows any click/tap in the menu to close it; Useful instead of attaching events to each menu item that should close the menu on click/tap","category":"behavior"},"menu-anchor":{"type":"String","desc":"Two values setting the starting position or anchor point of the menu relative to its target","values":["'top left'","'top middle'","'top right'","'top start'","'top end'","'center left'","'center middle'","'center right'","'center start'","'center end'","'bottom left'","'bottom middle'","'bottom right'","'bottom start'","'bottom end'"],"default":"'bottom end'","category":"position","required":false},"menu-self":{"type":"String","desc":"Two values setting the menu's own position relative to its target","values":["'top left'","'top middle'","'top right'","'top start'","'top end'","'center left'","'center middle'","'center right'","'center start'","'center end'","'bottom left'","'bottom middle'","'bottom right'","'bottom start'","'bottom end'"],"default":"'top end'","category":"position","required":false},"menu-offset":{"type":"Array","desc":"An array of two numbers to offset the menu horizontally and vertically in pixels","examples":["[8, 8]","[5, 10]"],"category":"position"},"toggle-aria-label":{"type":"String","desc":"aria-label to be used on the dropdown toggle element","examples":["'Open menu'"],"category":"accessibility","addedIn":"v2.8.4"}},"slots":{"default":{"desc":"Default slot in the devland unslotted content of the component"},"label":{"desc":"Customize main button's content through this slot, unless you're using the 'icon' and 'label' props"},"loading":{"desc":"Override the default QSpinner when in 'loading' state","addedIn":"v2.8"}},"events":{"update:model-value":{"desc":"Emitted when showing/hidden state changes; Is also used by v-model","params":{"value":{"type":"Boolean","desc":"New state (showing/hidden)"}}},"show":{"desc":"Emitted after component has triggered show()","params":{"evt":{"type":"Event","desc":"JS event object","required":true}}},"before-show":{"desc":"Emitted when component triggers show() but before it finishes doing it","params":{"evt":{"type":"Event","desc":"JS event object","required":true}}},"hide":{"desc":"Emitted after component has triggered hide()","params":{"evt":{"type":"Event","desc":"JS event object","required":true}}},"before-hide":{"desc":"Emitted when component triggers hide() but before it finishes doing it","params":{"evt":{"type":"Event","desc":"JS event object","required":true}}},"click":{"desc":"Emitted when user clicks/taps on the main button (not the icon one, if using 'split')","params":{"evt":{"type":"Event","desc":"JS event object","required":true}}}},"methods":{"show":{"desc":"Triggers component to show","params":{"evt":{"type":"Event","desc":"JS event object","required":false}}},"hide":{"desc":"Triggers component to hide","params":{"evt":{"type":"Event","desc":"JS event object","required":false}}},"toggle":{"params":{"evt":{"type":"Event","desc":"JS event object","required":false}},"desc":"Triggers component to toggle between show/hide"}}}
|
|
1
|
+
{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/button-dropdown"},"props":{"transition-show":{"type":"String","desc":"One of Quasar's embedded transitions","examples":["'fade'","'slide-down'"],"category":"transition","default":"'fade'","required":false},"transition-hide":{"type":"String","desc":"One of Quasar's embedded transitions","examples":["'fade'","'slide-down'"],"category":"transition","default":"'fade'","required":false},"transition-duration":{"type":["String","Number"],"desc":"Transition duration (in milliseconds, without unit)","default":"300","category":"transition","required":false},"model-value":{"desc":"Controls Menu show/hidden state; Either use this property (along with a listener for 'update:modelValue' event) OR use v-model directive","required":false,"syncable":true,"category":"model","type":"Boolean","examples":["# v-model=\"menuState\""]},"size":{"type":"String","desc":"Size in CSS units, including unit name or standard size name (xs|sm|md|lg|xl)","examples":["'16px'","'2rem'","'xs'","'md'"],"category":"style"},"type":{"type":"String","desc":"1) Define the button native type attribute (submit, reset, button) or 2) render component with <a> tag so you can access events even if disable or 3) Use 'href' prop and specify 'type' as a media tag","default":"'button'","examples":["'a'","'submit'","'button'","'reset'","'image/png'","# href=\"https://quasar.dev\" target=\"_blank\""],"category":"general","required":false},"to":{"type":["String","Object"],"desc":"Equivalent to Vue Router <router-link> 'to' property; Superseded by 'href' prop if used","examples":["'/home/dashboard'","{ name: 'my-route-name' }"],"category":"navigation"},"replace":{"type":"Boolean","desc":"Equivalent to Vue Router <router-link> 'replace' property; Superseded by 'href' prop if used","category":"navigation"},"href":{"type":"String","desc":"Native <a> link href attribute; Has priority over the 'to' and 'replace' props","examples":["'https://quasar.dev'","# href=\"https://quasar.dev\" target=\"_blank\""],"category":"navigation","addedIn":"v2.4"},"target":{"type":"String","desc":"Native <a> link target attribute; Use it only with 'to' or 'href' props","examples":["'_blank'","'_self'","'_parent'","'_top'"],"category":"navigation","addedIn":"v2.4"},"label":{"type":["String","Number"],"desc":"The text that will be shown on the button","examples":["'Button Label'"],"category":"content"},"icon":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"icon-right":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"outline":{"type":"Boolean","desc":"Use 'outline' design","category":"style"},"flat":{"type":"Boolean","desc":"Use 'flat' design","category":"style"},"unelevated":{"type":"Boolean","desc":"Remove shadow","category":"style"},"rounded":{"type":"Boolean","desc":"Applies a more prominent border-radius for a squared shape button","category":"style"},"push":{"type":"Boolean","desc":"Use 'push' design","category":"style"},"square":{"type":"Boolean","desc":"Removes border-radius so borders are squared","category":"style","addedIn":"v2.7.6"},"glossy":{"type":"Boolean","desc":"Applies a glossy effect","category":"style"},"fab":{"type":"Boolean","desc":"Makes button size and shape to fit a Floating Action Button","category":"style"},"fab-mini":{"type":"Boolean","desc":"Makes button size and shape to fit a small Floating Action Button","category":"style"},"padding":{"type":"String","desc":"Apply custom padding (vertical [horizontal]); Size in CSS units, including unit name or standard size name (none|xs|sm|md|lg|xl); Also removes the min width and height when set","examples":["'16px'","'10px 5px'","'2rem'","'xs'","'md lg'","'2px 2px 5px 7px'"],"category":"style"},"color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"text-color":{"type":"String","tsType":"NamedColor","desc":"Overrides text color (if needed); Color name from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"no-caps":{"type":"Boolean","desc":"Avoid turning label text into caps (which happens by default)","category":"content"},"no-wrap":{"type":"Boolean","desc":"Avoid label text wrapping","category":"content"},"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style"},"ripple":{"type":["Boolean","Object"],"desc":"Configure material ripple (disable it by setting it to 'false' or supply a config object)","default":"true","examples":["false","{ early: true, center: true, color: 'teal', keyCodes: [] }"],"category":"style","required":false},"tabindex":{"type":["Number","String"],"desc":"Tabindex HTML attribute value","examples":["100","'0'"],"category":"general"},"align":{"type":"String","desc":"Label or content alignment","default":"'center'","values":["'left'","'right'","'center'","'around'","'between'","'evenly'"],"category":"content","required":false},"stack":{"type":"Boolean","desc":"Stack icon and label vertically instead of on same line (like it is by default)","category":"content"},"stretch":{"type":"Boolean","desc":"When used on flexbox parent, button will stretch to parent's height","category":"content"},"loading":{"type":["Boolean","null"],"default":"null","desc":"Put button into loading state (displays a QSpinner -- can be overridden by using a 'loading' slot)","category":"behavior|state","required":false},"disable":{"type":"Boolean","desc":"Put component in disabled mode","category":"state"},"split":{"type":"Boolean","desc":"Split dropdown icon into its own button","category":"content|behavior"},"dropdown-icon":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"disable-main-btn":{"type":"Boolean","desc":"Disable main button (useful along with 'split' prop)","category":"behavior"},"disable-dropdown":{"type":"Boolean","desc":"Disables dropdown (dropdown button if using along 'split' prop)","category":"behavior"},"no-icon-animation":{"type":"Boolean","desc":"Disables the rotation of the dropdown icon when state is toggled","category":"style"},"content-style":{"type":["String","Array","Object"],"tsType":"VueStyleProp","desc":"Style definitions to be attributed to the menu","examples":["'background-color: #ff0000'","{ backgroundColor: '#ff0000' }"],"category":"style"},"content-class":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"Class definitions to be attributed to the menu","examples":["'my-special-class'","{ 'my-special-class': true }"],"category":"style"},"cover":{"type":"Boolean","desc":"Allows the menu to cover the button. When used, the 'menu-self' and 'menu-fit' props are no longer effective","category":"position"},"persistent":{"type":"Boolean","desc":"Allows the menu to not be dismissed by a click/tap outside of the menu or by hitting the ESC key; Also, an app route change won't dismiss it","category":"behavior"},"no-route-dismiss":{"type":"Boolean","desc":"Changing route app won't dismiss the popup; No need to set it if 'persistent' prop is also set","category":"behavior"},"auto-close":{"type":"Boolean","desc":"Allows any click/tap in the menu to close it; Useful instead of attaching events to each menu item that should close the menu on click/tap","category":"behavior"},"menu-anchor":{"type":"String","desc":"Two values setting the starting position or anchor point of the menu relative to its target","values":["'top left'","'top middle'","'top right'","'top start'","'top end'","'center left'","'center middle'","'center right'","'center start'","'center end'","'bottom left'","'bottom middle'","'bottom right'","'bottom start'","'bottom end'"],"default":"'bottom end'","category":"position","required":false},"menu-self":{"type":"String","desc":"Two values setting the menu's own position relative to its target","values":["'top left'","'top middle'","'top right'","'top start'","'top end'","'center left'","'center middle'","'center right'","'center start'","'center end'","'bottom left'","'bottom middle'","'bottom right'","'bottom start'","'bottom end'"],"default":"'top end'","category":"position","required":false},"menu-offset":{"type":"Array","desc":"An array of two numbers to offset the menu horizontally and vertically in pixels","examples":["[ 8, 8 ]","[ 5, 10 ]"],"category":"position"},"toggle-aria-label":{"type":"String","desc":"aria-label to be used on the dropdown toggle element","examples":["'Open menu'"],"category":"accessibility","addedIn":"v2.8.4"}},"slots":{"default":{"desc":"Default slot in the devland unslotted content of the component"},"label":{"desc":"Customize main button's content through this slot, unless you're using the 'icon' and 'label' props"},"loading":{"desc":"Override the default QSpinner when in 'loading' state","addedIn":"v2.8"}},"events":{"update:model-value":{"desc":"Emitted when showing/hidden state changes; Is also used by v-model","params":{"value":{"type":"Boolean","desc":"New state (showing/hidden)"}}},"show":{"desc":"Emitted after component has triggered show()","params":{"evt":{"type":"Event","desc":"JS event object","required":true}}},"before-show":{"desc":"Emitted when component triggers show() but before it finishes doing it","params":{"evt":{"type":"Event","desc":"JS event object","required":true}}},"hide":{"desc":"Emitted after component has triggered hide()","params":{"evt":{"type":"Event","desc":"JS event object","required":true}}},"before-hide":{"desc":"Emitted when component triggers hide() but before it finishes doing it","params":{"evt":{"type":"Event","desc":"JS event object","required":true}}},"click":{"desc":"Emitted when user clicks/taps on the main button (not the icon one, if using 'split')","params":{"evt":{"type":"Event","desc":"JS event object","required":true}}}},"methods":{"show":{"desc":"Triggers component to show","params":{"evt":{"type":"Event","desc":"JS event object","required":false}},"returns":null},"hide":{"desc":"Triggers component to hide","params":{"evt":{"type":"Event","desc":"JS event object","required":false}},"returns":null},"toggle":{"desc":"Triggers component to toggle between show/hide","params":{"evt":{"type":"Event","desc":"JS event object","required":false}},"returns":null}}}
|
package/dist/api/QBtnToggle.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/button-toggle"},"props":{"name":{"type":"String","desc":"Used to specify the name of the control; Useful if dealing with forms submitted directly to a URL","examples":["'car_id'"],"category":"behavior"},"model-value":{"desc":"Model of the component; Either use this property (along with a listener for 'update:modelValue' event) OR use v-model directive","required":true,"syncable":true,"category":"model","type":"Any","examples":["# v-model=\"selected\""]},"options":{"type":"Array","desc":"Array of Objects defining each option","required":true,"definition":{"attrs":{"type":"Object","desc":"Key-value for attributes to be set on the button","examples":["{ 'aria-label': 'Button label' }"]},"label":{"type":"String","desc":"Label of option button; Use this prop and/or 'icon', but at least one is required","examples":["'Option 1'"]},"icon":{"type":"String","desc":"Icon of option button; Use this prop and/or 'label', but at least one is required","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"value":{"type":"Any","desc":"Value of the option that will be used by component model","required":true},"slot":{"type":"String","desc":"Slot name to use for this button content; Useful for customizing content or even add tooltips","examples":["'mySlot'"]},"...props":{"type":"Any","desc":"Any other QBtn props (including class and style)"}},"examples":["[ {label: 'One', value: 'one'}, {label: 'Two', value: 'two'} ]"],"category":"model"},"color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"text-color":{"type":"String","tsType":"NamedColor","desc":"Overrides text color (if needed); Color name from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"toggle-color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style","default":"'primary'","required":false},"toggle-text-color":{"type":"String","tsType":"NamedColor","desc":"Overrides text color (if needed); Color name from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"spread":{"type":"Boolean","desc":"Spread horizontally to all available space","category":"content"},"outline":{"type":"Boolean","desc":"Use 'outline' design","category":"style"},"flat":{"type":"Boolean","desc":"Use 'flat' design","category":"style"},"unelevated":{"type":"Boolean","desc":"Remove shadow","category":"style"},"rounded":{"type":"Boolean","desc":"Applies a more prominent border-radius for a squared shape button","category":"style"},"push":{"type":"Boolean","desc":"Use 'push' design","category":"style"},"glossy":{"type":"Boolean","desc":"Applies a glossy effect","category":"style"},"size":{"type":"String","desc":"Button size name or a CSS unit including unit name","examples":["'xs'","'sm'","'md'","'lg'","'xl'","'25px'","'2rem'"],"category":"style"},"padding":{"type":"String","desc":"Apply custom padding (vertical [horizontal]); Size in CSS units, including unit name or standard size name (none|xs|sm|md|lg|xl); Also removes the min width and height when set","examples":["'16px'","'10px 5px'","'2rem'","'xs'","'md lg'","'2px 2px 5px 7px'"],"category":"style"},"no-caps":{"type":"Boolean","desc":"Avoid turning label text into caps (which happens by default)","category":"content"},"no-wrap":{"type":"Boolean","desc":"Avoid label text wrapping","category":"content"},"ripple":{"type":["Boolean","Object"],"desc":"Configure material ripple (disable it by setting it to 'false' or supply a config object)","default":"true","examples":["false","{ early: true, center: true, color: 'teal', keyCodes: [] }"],"category":"style","required":false},"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style"},"readonly":{"type":"Boolean","desc":"Put component in readonly mode","category":"state"},"disable":{"type":"Boolean","desc":"Put component in disabled mode","category":"state"},"stack":{"type":"Boolean","desc":"Stack icon and label vertically instead of on same line (like it is by default)","category":"content"},"stretch":{"type":"Boolean","desc":"When used on flexbox parent, button will stretch to parent's height","category":"content"},"clearable":{"type":"Boolean","desc":"Clears model on click of the already selected button","category":"model"}},"slots":{"default":{"desc":"Suggestions: QTooltip, QBadge"},"...":{"desc":"Any other dynamic slots to be used with 'slot' property of the 'options' prop"}},"events":{"update:model-value":{"desc":"Emitted when the component needs to change the model; Is also used by v-model","params":{"value":{"type":"Any","desc":"New model value","required":true}}},"clear":{"desc":"When using the 'clearable' property, this event is emitted when the already selected button is clicked"}}}
|
|
1
|
+
{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/button-toggle"},"props":{"name":{"type":"String","desc":"Used to specify the name of the control; Useful if dealing with forms submitted directly to a URL","examples":["'car_id'"],"category":"behavior"},"model-value":{"desc":"Model of the component; Either use this property (along with a listener for 'update:modelValue' event) OR use v-model directive","required":true,"syncable":true,"category":"model","type":"Any","examples":["# v-model=\"selected\""]},"options":{"type":"Array","desc":"Array of Objects defining each option","required":true,"definition":{"attrs":{"type":"Object","desc":"Key-value for attributes to be set on the button","examples":["{ 'aria-label': 'Button label' }"]},"label":{"type":"String","desc":"Label of option button; Use this prop and/or 'icon', but at least one is required","examples":["'Option 1'"]},"icon":{"type":"String","desc":"Icon of option button; Use this prop and/or 'label', but at least one is required","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"value":{"type":"Any","desc":"Value of the option that will be used by component model","required":true},"slot":{"type":"String","desc":"Slot name to use for this button content; Useful for customizing content or even add tooltips","examples":["'mySlot'"]},"...props":{"type":"Any","desc":"Any other QBtn props (including class and style)"}},"examples":["[ { label: 'One', value: 'one' }, { label: 'Two', value: 'two' } ]"],"category":"model"},"color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"text-color":{"type":"String","tsType":"NamedColor","desc":"Overrides text color (if needed); Color name from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"toggle-color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style","default":"'primary'","required":false},"toggle-text-color":{"type":"String","tsType":"NamedColor","desc":"Overrides text color (if needed); Color name from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"spread":{"type":"Boolean","desc":"Spread horizontally to all available space","category":"content"},"outline":{"type":"Boolean","desc":"Use 'outline' design","category":"style"},"flat":{"type":"Boolean","desc":"Use 'flat' design","category":"style"},"unelevated":{"type":"Boolean","desc":"Remove shadow","category":"style"},"rounded":{"type":"Boolean","desc":"Applies a more prominent border-radius for a squared shape button","category":"style"},"push":{"type":"Boolean","desc":"Use 'push' design","category":"style"},"glossy":{"type":"Boolean","desc":"Applies a glossy effect","category":"style"},"size":{"type":"String","desc":"Button size name or a CSS unit including unit name","examples":["'xs'","'sm'","'md'","'lg'","'xl'","'25px'","'2rem'"],"category":"style"},"padding":{"type":"String","desc":"Apply custom padding (vertical [horizontal]); Size in CSS units, including unit name or standard size name (none|xs|sm|md|lg|xl); Also removes the min width and height when set","examples":["'16px'","'10px 5px'","'2rem'","'xs'","'md lg'","'2px 2px 5px 7px'"],"category":"style"},"no-caps":{"type":"Boolean","desc":"Avoid turning label text into caps (which happens by default)","category":"content"},"no-wrap":{"type":"Boolean","desc":"Avoid label text wrapping","category":"content"},"ripple":{"type":["Boolean","Object"],"desc":"Configure material ripple (disable it by setting it to 'false' or supply a config object)","default":"true","examples":["false","{ early: true, center: true, color: 'teal', keyCodes: [] }"],"category":"style","required":false},"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style"},"readonly":{"type":"Boolean","desc":"Put component in readonly mode","category":"state"},"disable":{"type":"Boolean","desc":"Put component in disabled mode","category":"state"},"stack":{"type":"Boolean","desc":"Stack icon and label vertically instead of on same line (like it is by default)","category":"content"},"stretch":{"type":"Boolean","desc":"When used on flexbox parent, button will stretch to parent's height","category":"content"},"clearable":{"type":"Boolean","desc":"Clears model on click of the already selected button","category":"model"}},"slots":{"default":{"desc":"Suggestions: QTooltip, QBadge"},"...":{"desc":"Any other dynamic slots to be used with 'slot' property of the 'options' prop"}},"events":{"update:model-value":{"desc":"Emitted when the component needs to change the model; Is also used by v-model","params":{"value":{"type":"Any","desc":"New model value","required":true}}},"clear":{"desc":"When using the 'clearable' property, this event is emitted when the already selected button is clicked"}}}
|
package/dist/api/QCard.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/card"},"props":{"dark":{"type":["Boolean","null"],"default":"null","desc":"Notify the component that the background is a dark color","category":"style","required":false},"square":{"type":"Boolean","desc":"Removes border-radius so borders are squared","category":"style"},"flat":{"type":"Boolean","desc":"Applies a 'flat' design (no default shadow)","category":"style"},"bordered":{"type":"Boolean","desc":"Applies a default border to the component","category":"style"},"tag":{"type":"String","desc":"HTML tag to use","
|
|
1
|
+
{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/card"},"props":{"dark":{"type":["Boolean","null"],"default":"null","desc":"Notify the component that the background is a dark color","category":"style","required":false},"square":{"type":"Boolean","desc":"Removes border-radius so borders are squared","category":"style"},"flat":{"type":"Boolean","desc":"Applies a 'flat' design (no default shadow)","category":"style"},"bordered":{"type":"Boolean","desc":"Applies a default border to the component","category":"style"},"tag":{"type":"String","desc":"HTML tag to use","category":"content","default":"'div'","examples":["'div'","'form'"],"required":false}},"slots":{"default":{"desc":"Default slot in the devland unslotted content of the component"}}}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/card"},"props":{"horizontal":{"type":"Boolean","desc":"Display a horizontal section (will have no padding and can contain other QCardSection)","category":"content"},"tag":{"type":"String","desc":"HTML tag to use","
|
|
1
|
+
{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/card"},"props":{"horizontal":{"type":"Boolean","desc":"Display a horizontal section (will have no padding and can contain other QCardSection)","category":"content"},"tag":{"type":"String","desc":"HTML tag to use","category":"content","default":"'div'","examples":["'div'","'form'"],"required":false}},"slots":{"default":{"desc":"Default slot in the devland unslotted content of the component"}}}
|
package/dist/api/QCarousel.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/carousel"},"props":{"fullscreen":{"type":"Boolean","sync":true,"desc":"Fullscreen mode","examples":["# v-model:fullscreen=\"isFullscreen\""],"category":"behavior","syncable":true},"no-route-fullscreen-exit":{"type":"Boolean","desc":"Changing route app won't exit fullscreen","category":"behavior"},"model-value":{"type":"Any","desc":"Model of the component defining the current panel's name; If a Number is used, it does not define the panel's index, but rather the panel's name which can also be an Integer; Either use this property (along with a listener for 'update:model-value' event) OR use the v-model directive.","examples":["# v-model=\"panelName\""],"category":"model"},"keep-alive":{"type":"Boolean","desc":"Equivalent to using Vue's native <keep-alive> component on the content","category":"behavior"},"keep-alive-include":{"type":["String","Array","RegExp"],"desc":"Equivalent to using Vue's native include prop for <keep-alive>; Values must be valid Vue component names","examples":["'a,b'","/a|b/","['a', 'b']"],"category":"behavior"},"keep-alive-exclude":{"type":["String","Array","RegExp"],"desc":"Equivalent to using Vue's native exclude prop for <keep-alive>; Values must be valid Vue component names","examples":["'a,b'","/a|b/","['a', 'b']"],"category":"behavior"},"keep-alive-max":{"type":"Number","desc":"Equivalent to using Vue's native max prop for <keep-alive>","category":"behavior"},"animated":{"type":"Boolean","desc":"Enable transitions between panel (also see 'transition-prev' and 'transition-next' props)","category":"behavior"},"infinite":{"type":"Boolean","desc":"Makes component appear as infinite (when reaching last panel, next one will become the first one)","category":"behavior"},"swipeable":{"type":"Boolean","desc":"Enable swipe events (may interfere with content's touch/mouse events)","category":"behavior"},"vertical":{"type":"Boolean","desc":"Default transitions and swipe actions will be on the vertical axis","category":"behavior"},"transition-prev":{"type":"String","desc":"One of Quasar's embedded transitions (has effect only if 'animated' prop is set)","examples":["'fade'","'slide-down'"],"category":"transition","default":"'fade'","required":false},"transition-next":{"type":"String","desc":"One of Quasar's embedded transitions (has effect only if 'animated' prop is set)","examples":["'fade'","'slide-down'"],"category":"transition","default":"'fade'","required":false},"transition-duration":{"type":["String","Number"],"desc":"Transition duration (in milliseconds, without unit)","default":"300","category":"transition","addedIn":"v2.2","required":false},"dark":{"type":["Boolean","null"],"default":"null","desc":"Notify the component that the background is a dark color","category":"style","required":false},"height":{"type":"String","desc":"Height of Carousel in CSS units, including unit name","examples":["'16px'","'2rem'"],"category":"style"},"padding":{"type":"Boolean","desc":"Applies a default padding to each slide, according to the usage of 'arrows' and 'navigation' props","category":"content"},"control-color":{"type":"String","tsType":"NamedColor","desc":"Color name for QCarousel button controls (arrows, navigation) from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"control-text-color":{"type":"String","tsType":"NamedColor","desc":"Color name for text color of QCarousel button controls (arrows, navigation) from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"control-type":{"type":"String","desc":"Type of button to use for controls (arrows, navigation)","values":["'regular'","'flat'","'outline'","'push'","'unelevated'"],"category":"style"},"autoplay":{"type":["Number","Boolean"],"desc":"Jump to next slide (if 'true' or val > 0) or previous slide (if val < 0) at fixed time intervals (in milliseconds); 'false' disables autoplay, 'true' enables it for 5000ms intervals","default":"false","examples":["true","false","2500"],"category":"behavior","required":false},"arrows":{"type":"Boolean","desc":"Show navigation arrow buttons","category":"content"},"prev-icon":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"next-icon":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"navigation":{"type":"Boolean","desc":"Show navigation dots","category":"content"},"navigation-position":{"type":"String","desc":"Side to stick navigation to","default":"# 'bottom'/'right'","values":["'top'","'right'","'bottom'","'left'"],"category":"content","required":false},"navigation-icon":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"navigation-active-icon":{"type":"String","desc":"Icon name following Quasar convention for the active (current slide) navigation icon; Make sure you have the icon library installed unless you are using 'img:' prefix","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"thumbnails":{"type":"Boolean","desc":"Show thumbnails","category":"content"}},"slots":{"default":{"desc":"Suggestion: QCarouselSlide"},"control":{"desc":"Slot specific for QCarouselControl"},"navigation-icon":{"desc":"Slot for navigation icon/btn; Suggestion: QBtn","scope":{"index":{"type":"Number","desc":"The 0-based index of corresponding slide"},"maxIndex":{"type":"Number","desc":"The available number of slides"},"name":{"type":"Any","desc":"The name of the corresponding slide"},"active":{"type":"Boolean","desc":"Is this the current slide?"},"btnProps":{"type":"Object","desc":"Default QBtn props that can be binded to your own QBtn"},"onClick":{"type":"Function","desc":"Default trigger when clicked/tapped on","params":{"evt":{"type":"Event","desc":"JS event object","required":true}},"returns":null}}}},"events":{"fullscreen":{"desc":"Emitted when fullscreen state changes","params":{"value":{"type":"Boolean","desc":"Fullscreen state (showing/hidden)"}}},"update:model-value":{"desc":"Emitted when the component changes the model; This event _isn't_ fired if the model is changed externally; Is also used by v-model","params":{"value":{"type":["String","Number"],"desc":"New current panel name","examples":["'dashboard'"]}}},"before-transition":{"desc":"Emitted before transitioning to a new panel","params":{"newVal":{"type":["String","Number"],"desc":"Panel name towards transition is going","examples":["'dashboard'"]},"oldVal":{"type":["String","Number"],"desc":"Panel name from which transition is happening","examples":["'dashboard'"]}}},"transition":{"desc":"Emitted after component transitioned to a new panel","params":{"newVal":{"type":["String","Number"],"desc":"Panel name towards transition has occurred","examples":["'dashboard'"]},"oldVal":{"type":["String","Number"],"desc":"Panel name from which transition has happened","examples":["'dashboard'"]}}}},"methods":{"toggleFullscreen":{"desc":"Toggle the view to be fullscreen or not fullscreen"},"setFullscreen":{"desc":"Enter the fullscreen view"},"exitFullscreen":{"desc":"Leave the fullscreen view"},"next":{"desc":"Go to next panel"},"previous":{"desc":"Go to previous panel"},"goTo":{"desc":"Go to specific panel","params":{"panelName":{"type":["String","Number"],"desc":"Panel's name, which may be a String or Number; Number does not refers to panel index, but to its name, which may be an Integer","required":true,"examples":["'dashboard'"]}}}}}
|
|
1
|
+
{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/carousel"},"props":{"fullscreen":{"type":"Boolean","sync":true,"desc":"Fullscreen mode","examples":["# v-model:fullscreen=\"isFullscreen\""],"category":"behavior","syncable":true},"no-route-fullscreen-exit":{"type":"Boolean","desc":"Changing route app won't exit fullscreen","category":"behavior"},"model-value":{"type":"Any","desc":"Model of the component defining the current panel's name; If a Number is used, it does not define the panel's index, but rather the panel's name which can also be an Integer; Either use this property (along with a listener for 'update:model-value' event) OR use the v-model directive.","examples":["# v-model=\"panelName\""],"category":"model"},"keep-alive":{"type":"Boolean","desc":"Equivalent to using Vue's native <keep-alive> component on the content","category":"behavior"},"keep-alive-include":{"type":["String","Array","RegExp"],"desc":"Equivalent to using Vue's native include prop for <keep-alive>; Values must be valid Vue component names","examples":["'a,b'","/a|b/","[ 'a', 'b' ]"],"category":"behavior"},"keep-alive-exclude":{"type":["String","Array","RegExp"],"desc":"Equivalent to using Vue's native exclude prop for <keep-alive>; Values must be valid Vue component names","examples":["'a,b'","/a|b/","[ 'a', 'b' ]"],"category":"behavior"},"keep-alive-max":{"type":"Number","desc":"Equivalent to using Vue's native max prop for <keep-alive>","category":"behavior"},"animated":{"type":"Boolean","desc":"Enable transitions between panel (also see 'transition-prev' and 'transition-next' props)","category":"behavior"},"infinite":{"type":"Boolean","desc":"Makes component appear as infinite (when reaching last panel, next one will become the first one)","category":"behavior"},"swipeable":{"type":"Boolean","desc":"Enable swipe events (may interfere with content's touch/mouse events)","category":"behavior"},"vertical":{"type":"Boolean","desc":"Default transitions and swipe actions will be on the vertical axis","category":"behavior"},"transition-prev":{"type":"String","desc":"One of Quasar's embedded transitions (has effect only if 'animated' prop is set)","examples":["'fade'","'slide-down'"],"category":"transition","default":"'fade'","required":false},"transition-next":{"type":"String","desc":"One of Quasar's embedded transitions (has effect only if 'animated' prop is set)","examples":["'fade'","'slide-down'"],"category":"transition","default":"'fade'","required":false},"transition-duration":{"type":["String","Number"],"desc":"Transition duration (in milliseconds, without unit)","default":"300","category":"transition","addedIn":"v2.2","required":false},"dark":{"type":["Boolean","null"],"default":"null","desc":"Notify the component that the background is a dark color","category":"style","required":false},"height":{"type":"String","desc":"Height of Carousel in CSS units, including unit name","examples":["'16px'","'2rem'"],"category":"style"},"padding":{"type":"Boolean","desc":"Applies a default padding to each slide, according to the usage of 'arrows' and 'navigation' props","category":"content"},"control-color":{"type":"String","tsType":"NamedColor","desc":"Color name for QCarousel button controls (arrows, navigation) from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"control-text-color":{"type":"String","tsType":"NamedColor","desc":"Color name for text color of QCarousel button controls (arrows, navigation) from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"control-type":{"type":"String","desc":"Type of button to use for controls (arrows, navigation)","values":["'regular'","'flat'","'outline'","'push'","'unelevated'"],"category":"style"},"autoplay":{"type":["Number","Boolean"],"desc":"Jump to next slide (if 'true' or val > 0) or previous slide (if val < 0) at fixed time intervals (in milliseconds); 'false' disables autoplay, 'true' enables it for 5000ms intervals","default":"false","examples":["true","false","2500"],"category":"behavior","required":false},"arrows":{"type":"Boolean","desc":"Show navigation arrow buttons","category":"content"},"prev-icon":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"next-icon":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"navigation":{"type":"Boolean","desc":"Show navigation dots","category":"content"},"navigation-position":{"type":"String","desc":"Side to stick navigation to","default":"# 'bottom'/'right'","values":["'top'","'right'","'bottom'","'left'"],"category":"content","required":false},"navigation-icon":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"navigation-active-icon":{"type":"String","desc":"Icon name following Quasar convention for the active (current slide) navigation icon; Make sure you have the icon library installed unless you are using 'img:' prefix","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"thumbnails":{"type":"Boolean","desc":"Show thumbnails","category":"content"}},"slots":{"default":{"desc":"Suggestion: QCarouselSlide"},"control":{"desc":"Slot specific for QCarouselControl"},"navigation-icon":{"desc":"Slot for navigation icon/btn; Suggestion: QBtn","scope":{"index":{"type":"Number","desc":"The 0-based index of corresponding slide"},"maxIndex":{"type":"Number","desc":"The available number of slides"},"name":{"type":"Any","desc":"The name of the corresponding slide"},"active":{"type":"Boolean","desc":"Is this the current slide?"},"btnProps":{"type":"Object","desc":"Default QBtn props that can be binded to your own QBtn"},"onClick":{"type":"Function","desc":"Default trigger when clicked/tapped on","params":{"evt":{"type":"Event","desc":"JS event object","required":true}},"returns":null}}}},"events":{"fullscreen":{"desc":"Emitted when fullscreen state changes","params":{"value":{"type":"Boolean","desc":"Fullscreen state (showing/hidden)"}}},"update:model-value":{"desc":"Emitted when the component changes the model; This event _isn't_ fired if the model is changed externally; Is also used by v-model","params":{"value":{"type":["String","Number"],"desc":"New current panel name","examples":["'dashboard'"]}}},"before-transition":{"desc":"Emitted before transitioning to a new panel","params":{"newVal":{"type":["String","Number"],"desc":"Panel name towards transition is going","examples":["'dashboard'"]},"oldVal":{"type":["String","Number"],"desc":"Panel name from which transition is happening","examples":["'dashboard'"]}}},"transition":{"desc":"Emitted after component transitioned to a new panel","params":{"newVal":{"type":["String","Number"],"desc":"Panel name towards transition has occurred","examples":["'dashboard'"]},"oldVal":{"type":["String","Number"],"desc":"Panel name from which transition has happened","examples":["'dashboard'"]}}}},"methods":{"toggleFullscreen":{"desc":"Toggle the view to be fullscreen or not fullscreen","params":null,"returns":null},"setFullscreen":{"desc":"Enter the fullscreen view","params":null,"returns":null},"exitFullscreen":{"desc":"Leave the fullscreen view","params":null,"returns":null},"next":{"desc":"Go to next panel","params":null,"returns":null},"previous":{"desc":"Go to previous panel","params":null,"returns":null},"goTo":{"desc":"Go to specific panel","params":{"panelName":{"type":["String","Number"],"desc":"Panel's name, which may be a String or Number; Number does not refers to panel index, but to its name, which may be an Integer","required":true,"examples":["'dashboard'"]}},"returns":null}}}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/carousel"},"props":{"position":{"type":"String","desc":"Side/corner to stick to","default":"'bottom-right'","values":["'top-right'","'top-left'","'bottom-right'","'bottom-left'","'top'","'right'","'bottom'","'left'"],"category":"position","required":false},"offset":{"type":"Array","desc":"An array of two numbers to offset the component horizontally and vertically (in pixels)","default":"[ 18, 18 ]","examples":["[8, 8]","[5, 10]"],"category":"position","required":false}},"slots":{"default":{"desc":"Default slot in the devland unslotted content of the component"}}}
|
|
1
|
+
{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/carousel"},"props":{"position":{"type":"String","desc":"Side/corner to stick to","default":"'bottom-right'","values":["'top-right'","'top-left'","'bottom-right'","'bottom-left'","'top'","'right'","'bottom'","'left'"],"category":"position","required":false},"offset":{"type":"Array","desc":"An array of two numbers to offset the component horizontally and vertically (in pixels)","default":"[ 18, 18 ]","examples":["[ 8, 8 ]","[ 5, 10 ]"],"category":"position","required":false}},"slots":{"default":{"desc":"Default slot in the devland unslotted content of the component"}}}
|
package/dist/api/QCheckbox.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/checkbox"},"props":{"name":{"type":"String","desc":"Used to specify the name of the control; Useful if dealing with forms submitted directly to a URL","examples":["'car_id'"],"category":"behavior"},"size":{"type":"String","desc":"Size in CSS units, including unit name or standard size name (xs|sm|md|lg|xl)","examples":["'16px'","'2rem'","'xs'","'md'"],"category":"style"},"model-value":{"desc":"Model of the component; Either use this property (along with a listener for 'update:model-value' event) OR use v-model directive","required":true,"syncable":true,"category":"model","type":["Any","Array"],"examples":["false","['car', 'building']"]},"val":{"type":"Any","desc":"Works when model ('value') is Array. It tells the component which value should add/remove when ticked/unticked","examples":["'car'"],"category":"model"},"true-value":{"type":"Any","desc":"What model value should be considered as checked/ticked/on?","default":"true","examples":["'Agreed'"],"category":"model","required":false},"false-value":{"type":"Any","desc":"What model value should be considered as unchecked/unticked/off?","default":"false","examples":["'Disagree'"],"category":"model","required":false},"indeterminate-value":{"type":"Any","desc":"What model value should be considered as 'indeterminate'?","default":"null","examples":["0","'not_answered'"],"category":"model","required":false},"toggle-order":{"type":"String","desc":"Determines toggle order of the two states ('t' stands for state of true, 'f' for state of false); If 'toggle-indeterminate' is true, then the order is: indet -> first state -> second state -> indet (and repeat), otherwise: indet -> first state -> second state -> first state -> second state -> ...","default":"'tf'","values":["'tf'","'ft'"],"category":"behavior","required":false},"toggle-indeterminate":{"type":"Boolean","desc":"When user clicks/taps on the component, should we toggle through the indeterminate state too?","category":"behavior"},"label":{"type":"String","desc":"Label to display along the component (or use the default slot instead of this prop)","examples":["'I agree with the Terms and Conditions'"],"category":"label"},"left-label":{"type":"Boolean","desc":"Label (if any specified) should be displayed on the left side of the component","category":"label"},"checked-icon":{"type":"String","examples":["'visibility'"],"category":"icons","desc":"The icon to be used when the model is truthy (instead of the default design)","addedIn":"v2.5"},"unchecked-icon":{"type":"String","examples":["'visibility_off'"],"category":"icons","desc":"The icon to be used when the toggle is falsy (instead of the default design)","addedIn":"v2.5"},"indeterminate-icon":{"type":"String","examples":["'help'"],"category":"icons","desc":"The icon to be used when the model is indeterminate (instead of the default design)","addedIn":"v2.5"},"color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"keep-color":{"type":"Boolean","desc":"Should the color (if specified any) be kept when the component is unticked/ off?","category":"behavior"},"dark":{"type":["Boolean","null"],"default":"null","desc":"Notify the component that the background is a dark color","category":"style","required":false},"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style"},"disable":{"type":"Boolean","desc":"Put component in disabled mode","category":"state"},"tabindex":{"type":["Number","String"],"desc":"Tabindex HTML attribute value","examples":["100","'0'"],"category":"general"}},"slots":{"default":{"desc":"Default slot can be used as label, unless 'label' prop is specified; Suggestion: string"}},"events":{"update:model-value":{"desc":"Emitted when the component needs to change the model; Is also used by v-model","params":{"value":{"type":"Any","desc":"New model value","required":true},"evt":{"type":"Event","desc":"JS event object","required":true}}}},"methods":{"toggle":{"desc":"Toggle the state (of the model)"}}}
|
|
1
|
+
{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/checkbox"},"props":{"name":{"type":"String","desc":"Used to specify the name of the control; Useful if dealing with forms submitted directly to a URL","examples":["'car_id'"],"category":"behavior"},"size":{"type":"String","desc":"Size in CSS units, including unit name or standard size name (xs|sm|md|lg|xl)","examples":["'16px'","'2rem'","'xs'","'md'"],"category":"style"},"model-value":{"desc":"Model of the component; Either use this property (along with a listener for 'update:model-value' event) OR use v-model directive","required":true,"syncable":true,"category":"model","type":["Any","Array"],"examples":["false","[ 'car', 'building' ]"]},"val":{"type":"Any","desc":"Works when model ('value') is Array. It tells the component which value should add/remove when ticked/unticked","examples":["'car'"],"category":"model"},"true-value":{"type":"Any","desc":"What model value should be considered as checked/ticked/on?","default":"true","examples":["'Agreed'"],"category":"model","required":false},"false-value":{"type":"Any","desc":"What model value should be considered as unchecked/unticked/off?","default":"false","examples":["'Disagree'"],"category":"model","required":false},"indeterminate-value":{"type":"Any","desc":"What model value should be considered as 'indeterminate'?","default":"null","examples":["0","'not_answered'"],"category":"model","required":false},"toggle-order":{"type":"String","desc":"Determines toggle order of the two states ('t' stands for state of true, 'f' for state of false); If 'toggle-indeterminate' is true, then the order is: indet -> first state -> second state -> indet (and repeat), otherwise: indet -> first state -> second state -> first state -> second state -> ...","default":"'tf'","values":["'tf'","'ft'"],"category":"behavior","required":false},"toggle-indeterminate":{"type":"Boolean","desc":"When user clicks/taps on the component, should we toggle through the indeterminate state too?","category":"behavior"},"label":{"type":"String","desc":"Label to display along the component (or use the default slot instead of this prop)","examples":["'I agree with the Terms and Conditions'"],"category":"label"},"left-label":{"type":"Boolean","desc":"Label (if any specified) should be displayed on the left side of the component","category":"label"},"checked-icon":{"type":"String","examples":["'visibility'"],"category":"icons","desc":"The icon to be used when the model is truthy (instead of the default design)","addedIn":"v2.5"},"unchecked-icon":{"type":"String","examples":["'visibility_off'"],"category":"icons","desc":"The icon to be used when the toggle is falsy (instead of the default design)","addedIn":"v2.5"},"indeterminate-icon":{"type":"String","examples":["'help'"],"category":"icons","desc":"The icon to be used when the model is indeterminate (instead of the default design)","addedIn":"v2.5"},"color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"keep-color":{"type":"Boolean","desc":"Should the color (if specified any) be kept when the component is unticked/ off?","category":"behavior"},"dark":{"type":["Boolean","null"],"default":"null","desc":"Notify the component that the background is a dark color","category":"style","required":false},"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style"},"disable":{"type":"Boolean","desc":"Put component in disabled mode","category":"state"},"tabindex":{"type":["Number","String"],"desc":"Tabindex HTML attribute value","examples":["100","'0'"],"category":"general"}},"slots":{"default":{"desc":"Default slot can be used as label, unless 'label' prop is specified; Suggestion: string"}},"events":{"update:model-value":{"desc":"Emitted when the component needs to change the model; Is also used by v-model","params":{"value":{"type":"Any","desc":"New model value","required":true},"evt":{"type":"Event","desc":"JS event object","required":true}}}},"methods":{"toggle":{"desc":"Toggle the state (of the model)","params":null,"returns":null}}}
|
package/dist/api/QChip.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/chip"},"props":{"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style"},"size":{"type":"String","desc":"QChip size name or a CSS unit including unit name","examples":["'xs'","'sm'","'md'","'lg'","'xl'","'25px'","'2rem'"],"category":"style"},"dark":{"type":["Boolean","null"],"default":"null","desc":"Notify the component that the background is a dark color","category":"style","required":false},"icon":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"icon-right":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"icon-remove":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"icon-selected":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"label":{"type":["String","Number"],"desc":"Chip's content as string; overrides default slot if specified","examples":["'John Doe'","'Book'"],"category":"content"},"color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"text-color":{"type":"String","tsType":"NamedColor","desc":"Overrides text color (if needed); Color name from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"model-value":{"desc":"Model of the component determining if QChip should be rendered or not","required":false,"syncable":true,"category":"model","type":"Boolean","default":"true"},"selected":{"type":["Boolean","null"],"default":"null","sync":true,"desc":"Model for QChip if it's selected or not","examples":["# v-model:selected=\"myState\""],"category":"model","required":false,"syncable":true},"square":{"type":"Boolean","desc":"Sets a low value for border-radius instead of the default one, making it close to a square","category":"style"},"outline":{"type":"Boolean","desc":"Display using the 'outline' design","category":"style"},"clickable":{"type":"Boolean","desc":"Is QChip clickable? If it's the case, then it will add hover effects and emit 'click' events","category":"state"},"removable":{"type":"Boolean","desc":"If set, then it displays a 'remove' icon that when clicked the QChip emits 'remove' event","category":"state"},"ripple":{"type":["Boolean","Object"],"desc":"Configure material ripple (disable it by setting it to 'false' or supply a config object)","default":"true","examples":["false","{ early: true, center: true, color: 'teal', keyCodes: [] }"],"category":"style","required":false},"remove-aria-label":{"type":"String","desc":"aria-label to be used on the remove icon","examples":["'Remove item'"],"category":"accessibility","addedIn":"v2.8.4"},"tabindex":{"type":["Number","String"],"desc":"Tabindex HTML attribute value","examples":["100","'0'"],"category":"general"},"disable":{"type":"Boolean","desc":"Put component in disabled mode","category":"state"}},"slots":{"default":{"desc":"This is where QChip content goes, if not using 'label' property"}},"events":{"click":{"desc":"Emitted on QChip click if 'clickable' property is set","params":{"evt":{"type":"Event","desc":"JS event object"}}},"update:selected":{"desc":"Used by Vue on 'v-model:selected' for updating its value","params":{"state":{"type":"Boolean","desc":"Selected state"}}},"remove":{"desc":"Works along with 'value' and 'removable' prop. Emitted when toggling rendering state of the QChip","params":{"state":{"type":"Boolean","desc":"Render state (render or not)"}}}}}
|
|
1
|
+
{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/chip"},"props":{"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style"},"size":{"type":"String","desc":"QChip size name or a CSS unit including unit name","examples":["'xs'","'sm'","'md'","'lg'","'xl'","'25px'","'2rem'"],"category":"style"},"dark":{"type":["Boolean","null"],"default":"null","desc":"Notify the component that the background is a dark color","category":"style","required":false},"icon":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"icon-right":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"icon-remove":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"icon-selected":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"label":{"type":["String","Number"],"desc":"Chip's content as string; overrides default slot if specified","examples":["'John Doe'","'Book'"],"category":"content"},"color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"text-color":{"type":"String","tsType":"NamedColor","desc":"Overrides text color (if needed); Color name from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"model-value":{"desc":"Model of the component determining if QChip should be rendered or not","required":false,"syncable":true,"category":"model","type":"Boolean","default":"true"},"selected":{"type":["Boolean","null"],"default":"null","sync":true,"desc":"Model for QChip if it's selected or not","examples":["# v-model:selected=\"myState\""],"category":"model","required":false,"syncable":true},"square":{"type":"Boolean","desc":"Sets a low value for border-radius instead of the default one, making it close to a square","category":"style"},"outline":{"type":"Boolean","desc":"Display using the 'outline' design","category":"style"},"clickable":{"type":"Boolean","desc":"Is QChip clickable? If it's the case, then it will add hover effects and emit 'click' events","category":"state"},"removable":{"type":"Boolean","desc":"If set, then it displays a 'remove' icon that when clicked the QChip emits 'remove' event","category":"state"},"ripple":{"type":["Boolean","Object"],"desc":"Configure material ripple (disable it by setting it to 'false' or supply a config object)","default":"true","examples":["false","{ early: true, center: true, color: 'teal', keyCodes: [] }"],"category":"style","required":false},"remove-aria-label":{"type":"String","desc":"aria-label to be used on the remove icon","examples":["'Remove item'"],"category":"accessibility","addedIn":"v2.8.4"},"tabindex":{"type":["Number","String"],"desc":"Tabindex HTML attribute value","examples":["100","'0'"],"category":"general"},"disable":{"type":"Boolean","desc":"Put component in disabled mode","category":"state"}},"slots":{"default":{"desc":"This is where QChip content goes, if not using 'label' property"}},"events":{"click":{"desc":"Emitted on QChip click if 'clickable' property is set","params":{"evt":{"type":"Event","desc":"JS event object"}}},"update:model-value":{"desc":"Emitted when the component needs to change the model; Is also used by v-model","params":{"value":{"type":"Any","desc":"New model value","required":true}}},"update:selected":{"desc":"Used by Vue on 'v-model:selected' for updating its value","params":{"state":{"type":"Boolean","desc":"Selected state"}}},"remove":{"desc":"Works along with 'value' and 'removable' prop. Emitted when toggling rendering state of the QChip","params":{"state":{"type":"Boolean","desc":"Render state (render or not)"}}}}}
|