@skeletonlabs/skeleton 0.92.1 → 0.99.5
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/actions/Clipboard/clipboard.d.ts +4 -0
- package/actions/Clipboard/clipboard.js +37 -0
- package/actions/Filters/filter.d.ts +3 -0
- package/actions/Filters/filter.js +23 -0
- package/{src/lib/actions → actions}/Filters/svg-filters/Apollo.svelte +0 -0
- package/actions/Filters/svg-filters/Apollo.svelte.d.ts +23 -0
- package/{src/lib/actions → actions}/Filters/svg-filters/BlueNight.svelte +0 -0
- package/actions/Filters/svg-filters/BlueNight.svelte.d.ts +23 -0
- package/{src/lib/actions → actions}/Filters/svg-filters/Emerald.svelte +0 -0
- package/actions/Filters/svg-filters/Emerald.svelte.d.ts +23 -0
- package/{src/lib/actions → actions}/Filters/svg-filters/GreenFall.svelte +0 -0
- package/actions/Filters/svg-filters/GreenFall.svelte.d.ts +23 -0
- package/{src/lib/actions → actions}/Filters/svg-filters/Noir.svelte +0 -0
- package/actions/Filters/svg-filters/Noir.svelte.d.ts +23 -0
- package/{src/lib/actions → actions}/Filters/svg-filters/NoirLight.svelte +0 -0
- package/actions/Filters/svg-filters/NoirLight.svelte.d.ts +23 -0
- package/{src/lib/actions → actions}/Filters/svg-filters/Rustic.svelte +0 -0
- package/actions/Filters/svg-filters/Rustic.svelte.d.ts +23 -0
- package/{src/lib/actions → actions}/Filters/svg-filters/Summer84.svelte +0 -0
- package/actions/Filters/svg-filters/Summer84.svelte.d.ts +23 -0
- package/{src/lib/actions → actions}/Filters/svg-filters/XPro.svelte +0 -0
- package/actions/Filters/svg-filters/XPro.svelte.d.ts +23 -0
- package/actions/FocusTrap/focusTrap.d.ts +4 -0
- package/actions/FocusTrap/focusTrap.js +53 -0
- package/components/Accordion/AccordionGroup.svelte +33 -0
- package/components/Accordion/AccordionGroup.svelte.d.ts +24 -0
- package/components/Accordion/AccordionItem.svelte +57 -0
- package/components/Accordion/AccordionItem.svelte.d.ts +36 -0
- package/components/AppBar/AppBar.svelte +38 -0
- package/components/AppBar/AppBar.svelte.d.ts +30 -0
- package/components/AppRail/AppRail.svelte +30 -0
- package/components/AppRail/AppRail.svelte.d.ts +32 -0
- package/components/AppRail/AppRailTile.svelte +43 -0
- package/components/AppRail/AppRailTile.svelte.d.ts +33 -0
- package/components/AppShell/AppShell.svelte +70 -0
- package/components/AppShell/AppShell.svelte.d.ts +31 -0
- package/components/Avatar/Avatar.svelte +29 -0
- package/components/Avatar/Avatar.svelte.d.ts +32 -0
- package/components/ConicGradient/ConicGradient.svelte +64 -0
- package/components/ConicGradient/ConicGradient.svelte.d.ts +29 -0
- package/components/ConicGradient/settings.d.ts +13 -0
- package/components/ConicGradient/settings.js +335 -0
- package/components/ConicGradient/types.d.ts +10 -0
- package/components/ConicGradient/types.js +2 -0
- package/components/FileButton/FileButton.svelte +28 -0
- package/components/FileButton/FileButton.svelte.d.ts +25 -0
- package/components/FileDropzone/FileDropzone.svelte +75 -0
- package/components/FileDropzone/FileDropzone.svelte.d.ts +32 -0
- package/components/InputChip/InputChip.svelte +77 -0
- package/components/InputChip/InputChip.svelte.d.ts +28 -0
- package/components/ListBox/ListBox.svelte +37 -0
- package/components/ListBox/ListBox.svelte.d.ts +30 -0
- package/components/ListBox/ListBoxItem.svelte +72 -0
- package/components/ListBox/ListBoxItem.svelte.d.ts +32 -0
- package/components/Paginator/Paginator.svelte +58 -0
- package/components/Paginator/Paginator.svelte.d.ts +29 -0
- package/components/Paginator/types.d.ts +10 -0
- package/components/Paginator/types.js +2 -0
- package/components/ProgressBar/ProgressBar.svelte +55 -0
- package/components/ProgressBar/ProgressBar.svelte.d.ts +24 -0
- package/components/ProgressRadial/ProgressRadial.svelte +71 -0
- package/components/ProgressRadial/ProgressRadial.svelte.d.ts +25 -0
- package/components/Radio/RadioGroup.svelte +29 -0
- package/components/Radio/RadioGroup.svelte.d.ts +31 -0
- package/components/Radio/RadioItem.svelte +49 -0
- package/components/Radio/RadioItem.svelte.d.ts +33 -0
- package/components/RangeSlider/RangeSlider.svelte +78 -0
- package/components/RangeSlider/RangeSlider.svelte.d.ts +32 -0
- package/components/SlideToggle/SlideToggle.svelte +88 -0
- package/components/SlideToggle/SlideToggle.svelte.d.ts +34 -0
- package/components/Stepper/Step.svelte +125 -0
- package/components/Stepper/Step.svelte.d.ts +39 -0
- package/components/Stepper/Stepper.svelte +43 -0
- package/components/Stepper/Stepper.svelte.d.ts +32 -0
- package/components/SvgIcon/SvgIcon.svelte +33 -0
- package/components/SvgIcon/SvgIcon.svelte.d.ts +26 -0
- package/components/SvgIcon/icons.d.ts +1 -0
- package/components/SvgIcon/icons.js +25 -0
- package/components/Tab/Tab.svelte +54 -0
- package/components/Tab/Tab.svelte.d.ts +37 -0
- package/components/Tab/TabGroup.svelte +51 -0
- package/components/Tab/TabGroup.svelte.d.ts +30 -0
- package/components/Table/Table.svelte +83 -0
- package/components/Table/Table.svelte.d.ts +27 -0
- package/components/Table/types.d.ts +10 -0
- package/components/Table/types.js +1 -0
- package/components/Table/utils.d.ts +7 -0
- package/{src/lib/components/Table/utils.ts → components/Table/utils.js} +10 -16
- package/components/TableOfContents/TableOfContents.svelte +100 -0
- package/components/TableOfContents/TableOfContents.svelte.d.ts +32 -0
- package/{src/lib/index.ts → index.d.ts} +1 -36
- package/index.js +66 -0
- package/package.json +159 -61
- package/{src/lib/styles → styles}/all.css +3 -0
- package/{src/lib/styles → styles}/core.css +11 -2
- package/styles/elements/alerts.css +17 -0
- package/{src/lib/styles → styles}/elements/badges.css +0 -25
- package/{src/lib/styles → styles}/elements/breadcrumbs.css +3 -3
- package/styles/elements/buttons.css +101 -0
- package/styles/elements/cards.css +32 -0
- package/styles/elements/chips.css +22 -0
- package/{src/lib/styles → styles}/elements/lists.css +4 -3
- package/{src/lib/styles → styles}/elements/logo-clouds.css +2 -4
- package/{src/lib/styles → styles}/elements/menus.css +0 -0
- package/{src/lib/styles → styles}/elements/placeholders.css +0 -0
- package/{src/lib/styles → styles}/elements/tables.css +14 -10
- package/{src/lib/styles → styles}/elements/tooltips.css +0 -0
- package/{src/lib/styles → styles}/elements.css +0 -0
- package/styles/forms.css +195 -0
- package/{src/lib/styles → styles}/highlight-js.css +0 -0
- package/styles/tailwind.css +16 -0
- package/styles/typography.css +99 -0
- package/styles/variants.css +154 -0
- package/{src/lib/tailwind/skeleton.cjs → tailwind/core.cjs} +1 -14
- package/tailwind/core.d.cts +5 -0
- package/tailwind/generated/intellisense-classes.cjs +1 -0
- package/tailwind/generated/intellisense-classes.d.cts +1956 -0
- package/tailwind/intellisense.cjs +21 -0
- package/tailwind/intellisense.d.cts +5 -0
- package/tailwind/settings.cjs +20 -0
- package/tailwind/settings.d.cts +6 -0
- package/tailwind/skeleton.cjs +19 -0
- package/tailwind/skeleton.d.cts +7 -0
- package/{src/lib/tailwind → tailwind}/theme/colors.cjs +7 -7
- package/tailwind/theme/colors.d.cts +2 -0
- package/tailwind/tokens/backgrounds.cjs +38 -0
- package/tailwind/tokens/backgrounds.d.cts +2 -0
- package/tailwind/tokens/border-radius.cjs +21 -0
- package/tailwind/tokens/border-radius.d.cts +33 -0
- package/tailwind/tokens/borders.cjs +20 -0
- package/tailwind/tokens/borders.d.cts +6 -0
- package/tailwind/tokens/fills.cjs +20 -0
- package/tailwind/tokens/fills.d.cts +15 -0
- package/tailwind/tokens/rings.cjs +50 -0
- package/tailwind/tokens/rings.d.cts +22 -0
- package/tailwind/tokens/text.cjs +31 -0
- package/tailwind/tokens/text.d.cts +21 -0
- package/{src/lib/themes → themes}/theme-crimson.css +0 -0
- package/{src/lib/themes → themes}/theme-gold-nouveau.css +0 -0
- package/{src/lib/themes → themes}/theme-hamlindigo.css +0 -0
- package/{src/lib/themes → themes}/theme-modern.css +0 -0
- package/{src/lib/themes → themes}/theme-rocket.css +0 -0
- package/{src/lib/themes → themes}/theme-sahara.css +0 -0
- package/{src/lib/themes → themes}/theme-seafoam.css +0 -0
- package/{src/lib/themes → themes}/theme-seasonal.css +0 -0
- package/{src/lib/themes → themes}/theme-skeleton.css +6 -6
- package/{src/lib/themes → themes}/theme-vintage.css +0 -0
- package/utilities/CodeBlock/CodeBlock.svelte +54 -0
- package/utilities/CodeBlock/CodeBlock.svelte.d.ts +25 -0
- package/utilities/CodeBlock/stores.d.ts +2 -0
- package/utilities/CodeBlock/stores.js +3 -0
- package/utilities/DataTable/DataTable.d.ts +18 -0
- package/utilities/DataTable/DataTable.js +137 -0
- package/utilities/DataTable/actions.d.ts +8 -0
- package/utilities/DataTable/actions.js +114 -0
- package/utilities/DataTable/types.d.ts +33 -0
- package/utilities/DataTable/types.js +2 -0
- package/utilities/Drawer/Drawer.svelte +134 -0
- package/utilities/Drawer/Drawer.svelte.d.ts +33 -0
- package/utilities/Drawer/stores.d.ts +10 -0
- package/utilities/Drawer/stores.js +21 -0
- package/utilities/Drawer/types.d.ts +33 -0
- package/utilities/Drawer/types.js +2 -0
- package/utilities/LightSwitch/LightSwitch.svelte +80 -0
- package/utilities/LightSwitch/LightSwitch.svelte.d.ts +21 -0
- package/utilities/LightSwitch/stores.d.ts +2 -0
- package/utilities/LightSwitch/stores.js +5 -0
- package/utilities/LocalStorageStore/LocalStorageStore.d.ts +12 -0
- package/utilities/LocalStorageStore/LocalStorageStore.js +49 -0
- package/utilities/Menu/menu.d.ts +18 -0
- package/utilities/Menu/menu.js +151 -0
- package/utilities/Modal/Modal.svelte +160 -0
- package/utilities/Modal/Modal.svelte.d.ts +35 -0
- package/{src/lib/utilities → utilities}/Modal/examples/ModalExampleEmbed.svelte +3 -8
- package/utilities/Modal/examples/ModalExampleEmbed.svelte.d.ts +17 -0
- package/{src/lib/utilities → utilities}/Modal/examples/ModalExampleForm.svelte +17 -27
- package/utilities/Modal/examples/ModalExampleForm.svelte.d.ts +17 -0
- package/utilities/Modal/examples/ModalExampleImage.svelte +19 -0
- package/utilities/Modal/examples/ModalExampleImage.svelte.d.ts +16 -0
- package/{src/lib/utilities → utilities}/Modal/examples/ModalExampleList.svelte +10 -18
- package/utilities/Modal/examples/ModalExampleList.svelte.d.ts +17 -0
- package/utilities/Modal/stores.d.ts +12 -0
- package/utilities/Modal/stores.js +24 -0
- package/utilities/Modal/types.d.ts +36 -0
- package/utilities/Modal/types.js +2 -0
- package/utilities/Toast/Toast.svelte +95 -0
- package/utilities/Toast/Toast.svelte.d.ts +28 -0
- package/utilities/Toast/stores.d.ts +10 -0
- package/utilities/Toast/stores.js +69 -0
- package/utilities/Toast/types.d.ts +26 -0
- package/utilities/Toast/types.js +2 -0
- package/utilities/Tooltip/tooltip.d.ts +35 -0
- package/utilities/Tooltip/tooltip.js +94 -0
- package/.eslintrc.cjs +0 -20
- package/.github/FUNDING.yml +0 -13
- package/.github/ISSUE_TEMPLATE/bug_report.yml +0 -30
- package/.github/ISSUE_TEMPLATE/config.yml +0 -8
- package/.github/ISSUE_TEMPLATE/docs_issue.yml +0 -23
- package/.github/ISSUE_TEMPLATE/feature_request.yml +0 -22
- package/.github/pull_request_template.md +0 -14
- package/.prettierignore +0 -12
- package/.prettierrc +0 -6
- package/postcss.config.cjs +0 -14
- package/scripts/compile-css-to-js.cjs +0 -50
- package/scripts/generate-jss.js +0 -67
- package/scripts/post-build.js +0 -17
- package/scripts/pre-build.js +0 -14
- package/src/app.d.ts +0 -13
- package/src/app.html +0 -43
- package/src/app.postcss +0 -10
- package/src/docs/DocsAppBar/DocsAppBar.svelte +0 -213
- package/src/docs/DocsFooter/DocsFooter.svelte +0 -78
- package/src/docs/DocsLogo/DocsLogoAnim.svelte +0 -44
- package/src/docs/DocsLogo/DocsLogoFull.svelte +0 -11
- package/src/docs/DocsLogo/DocsLogoIcon.svelte +0 -6
- package/src/docs/DocsNavigation/DocsDrawer.svelte +0 -23
- package/src/docs/DocsNavigation/DocsSidebar.svelte +0 -103
- package/src/docs/DocsNavigation/links.ts +0 -148
- package/src/docs/DocsSearch/DocsSearch.svelte +0 -78
- package/src/docs/DocsShell/DocsShell.svelte +0 -377
- package/src/docs/DocsShell/sveldMapper.ts +0 -143
- package/src/docs/DocsShell/types.ts +0 -96
- package/src/docs/DocsStyles/blog.css +0 -192
- package/src/docs/DocsThemer/DocsThemer.svelte +0 -254
- package/src/docs/DocsThemer/Swatch.svelte +0 -28
- package/src/docs/DocsThemer/colors.ts +0 -122
- package/src/docs/DocsThemer/settings.ts +0 -129
- package/src/docs/DocsThemer/stores.ts +0 -5
- package/src/docs/DocsThemer/types.ts +0 -20
- package/src/docs/README.md +0 -3
- package/src/docs/stores.ts +0 -15
- package/src/lib/actions/Clipboard/clipboard.ts +0 -39
- package/src/lib/actions/Filters/filter.test.ts +0 -40
- package/src/lib/actions/Filters/filter.ts +0 -23
- package/src/lib/actions/FocusTrap/focusTrap.ts +0 -56
- package/src/lib/components/Accordion/AccordionGroup.svelte +0 -53
- package/src/lib/components/Accordion/AccordionGroup.test.ts +0 -22
- package/src/lib/components/Accordion/AccordionItem.svelte +0 -80
- package/src/lib/components/Accordion/AccordionItem.test.ts +0 -28
- package/src/lib/components/Alert/Alert.svelte +0 -71
- package/src/lib/components/Alert/Alert.test.ts +0 -30
- package/src/lib/components/AppBar/AppBar.svelte +0 -60
- package/src/lib/components/AppBar/AppBar.test.ts +0 -31
- package/src/lib/components/AppRail/AppRail.svelte +0 -58
- package/src/lib/components/AppRail/AppRailTile.svelte +0 -66
- package/src/lib/components/AppShell/AppShell.svelte +0 -84
- package/src/lib/components/AppShell/AppShell.test.ts +0 -26
- package/src/lib/components/Avatar/Avatar.svelte +0 -51
- package/src/lib/components/Avatar/Avatar.test.ts +0 -41
- package/src/lib/components/Breadcrumb/Breadcrumb.svelte +0 -30
- package/src/lib/components/Breadcrumb/Breadcrumb.test.ts +0 -20
- package/src/lib/components/Breadcrumb/Crumb.svelte +0 -44
- package/src/lib/components/Breadcrumb/Crumb.test.ts +0 -48
- package/src/lib/components/ConicGradient/ConicGradient.svelte +0 -88
- package/src/lib/components/ConicGradient/ConicGradient.test.ts +0 -26
- package/src/lib/components/ConicGradient/settings.ts +0 -345
- package/src/lib/components/ConicGradient/types.ts +0 -12
- package/src/lib/components/Divider/Divider.svelte +0 -26
- package/src/lib/components/Divider/Divider.test.ts +0 -32
- package/src/lib/components/FileButton/FileButton.svelte +0 -29
- package/src/lib/components/FileButton/FileButton.test.ts +0 -32
- package/src/lib/components/FileDropzone/FileDropzone.svelte +0 -108
- package/src/lib/components/FileDropzone/FileDropzone.test.ts +0 -32
- package/src/lib/components/GradientHeading/GradientHeading.svelte +0 -24
- package/src/lib/components/GradientHeading/GradientHeading.test.ts +0 -30
- package/src/lib/components/InputChip/InputChip.svelte +0 -118
- package/src/lib/components/ListBox/ListBox.svelte +0 -65
- package/src/lib/components/ListBox/ListBox.test.ts +0 -48
- package/src/lib/components/ListBox/ListBoxItem.svelte +0 -99
- package/src/lib/components/ListBox/ListBoxItem.test.ts +0 -22
- package/src/lib/components/Paginator/Paginator.svelte +0 -84
- package/src/lib/components/Paginator/Paginator.test.ts +0 -29
- package/src/lib/components/Paginator/types.ts +0 -12
- package/src/lib/components/ProgressBar/ProgressBar.svelte +0 -73
- package/src/lib/components/ProgressBar/ProgressBar.test.ts +0 -27
- package/src/lib/components/ProgressRadial/ProgressRadial.svelte +0 -98
- package/src/lib/components/ProgressRadial/ProgressRadial.test.ts +0 -26
- package/src/lib/components/Radio/RadioGroup.svelte +0 -54
- package/src/lib/components/Radio/RadioGroup.test.ts +0 -35
- package/src/lib/components/Radio/RadioItem.svelte +0 -71
- package/src/lib/components/Radio/RadioItem.test.ts +0 -32
- package/src/lib/components/RangeSlider/RangeSlider.svelte +0 -110
- package/src/lib/components/RangeSlider/RangeSlider.test.ts +0 -44
- package/src/lib/components/SlideToggle/SlideToggle.svelte +0 -106
- package/src/lib/components/SlideToggle/SlideToggle.test.ts +0 -23
- package/src/lib/components/Stepper/Step.svelte +0 -140
- package/src/lib/components/Stepper/Step.test.ts +0 -21
- package/src/lib/components/Stepper/Stepper.svelte +0 -71
- package/src/lib/components/Stepper/Stepper.test.ts +0 -31
- package/src/lib/components/SvgIcon/SvgIcon.svelte +0 -50
- package/src/lib/components/SvgIcon/SvgIcon.test.ts +0 -28
- package/src/lib/components/SvgIcon/icons.ts +0 -29
- package/src/lib/components/Tab/Tab.svelte +0 -79
- package/src/lib/components/Tab/Tab.test.ts +0 -26
- package/src/lib/components/Tab/TabGroup.svelte +0 -78
- package/src/lib/components/Tab/TabGroup.test.ts +0 -30
- package/src/lib/components/Table/Table.svelte +0 -106
- package/src/lib/components/Table/types.ts +0 -10
- package/src/lib/components/TableOfContents/TableOfContents.svelte +0 -139
- package/src/lib/styles/elements/alerts.css +0 -43
- package/src/lib/styles/elements/buttons.css +0 -186
- package/src/lib/styles/elements/cards.css +0 -59
- package/src/lib/styles/elements/chips.css +0 -71
- package/src/lib/styles/forms.css +0 -178
- package/src/lib/styles/tailwind.css +0 -12
- package/src/lib/styles/typography.css +0 -115
- package/src/lib/tailwind/settings.cjs +0 -20
- package/src/lib/tailwind/tokens/backgrounds.cjs +0 -40
- package/src/lib/tailwind/tokens/border-radius.cjs +0 -21
- package/src/lib/tailwind/tokens/borders.cjs +0 -20
- package/src/lib/tailwind/tokens/fills.cjs +0 -20
- package/src/lib/tailwind/tokens/rings.cjs +0 -42
- package/src/lib/tailwind/tokens/text.cjs +0 -33
- package/src/lib/themes/theme-test.css +0 -96
- package/src/lib/utilities/CodeBlock/CodeBlock.svelte +0 -78
- package/src/lib/utilities/CodeBlock/CodeBlock.test.ts +0 -27
- package/src/lib/utilities/CodeBlock/stores.ts +0 -5
- package/src/lib/utilities/DataTable/DataTable.ts +0 -151
- package/src/lib/utilities/DataTable/actions.ts +0 -100
- package/src/lib/utilities/DataTable/types.ts +0 -33
- package/src/lib/utilities/Drawer/Drawer.svelte +0 -173
- package/src/lib/utilities/Drawer/Drawer.test.ts +0 -15
- package/src/lib/utilities/Drawer/stores.ts +0 -27
- package/src/lib/utilities/Drawer/types.ts +0 -47
- package/src/lib/utilities/LightSwitch/LightSwitch.svelte +0 -116
- package/src/lib/utilities/LightSwitch/LightSwitch.test.ts +0 -19
- package/src/lib/utilities/LightSwitch/stores.ts +0 -7
- package/src/lib/utilities/LocalStorageStore/LocalStorageStore.test.ts +0 -220
- package/src/lib/utilities/LocalStorageStore/LocalStorageStore.ts +0 -77
- package/src/lib/utilities/Menu/menu.test.ts +0 -22
- package/src/lib/utilities/Menu/menu.ts +0 -172
- package/src/lib/utilities/Modal/Modal.svelte +0 -206
- package/src/lib/utilities/Modal/Modal.test.ts +0 -50
- package/src/lib/utilities/Modal/stores.ts +0 -29
- package/src/lib/utilities/Modal/types.ts +0 -39
- package/src/lib/utilities/Toast/Toast.svelte +0 -95
- package/src/lib/utilities/Toast/Toats.test.ts +0 -25
- package/src/lib/utilities/Toast/stores.ts +0 -63
- package/src/lib/utilities/Toast/types.ts +0 -29
- package/src/lib/utilities/Tooltip/tooltip.ts +0 -137
- package/src/routes/(inner)/+layout.svelte +0 -3
- package/src/routes/(inner)/actions/clipboard/+page.svelte +0 -87
- package/src/routes/(inner)/actions/filters/+page.svelte +0 -151
- package/src/routes/(inner)/actions/focus-trap/+page.svelte +0 -59
- package/src/routes/(inner)/components/accordions/+page.svelte +0 -127
- package/src/routes/(inner)/components/alerts/+page.svelte +0 -130
- package/src/routes/(inner)/components/app-bar/+page.svelte +0 -52
- package/src/routes/(inner)/components/app-rail/+page.svelte +0 -105
- package/src/routes/(inner)/components/app-shell/+page.svelte +0 -159
- package/src/routes/(inner)/components/avatars/+page.svelte +0 -193
- package/src/routes/(inner)/components/breadcrumbs/+page.svelte +0 -121
- package/src/routes/(inner)/components/conic-gradients/+page.svelte +0 -161
- package/src/routes/(inner)/components/dividers/+page.svelte +0 -146
- package/src/routes/(inner)/components/file-buttons/+page.svelte +0 -46
- package/src/routes/(inner)/components/file-dropzone/+page.svelte +0 -71
- package/src/routes/(inner)/components/gradient-headings/+page.svelte +0 -138
- package/src/routes/(inner)/components/input-chips/+page.svelte +0 -128
- package/src/routes/(inner)/components/listboxes/+page.svelte +0 -92
- package/src/routes/(inner)/components/paginators/+page.svelte +0 -118
- package/src/routes/(inner)/components/progress-bars/+page.svelte +0 -157
- package/src/routes/(inner)/components/progress-radials/+page.svelte +0 -64
- package/src/routes/(inner)/components/radio-groups/+page.svelte +0 -91
- package/src/routes/(inner)/components/range-sliders/+page.svelte +0 -134
- package/src/routes/(inner)/components/slide-toggles/+page.svelte +0 -63
- package/src/routes/(inner)/components/steppers/+page.svelte +0 -168
- package/src/routes/(inner)/components/svg-icons/+page.svelte +0 -60
- package/src/routes/(inner)/components/table-of-contents/+page.svelte +0 -110
- package/src/routes/(inner)/components/tables/+page.svelte +0 -216
- package/src/routes/(inner)/components/tabs/+page.svelte +0 -146
- package/src/routes/(inner)/docs/comparisons/+page.svelte +0 -130
- package/src/routes/(inner)/docs/contributions/+page.svelte +0 -78
- package/src/routes/(inner)/docs/contributions/documentation/+page.svelte +0 -217
- package/src/routes/(inner)/docs/contributions/requirements/+page.svelte +0 -173
- package/src/routes/(inner)/docs/contributions/style-guide/+page.svelte +0 -164
- package/src/routes/(inner)/docs/faqs/+page.svelte +0 -80
- package/src/routes/(inner)/docs/features/+page.svelte +0 -121
- package/src/routes/(inner)/docs/recommended/+page.svelte +0 -162
- package/src/routes/(inner)/docs/why/+page.svelte +0 -104
- package/src/routes/(inner)/elements/alerts/+page.svelte +0 -142
- package/src/routes/(inner)/elements/badges/+page.svelte +0 -155
- package/src/routes/(inner)/elements/breadcrumbs/+page.svelte +0 -132
- package/src/routes/(inner)/elements/buttons/+page.svelte +0 -304
- package/src/routes/(inner)/elements/cards/+page.svelte +0 -117
- package/src/routes/(inner)/elements/chips/+page.svelte +0 -130
- package/src/routes/(inner)/elements/core/+page.svelte +0 -98
- package/src/routes/(inner)/elements/forms/+page.svelte +0 -89
- package/src/routes/(inner)/elements/forms/preview/+page.svelte +0 -256
- package/src/routes/(inner)/elements/lists/+page.svelte +0 -197
- package/src/routes/(inner)/elements/logo-clouds/+page.svelte +0 -105
- package/src/routes/(inner)/elements/placeholders/+page.svelte +0 -70
- package/src/routes/(inner)/elements/tables/+page.svelte +0 -138
- package/src/routes/(inner)/elements/tokens/+page.svelte +0 -176
- package/src/routes/(inner)/elements/typography/+page.svelte +0 -100
- package/src/routes/(inner)/guides/install/+page.svelte +0 -84
- package/src/routes/(inner)/guides/quickstart/+page.svelte +0 -118
- package/src/routes/(inner)/guides/styling/+page.svelte +0 -361
- package/src/routes/(inner)/guides/tailwind/+page.svelte +0 -150
- package/src/routes/(inner)/guides/themes/+page.svelte +0 -144
- package/src/routes/(inner)/guides/themes/colors/+page.svelte +0 -87
- package/src/routes/(inner)/guides/themes/generator/+page.svelte +0 -58
- package/src/routes/(inner)/guides/themes/presets.ts +0 -69
- package/src/routes/(inner)/template/+page.svelte +0 -52
- package/src/routes/(inner)/utilities/codeblocks/+page.svelte +0 -77
- package/src/routes/(inner)/utilities/data-tables/+page.svelte +0 -399
- package/src/routes/(inner)/utilities/data-tables/+page.ts +0 -18
- package/src/routes/(inner)/utilities/drawers/+page.svelte +0 -193
- package/src/routes/(inner)/utilities/lightswitches/+page.svelte +0 -86
- package/src/routes/(inner)/utilities/local-storage-stores/+page.svelte +0 -67
- package/src/routes/(inner)/utilities/menus/+page.svelte +0 -186
- package/src/routes/(inner)/utilities/modals/+page.svelte +0 -391
- package/src/routes/(inner)/utilities/toasts/+page.svelte +0 -212
- package/src/routes/(inner)/utilities/tooltips/+page.svelte +0 -153
- package/src/routes/+error.svelte +0 -16
- package/src/routes/+layout.server.ts +0 -13
- package/src/routes/+layout.svelte +0 -100
- package/src/routes/+page.server.ts +0 -12
- package/src/routes/+page.svelte +0 -197
- package/src/routes/blog/+page.svelte +0 -78
- package/src/routes/blog/+page.ts +0 -6
- package/src/routes/blog/[slug]/+page.svelte +0 -112
- package/src/routes/blog/[slug]/+page.ts +0 -6
- package/src/routes/blog/blog-service.ts +0 -31
- package/src/routes/blog/rss/+server.ts +0 -16
- package/static/favicon.png +0 -0
- package/svelte.config.js +0 -30
- package/tailwind.config.cjs +0 -14
- package/tsconfig.json +0 -37
- package/vite.config.js +0 -25
|
@@ -1,391 +0,0 @@
|
|
|
1
|
-
<script lang="ts">
|
|
2
|
-
import { writable, type Writable } from 'svelte/store';
|
|
3
|
-
|
|
4
|
-
// DocShell
|
|
5
|
-
import DocsShell from '$docs/DocsShell/DocsShell.svelte';
|
|
6
|
-
import { DocsFeature, type DocsShellSettings } from '$docs/DocsShell/types';
|
|
7
|
-
|
|
8
|
-
// Utilities
|
|
9
|
-
import CodeBlock from '$lib/utilities/CodeBlock/CodeBlock.svelte';
|
|
10
|
-
|
|
11
|
-
// @ts-expect-error sveld import
|
|
12
|
-
import sveldModal from '$lib/utilities/Modal/Modal.svelte?raw&sveld';
|
|
13
|
-
|
|
14
|
-
// Modals Utils
|
|
15
|
-
import type { ModalSettings, ModalComponent } from '$lib/utilities/Modal/types';
|
|
16
|
-
import { modalStore } from '$lib/utilities/Modal/stores';
|
|
17
|
-
import ModalExampleForm from '$lib/utilities/Modal/examples/ModalExampleForm.svelte';
|
|
18
|
-
import ModalExampleList from '$lib/utilities/Modal/examples/ModalExampleList.svelte';
|
|
19
|
-
import ModalExampleEmbed from '$lib/utilities/Modal/examples/ModalExampleEmbed.svelte';
|
|
20
|
-
import TabGroup from '$lib/components/Tab/TabGroup.svelte';
|
|
21
|
-
import Tab from '$lib/components/Tab/Tab.svelte';
|
|
22
|
-
|
|
23
|
-
// Stores
|
|
24
|
-
const storeModalStandard: Writable<string> = writable('alert');
|
|
25
|
-
|
|
26
|
-
// Docs Shell
|
|
27
|
-
const settings: DocsShellSettings = {
|
|
28
|
-
feature: DocsFeature.Utility,
|
|
29
|
-
name: 'Modals',
|
|
30
|
-
description: 'High priority dialogs and modals using a dynamic queue system.',
|
|
31
|
-
imports: ['Modal', 'modalStore'],
|
|
32
|
-
types: ['ModalSettings', 'ModalComponent'],
|
|
33
|
-
source: 'utilities/Modal',
|
|
34
|
-
aria: 'https://www.w3.org/WAI/ARIA/apg/patterns/modalmodal/',
|
|
35
|
-
components: [{ sveld: sveldModal }],
|
|
36
|
-
keyboard: [['<kbd>Esc</kbd>', ' Dismisses the foremost modal.']]
|
|
37
|
-
};
|
|
38
|
-
|
|
39
|
-
// Standard ---
|
|
40
|
-
|
|
41
|
-
function modalAlert(): void {
|
|
42
|
-
const d: ModalSettings = {
|
|
43
|
-
type: 'alert',
|
|
44
|
-
title: 'Welcome to Skeleton',
|
|
45
|
-
body: 'This simple alert modal examples uses <code>type: alert</code> and makes use of the optional <code>title</code>, <code>body</code>, and <code>image</code> values.',
|
|
46
|
-
image: 'https://i.imgur.com/WOgTG96.gif'
|
|
47
|
-
};
|
|
48
|
-
modalStore.trigger(d);
|
|
49
|
-
}
|
|
50
|
-
|
|
51
|
-
function modalConfirm(): void {
|
|
52
|
-
const d: ModalSettings = {
|
|
53
|
-
type: 'confirm',
|
|
54
|
-
title: 'Please Confirm',
|
|
55
|
-
body: 'Are you sure you wish to proceed?',
|
|
56
|
-
response: (r: boolean) => {
|
|
57
|
-
if (r) console.log('response:', r);
|
|
58
|
-
}
|
|
59
|
-
};
|
|
60
|
-
modalStore.trigger(d);
|
|
61
|
-
}
|
|
62
|
-
|
|
63
|
-
function modalPrompt(): void {
|
|
64
|
-
const d: ModalSettings = {
|
|
65
|
-
type: 'prompt',
|
|
66
|
-
title: 'Enter Name',
|
|
67
|
-
body: 'Provide your first name in the field below.',
|
|
68
|
-
value: 'Skeleton',
|
|
69
|
-
response: (r: string) => {
|
|
70
|
-
if (r) console.log('response:', r);
|
|
71
|
-
}
|
|
72
|
-
};
|
|
73
|
-
modalStore.trigger(d);
|
|
74
|
-
}
|
|
75
|
-
|
|
76
|
-
function modalMultiple(): void {
|
|
77
|
-
[1, 2, 3].forEach((dNum: number) => {
|
|
78
|
-
const d: ModalSettings = {
|
|
79
|
-
type: 'alert',
|
|
80
|
-
title: `Modal ${dNum}`,
|
|
81
|
-
body: `The modal body of ${dNum}.`
|
|
82
|
-
};
|
|
83
|
-
modalStore.trigger(d);
|
|
84
|
-
});
|
|
85
|
-
}
|
|
86
|
-
|
|
87
|
-
// Custom ---
|
|
88
|
-
|
|
89
|
-
function triggerAlert(): void {
|
|
90
|
-
console.log('working!');
|
|
91
|
-
}
|
|
92
|
-
|
|
93
|
-
function modalComponentForm(): void {
|
|
94
|
-
const c: ModalComponent = { ref: ModalExampleForm };
|
|
95
|
-
const d: ModalSettings = {
|
|
96
|
-
type: 'component',
|
|
97
|
-
title: 'Custom Form Component',
|
|
98
|
-
body: 'Complete the form below and then press submit.',
|
|
99
|
-
component: c,
|
|
100
|
-
response: (r: any) => {
|
|
101
|
-
if (r) console.log('response:', r);
|
|
102
|
-
},
|
|
103
|
-
meta: {
|
|
104
|
-
foo: 'bar',
|
|
105
|
-
fizz: 'buzz',
|
|
106
|
-
fn: triggerAlert
|
|
107
|
-
}
|
|
108
|
-
};
|
|
109
|
-
modalStore.trigger(d);
|
|
110
|
-
}
|
|
111
|
-
|
|
112
|
-
function modalComponentList(): void {
|
|
113
|
-
const c: ModalComponent = { ref: ModalExampleList };
|
|
114
|
-
const d: ModalSettings = {
|
|
115
|
-
type: 'component',
|
|
116
|
-
title: 'Custom List Component',
|
|
117
|
-
body: 'Make your selection then press submit.',
|
|
118
|
-
component: c,
|
|
119
|
-
response: (r: any) => {
|
|
120
|
-
if (r) console.log('response:', r);
|
|
121
|
-
}
|
|
122
|
-
};
|
|
123
|
-
modalStore.trigger(d);
|
|
124
|
-
}
|
|
125
|
-
|
|
126
|
-
function modalComponentEmbed(): void {
|
|
127
|
-
const c: ModalComponent = { ref: ModalExampleEmbed };
|
|
128
|
-
const d: ModalSettings = {
|
|
129
|
-
type: 'component',
|
|
130
|
-
component: c,
|
|
131
|
-
modalClasses: '!p-0 !bg-black !max-w-[75%] !overflow-visible'
|
|
132
|
-
};
|
|
133
|
-
modalStore.trigger(d);
|
|
134
|
-
}
|
|
135
|
-
</script>
|
|
136
|
-
|
|
137
|
-
<DocsShell {settings}>
|
|
138
|
-
<!-- Slot: Sandbox -->
|
|
139
|
-
<svelte:fragment slot="sandbox">
|
|
140
|
-
<section class="space-y-4">
|
|
141
|
-
<div class="card p-4 space-y-4">
|
|
142
|
-
<p class="text-center font-bold">Dialog Modals</p>
|
|
143
|
-
<div class="grid grid-cols-1 md:grid-cols-4 gap-4 md:max-w-[480px] mx-auto">
|
|
144
|
-
<button class="btn btn-ghost-surface" on:click={modalAlert}>Alert</button>
|
|
145
|
-
<button class="btn btn-ghost-surface" on:click={modalConfirm}>Confirm</button>
|
|
146
|
-
<button class="btn btn-ghost-surface" on:click={modalPrompt}>Prompt</button>
|
|
147
|
-
<button class="btn btn-ghost-surface" on:click={modalMultiple}>Multiple</button>
|
|
148
|
-
</div>
|
|
149
|
-
</div>
|
|
150
|
-
<div class="card p-4 space-y-4">
|
|
151
|
-
<p class="text-center font-bold">Custom Component Modals</p>
|
|
152
|
-
<div class="grid grid-cols-1 md:grid-cols-3 gap-4 md:max-w-[320px] mx-auto">
|
|
153
|
-
<button class="btn btn-ghost-surface" on:click={modalComponentForm}>Form</button>
|
|
154
|
-
<button class="btn btn-ghost-surface" on:click={modalComponentList}>List</button>
|
|
155
|
-
<button class="btn btn-ghost-surface" on:click={modalComponentEmbed}>Embed</button>
|
|
156
|
-
</div>
|
|
157
|
-
</div>
|
|
158
|
-
</section>
|
|
159
|
-
</svelte:fragment>
|
|
160
|
-
|
|
161
|
-
<!-- /actions/focus-trap -->
|
|
162
|
-
|
|
163
|
-
<!-- Slot: Usage -->
|
|
164
|
-
<svelte:fragment slot="usage">
|
|
165
|
-
<section class="space-y-4">
|
|
166
|
-
<p>
|
|
167
|
-
Import and add a single instance of the Modal component in your app's root layout. Since this is in global scope it will be possible
|
|
168
|
-
to reuse this feature throughout your entire application.
|
|
169
|
-
</p>
|
|
170
|
-
<CodeBlock language="html" code={`<Modal />`} />
|
|
171
|
-
</section>
|
|
172
|
-
<!-- Modal Store -->
|
|
173
|
-
<section class="space-y-4">
|
|
174
|
-
<h2>Modal Store</h2>
|
|
175
|
-
<p>When you wish to trigger a modal, import the <code>modalStore</code>, which acts as the modal queue.</p>
|
|
176
|
-
<CodeBlock language="ts" code={`import { modalStore } from '@skeletonlabs/skeleton';`} />
|
|
177
|
-
<h3>Trigger</h3>
|
|
178
|
-
<p>Note that <code>title</code>, <code>body</code>, and <code>image</code> are optional for <u>all</u> modal types.</p>
|
|
179
|
-
<TabGroup selected={storeModalStandard}>
|
|
180
|
-
<Tab value="alert">Alert</Tab>
|
|
181
|
-
<Tab value="confirm">Confirm</Tab>
|
|
182
|
-
<Tab value="prompt">Prompt</Tab>
|
|
183
|
-
</TabGroup>
|
|
184
|
-
{#if $storeModalStandard === 'alert'}
|
|
185
|
-
<CodeBlock
|
|
186
|
-
language="ts"
|
|
187
|
-
code={`
|
|
188
|
-
function triggerAlert(): void {
|
|
189
|
-
const alert: ModalSettings = {
|
|
190
|
-
type: 'alert',
|
|
191
|
-
title: 'Example Alert',
|
|
192
|
-
body: 'This is an example modal.',
|
|
193
|
-
image: 'https://i.imgur.com/WOgTG96.gif',
|
|
194
|
-
// Optionally override buttont text
|
|
195
|
-
buttonTextCancel: 'Cancel'
|
|
196
|
-
};
|
|
197
|
-
modalStore.trigger(alert);
|
|
198
|
-
}
|
|
199
|
-
`}
|
|
200
|
-
/>
|
|
201
|
-
{:else if $storeModalStandard === 'confirm'}
|
|
202
|
-
<CodeBlock
|
|
203
|
-
language="ts"
|
|
204
|
-
code={`
|
|
205
|
-
function triggerConfirm(): void {
|
|
206
|
-
const confirm: ModalSettings = {
|
|
207
|
-
type: 'confirm',
|
|
208
|
-
title: 'Please Confirm',
|
|
209
|
-
body: 'Are you sure you wish to proceed?',
|
|
210
|
-
// TRUE if confirm pressed, FALSE if cancel pressed
|
|
211
|
-
response: (r: boolean) => console.log('response:', r),
|
|
212
|
-
// Optionally override the button text
|
|
213
|
-
buttonTextCancel: 'Cancel',
|
|
214
|
-
buttonTextConfirm: 'Confirm',
|
|
215
|
-
};
|
|
216
|
-
modalStore.trigger(confirm);
|
|
217
|
-
}
|
|
218
|
-
`}
|
|
219
|
-
/>
|
|
220
|
-
{:else if $storeModalStandard === 'prompt'}
|
|
221
|
-
<CodeBlock
|
|
222
|
-
language="ts"
|
|
223
|
-
code={`
|
|
224
|
-
function triggerPrompt(): void {
|
|
225
|
-
const prompt: ModalSettings = {
|
|
226
|
-
type: 'prompt',
|
|
227
|
-
title: 'Enter Name',
|
|
228
|
-
body: 'Provide your first name in the field below.',
|
|
229
|
-
// Populates the initial input value
|
|
230
|
-
value: 'Skeleton',
|
|
231
|
-
// Returns the updated response value
|
|
232
|
-
response: (r: string) => console.log('response:', r)
|
|
233
|
-
// Optionally override the button text
|
|
234
|
-
buttonTextCancel: 'Cancel',
|
|
235
|
-
buttonTextSubmit: 'Submit',
|
|
236
|
-
};
|
|
237
|
-
modalStore.trigger(prompt);
|
|
238
|
-
}
|
|
239
|
-
`}
|
|
240
|
-
/>
|
|
241
|
-
{/if}
|
|
242
|
-
<!-- Close -->
|
|
243
|
-
<h3>Close</h3>
|
|
244
|
-
<p>Trigger the <code>close()</code> method to remove the first modal in the modal queue.</p>
|
|
245
|
-
<CodeBlock language="ts" code={`modalStore.close();`} />
|
|
246
|
-
<!-- Clear -->
|
|
247
|
-
<h3>Clear</h3>
|
|
248
|
-
<p>Trigger the <code>clear()</code> method completely empty the modal queue.</p>
|
|
249
|
-
<CodeBlock language="ts" code={`modalStore.clear();`} />
|
|
250
|
-
<!-- Debugging -->
|
|
251
|
-
<h3>Debugging the Queue</h3>
|
|
252
|
-
<p>Use the following technique to visualize the contents of the store for debugging.</p>
|
|
253
|
-
<CodeBlock language="html" code={`<pre>queue: {JSON.stringify($modalStore, null, 2)}</pre>`} />
|
|
254
|
-
</section>
|
|
255
|
-
<!-- Customizing Modals -->
|
|
256
|
-
<section class="space-y-4">
|
|
257
|
-
<h2>Customizing Modals</h2>
|
|
258
|
-
<p>
|
|
259
|
-
To customize an individual modal, append <code>classes</code> and provide the classes you wish to be applied to the modal window.
|
|
260
|
-
</p>
|
|
261
|
-
<CodeBlock
|
|
262
|
-
language="ts"
|
|
263
|
-
code={`
|
|
264
|
-
const d: ModalSettings = {
|
|
265
|
-
type: 'alert',
|
|
266
|
-
// ...
|
|
267
|
-
backdropClasses: '!items-start'
|
|
268
|
-
modalClasses: '!p-0 !bg-green-500 !max-w-[75%]'
|
|
269
|
-
};
|
|
270
|
-
`}
|
|
271
|
-
/>
|
|
272
|
-
<p>Note that <code>!</code> (important) may be required to override some styles.</p>
|
|
273
|
-
</section>
|
|
274
|
-
<!-- Component Modals -->
|
|
275
|
-
<section class="space-y-4">
|
|
276
|
-
<div class="flex items-center space-x-2">
|
|
277
|
-
<h2>Component Modals</h2>
|
|
278
|
-
<span class="badge badge-filled-warning">Advanced</span>
|
|
279
|
-
</div>
|
|
280
|
-
<p>You can create a custom modal by passing a <code>ModalComponent</code> object, which includes any Svelte component.</p>
|
|
281
|
-
<CodeBlock
|
|
282
|
-
language="ts"
|
|
283
|
-
code={`
|
|
284
|
-
// import MyCustomComponent from '...';\n
|
|
285
|
-
function triggerCustomModal(): void {
|
|
286
|
-
const modalComponent: ModalComponent = {
|
|
287
|
-
// Pass a reference to your custom component
|
|
288
|
-
ref: MyCustomComponent,
|
|
289
|
-
// Add your props as key/value pairs
|
|
290
|
-
props: { background: 'bg-red-500' },
|
|
291
|
-
// Provide default slot content as a template literal
|
|
292
|
-
slot: '<p>Skeleton</p>'
|
|
293
|
-
};
|
|
294
|
-
const d: ModalSettings = {
|
|
295
|
-
type: 'component',
|
|
296
|
-
// NOTE: title, body, response, etc are supported!
|
|
297
|
-
component: modalComponent,
|
|
298
|
-
// Pass abitrary data to the component
|
|
299
|
-
meta: { foo: 'bar', fizz: 'buzz', fn: myCustomFunction }
|
|
300
|
-
};
|
|
301
|
-
modalStore.trigger(d);
|
|
302
|
-
}
|
|
303
|
-
`}
|
|
304
|
-
/>
|
|
305
|
-
<p>
|
|
306
|
-
When constructing custom modals, you are responsible for implementing close/submit buttons, as well as triggering the response
|
|
307
|
-
method as needed. To make this process easier to understand, we have provided a few examples to demonstrate the process.
|
|
308
|
-
</p>
|
|
309
|
-
<a
|
|
310
|
-
class="btn btn-filled-secondary"
|
|
311
|
-
href="https://github.com/skeletonlabs/skeleton/tree/master/src/lib/utilities/Modal/examples"
|
|
312
|
-
target="_blank"
|
|
313
|
-
rel="noreferrer">View Example Modals</a
|
|
314
|
-
>
|
|
315
|
-
<p>Below are a few tips and recommendations for custom modals:</p>
|
|
316
|
-
<ul class="list-disc list-inside space-y-1">
|
|
317
|
-
<li>
|
|
318
|
-
Import and use the <code>modalStore</code> to interface directly with the active modal queue. <code>$modalStore[0]</code> is the visible
|
|
319
|
-
modal index.
|
|
320
|
-
</li>
|
|
321
|
-
<li>
|
|
322
|
-
Parent props are available via <code>parent</code> - ex: <code>parent.background</code> will provide the background color prop.
|
|
323
|
-
</li>
|
|
324
|
-
<li>
|
|
325
|
-
You can inspect the full list of <a
|
|
326
|
-
href="https://github.com/skeletonlabs/skeleton/blob/master/src/lib/utilities/Modal/Modal.svelte#L95"
|
|
327
|
-
target="_blank"
|
|
328
|
-
rel="noreferrer">available parent prop values</a
|
|
329
|
-
> in the source code.
|
|
330
|
-
</li>
|
|
331
|
-
<li>Use the <code>parent.onClose()</code> or <code>modalStore.close()</code> methods to close the modal.</li>
|
|
332
|
-
<li>Use the <code>$modalStore[0].response('myResponseDataHere');</code> method to return a response value.</li>
|
|
333
|
-
</ul>
|
|
334
|
-
</section>
|
|
335
|
-
<!-- Abitrary Data -->
|
|
336
|
-
<section class="space-y-4">
|
|
337
|
-
<div class="flex items-center space-x-2">
|
|
338
|
-
<h2>Abitrary Data</h2>
|
|
339
|
-
<span class="badge badge-filled-warning">Advanced</span>
|
|
340
|
-
</div>
|
|
341
|
-
<p>You can pass abitrary metadata to your modal via the <code>meta</code> setting. All data types are supported.</p>
|
|
342
|
-
<CodeBlock
|
|
343
|
-
language="ts"
|
|
344
|
-
code={`
|
|
345
|
-
const d: ModalSettings = {
|
|
346
|
-
// ...
|
|
347
|
-
meta: { foo: 'bar', fizz: 'buzz', fn: myCustomFunction }
|
|
348
|
-
};
|
|
349
|
-
modalStore.trigger(d);
|
|
350
|
-
`}
|
|
351
|
-
/>
|
|
352
|
-
<p>You can retrieve the data as follows. Note the wrapping <code>#if</code> conditional to prevent console errors on modal close.</p>
|
|
353
|
-
<CodeBlock
|
|
354
|
-
language="html"
|
|
355
|
-
code={`
|
|
356
|
-
{#if $modalStore[0]}
|
|
357
|
-
<pre>{$modalStore[0].meta?.foo}</pre>
|
|
358
|
-
{/if}
|
|
359
|
-
`}
|
|
360
|
-
/>
|
|
361
|
-
</section>
|
|
362
|
-
<hr />
|
|
363
|
-
<!-- SSR Warning -->
|
|
364
|
-
<section class="space-y-4">
|
|
365
|
-
<h2>SvelteKit SSR Warning</h2>
|
|
366
|
-
<p>
|
|
367
|
-
Be aware that there are <a
|
|
368
|
-
href="https://github.com/sveltejs/kit/discussions/4339#discussioncomment-2384978"
|
|
369
|
-
target="_blank"
|
|
370
|
-
rel="noreferrer">known issues when using Svelte stores with SSR</a
|
|
371
|
-
>, such as our modal store. To prevent these issues please avoid the use of the modal store within any SvelteKit Load function.
|
|
372
|
-
Likewise, if you need a modal to open on route initilization we advise triggering the <code>open()</code> method after the
|
|
373
|
-
<a href="https://kit.svelte.dev/docs/modules#$app-environment" target="_blank" rel="noreferrer"
|
|
374
|
-
>SvelteKit Browser environment context</a
|
|
375
|
-
> is available.
|
|
376
|
-
</p>
|
|
377
|
-
<CodeBlock
|
|
378
|
-
language="typescript"
|
|
379
|
-
code={`
|
|
380
|
-
import { browser } from '$app/environment';\n
|
|
381
|
-
if (browser) modalStore.trigger({...});
|
|
382
|
-
`}
|
|
383
|
-
/>
|
|
384
|
-
<p>
|
|
385
|
-
For additional context please see this <a href="https://github.com/skeletonlabs/skeleton/pull/580" target="_blank" rel="noreferrer"
|
|
386
|
-
>thread</a
|
|
387
|
-
>.
|
|
388
|
-
</p>
|
|
389
|
-
</section>
|
|
390
|
-
</svelte:fragment>
|
|
391
|
-
</DocsShell>
|
|
@@ -1,212 +0,0 @@
|
|
|
1
|
-
<script lang="ts">
|
|
2
|
-
import DocsShell from '$docs/DocsShell/DocsShell.svelte';
|
|
3
|
-
import { DocsFeature, type DocsShellSettings } from '$docs/DocsShell/types';
|
|
4
|
-
import CodeBlock from '$lib/utilities/CodeBlock/CodeBlock.svelte';
|
|
5
|
-
|
|
6
|
-
import type { ToastSettings } from '$lib/utilities/Toast/types';
|
|
7
|
-
import { toastStore } from '$lib/utilities/Toast/stores';
|
|
8
|
-
|
|
9
|
-
// @ts-expect-error sveld import
|
|
10
|
-
import sveldToast from '$lib/utilities/Toast/Toast.svelte?raw&sveld';
|
|
11
|
-
|
|
12
|
-
// Docs Shell
|
|
13
|
-
const settings: DocsShellSettings = {
|
|
14
|
-
feature: DocsFeature.Utility,
|
|
15
|
-
name: 'Toasts',
|
|
16
|
-
description: 'Simple notifications utilizing a dynamic queue system.',
|
|
17
|
-
imports: ['Toast', 'toastStore'],
|
|
18
|
-
types: ['ToastSettings'],
|
|
19
|
-
source: 'utilities/Toast',
|
|
20
|
-
components: [{ sveld: sveldToast }]
|
|
21
|
-
};
|
|
22
|
-
|
|
23
|
-
// Triggers Toasts ---
|
|
24
|
-
|
|
25
|
-
function toastBasic(): void {
|
|
26
|
-
const t: ToastSettings = { message: '👋 Hello and welcome to Skeleton.' };
|
|
27
|
-
toastStore.trigger(t);
|
|
28
|
-
}
|
|
29
|
-
|
|
30
|
-
function toastParagraph(): void {
|
|
31
|
-
const t: ToastSettings = {
|
|
32
|
-
message:
|
|
33
|
-
'Lorem ipsum dolor sit amet consectetur adipisicing elit. Distinctio consequuntur, blanditiis ducimus perspiciatis minima odit repellat rem iste incidunt laborum amet culpa officia maiores eum qui asperiores.',
|
|
34
|
-
autohide: false
|
|
35
|
-
};
|
|
36
|
-
toastStore.trigger(t);
|
|
37
|
-
}
|
|
38
|
-
|
|
39
|
-
function toastAction(): void {
|
|
40
|
-
const t: ToastSettings = {
|
|
41
|
-
message: 'Message contains a unique action.',
|
|
42
|
-
autohide: false,
|
|
43
|
-
action: {
|
|
44
|
-
label: 'Greeting',
|
|
45
|
-
response: () => alert('Hello, Skeleton')
|
|
46
|
-
}
|
|
47
|
-
};
|
|
48
|
-
toastStore.trigger(t);
|
|
49
|
-
}
|
|
50
|
-
|
|
51
|
-
function toastMultiple(): void {
|
|
52
|
-
toastStore.trigger({ message: 'Message will auto-hide after 2 seconds.', timeout: 2000 });
|
|
53
|
-
toastStore.trigger({ message: 'Message will remain until dismissed.', autohide: false });
|
|
54
|
-
toastStore.trigger({ message: 'Message will auto-hide after 5 seconds.' });
|
|
55
|
-
}
|
|
56
|
-
|
|
57
|
-
function toastPreset(preset: ToastSettings['preset']): void {
|
|
58
|
-
const t: ToastSettings = {
|
|
59
|
-
message: `This message uses the <u>${preset}</u> preset.`,
|
|
60
|
-
preset
|
|
61
|
-
};
|
|
62
|
-
toastStore.trigger(t);
|
|
63
|
-
}
|
|
64
|
-
function toastStyled(): void {
|
|
65
|
-
const t: ToastSettings = {
|
|
66
|
-
message: 'This message has custom styles.',
|
|
67
|
-
classes: 'bg-gradient-to-tr from-indigo-500 via-purple-500 to-pink-500 text-white'
|
|
68
|
-
};
|
|
69
|
-
toastStore.trigger(t);
|
|
70
|
-
}
|
|
71
|
-
</script>
|
|
72
|
-
|
|
73
|
-
<DocsShell {settings}>
|
|
74
|
-
<!-- Slot: Sandbox -->
|
|
75
|
-
<svelte:fragment slot="sandbox">
|
|
76
|
-
<div class="space-y-4">
|
|
77
|
-
<section class="card p-4">
|
|
78
|
-
<div class="grid grid-cols-1 md:grid-cols-5 gap-4 max-w-[700px] mx-auto">
|
|
79
|
-
<button class="btn btn-ghost-surface" on:click={toastBasic}>Basic</button>
|
|
80
|
-
<button class="btn btn-ghost-surface" on:click={toastParagraph}>Paragraph</button>
|
|
81
|
-
<button class="btn btn-ghost-surface" on:click={toastAction}>Action</button>
|
|
82
|
-
<button class="btn btn-ghost-surface" on:click={toastMultiple}>Multiple</button>
|
|
83
|
-
<button class="btn btn-ghost-surface" on:click={toastStyled}>Styled</button>
|
|
84
|
-
</div>
|
|
85
|
-
</section>
|
|
86
|
-
<section class="card p-4">
|
|
87
|
-
<!-- prettier-ignore -->
|
|
88
|
-
<div class="grid grid-cols-1 md:grid-cols-6 gap-4 max-w-[700px] mx-auto">
|
|
89
|
-
<button class="btn btn-ghost-surface" on:click={() => {toastPreset('primary')}}>Primary</button>
|
|
90
|
-
<button class="btn btn-ghost-surface" on:click={() => {toastPreset('secondary')}}>Secondary</button>
|
|
91
|
-
<button class="btn btn-ghost-surface" on:click={() => {toastPreset('tertiary')}}>Tertiary</button>
|
|
92
|
-
<button class="btn btn-ghost-surface" on:click={() => {toastPreset('success')}}>Success</button>
|
|
93
|
-
<button class="btn btn-ghost-surface" on:click={() => {toastPreset('warning')}}>Warning</button>
|
|
94
|
-
<button class="btn btn-ghost-surface" on:click={() => {toastPreset('error')}}>Error</button>
|
|
95
|
-
</div>
|
|
96
|
-
</section>
|
|
97
|
-
</div>
|
|
98
|
-
</svelte:fragment>
|
|
99
|
-
|
|
100
|
-
<!-- Slot: Usage -->
|
|
101
|
-
<svelte:fragment slot="usage">
|
|
102
|
-
<section class="space-y-4">
|
|
103
|
-
<p>
|
|
104
|
-
Import and add a single instance of the Toast component in your app's root layout. Since this is in global scope it will be possible
|
|
105
|
-
to reuse this feature throughout your entire application.
|
|
106
|
-
</p>
|
|
107
|
-
<CodeBlock language="html" code={`<Toast />`} />
|
|
108
|
-
</section>
|
|
109
|
-
<!-- Toast Store -->
|
|
110
|
-
<section class="space-y-4">
|
|
111
|
-
<h2>Toast Store</h2>
|
|
112
|
-
<p>The Modal Store acts as a queue for your toast messages.</p>
|
|
113
|
-
<CodeBlock
|
|
114
|
-
language="ts"
|
|
115
|
-
code={`import { toastStore } from '@skeletonlabs/skeleton';
|
|
116
|
-
`}
|
|
117
|
-
/>
|
|
118
|
-
<!-- Trigger -->
|
|
119
|
-
<h3>Trigger</h3>
|
|
120
|
-
<p>To add a message to the queue, use the <code>toastStore.trigger()</code> method and pass a toast settings object.</p>
|
|
121
|
-
<CodeBlock
|
|
122
|
-
language="ts"
|
|
123
|
-
code={`
|
|
124
|
-
function triggerToast(): void {
|
|
125
|
-
const t: ToastSettings = {
|
|
126
|
-
message: '👋 Hello and welcome to Skeleton.'
|
|
127
|
-
// Optional: Presets for primary | secondary | tertiary | warning
|
|
128
|
-
preset: 'primary',
|
|
129
|
-
// Optional: The auto-hide settings
|
|
130
|
-
autohide: true,
|
|
131
|
-
timeout: 5000,
|
|
132
|
-
// Optional: Adds a custom action button
|
|
133
|
-
action: {
|
|
134
|
-
label: 'Greeting',
|
|
135
|
-
response: () => alert('Hello, Skeleton')
|
|
136
|
-
}
|
|
137
|
-
};
|
|
138
|
-
toastStore.trigger(t);
|
|
139
|
-
}
|
|
140
|
-
`}
|
|
141
|
-
/>
|
|
142
|
-
<!-- Clear -->
|
|
143
|
-
<h3>Clear</h3>
|
|
144
|
-
<p>Use <code>toastStore.clear()</code> to clear the entire toast store queue.</p>
|
|
145
|
-
<CodeBlock language="ts" code={`toastStore.clear();`} />
|
|
146
|
-
<!-- Debug -->
|
|
147
|
-
<h3>Debug</h3>
|
|
148
|
-
<p>Use the following technique to visualize the contents of the store for debugging.</p>
|
|
149
|
-
<CodeBlock language="html" code={`<pre>queue: {JSON.stringify($toastStore, null, 2)}</pre>`} />
|
|
150
|
-
</section>
|
|
151
|
-
<!-- Styling -->
|
|
152
|
-
<section class="space-y-4">
|
|
153
|
-
<h2>Styling</h2>
|
|
154
|
-
<h3>Presets</h3>
|
|
155
|
-
<p>
|
|
156
|
-
We provide a quick set of preset styles for any theme colors. The <code>success</code> preset is always green, while
|
|
157
|
-
<code>error</code> is always red.
|
|
158
|
-
</p>
|
|
159
|
-
<CodeBlock
|
|
160
|
-
language="ts"
|
|
161
|
-
code={`
|
|
162
|
-
const t: ToastSettings = {
|
|
163
|
-
message: 'This message will have a colorful background.',
|
|
164
|
-
// Available presets include:
|
|
165
|
-
// primary | secondary | tertiary | warning | success | error
|
|
166
|
-
preset: 'warning',
|
|
167
|
-
};
|
|
168
|
-
`}
|
|
169
|
-
/>
|
|
170
|
-
<h3>Custom Styles</h3>
|
|
171
|
-
<p>
|
|
172
|
-
To customize an individual toast, append <code>classes</code> to your settings and add CSS classes you wish to be applied to the toast.
|
|
173
|
-
</p>
|
|
174
|
-
<CodeBlock
|
|
175
|
-
language="ts"
|
|
176
|
-
code={`
|
|
177
|
-
const t: ToastSettings = {
|
|
178
|
-
message: 'This message will have a colorful background.',
|
|
179
|
-
// Add your custom classes here:
|
|
180
|
-
classes: 'bg-gradient-to-tr from-indigo-500 via-purple-500 to-pink-500 text-white'
|
|
181
|
-
};
|
|
182
|
-
`}
|
|
183
|
-
/>
|
|
184
|
-
</section>
|
|
185
|
-
<section class="space-y-4">
|
|
186
|
-
<h2>SvelteKit SSR Warning</h2>
|
|
187
|
-
<p>
|
|
188
|
-
Be aware that there are <a
|
|
189
|
-
href="https://github.com/sveltejs/kit/discussions/4339#discussioncomment-2384978"
|
|
190
|
-
target="_blank"
|
|
191
|
-
rel="noreferrer">known issues when using Svelte stores with SSR</a
|
|
192
|
-
>, such as our toast store. To prevent these issues please avoid the use of the toast store within any SvelteKit Load function.
|
|
193
|
-
Likewise, if you need a toast to open on route initilization we advise triggering the <code>open()</code> method after the
|
|
194
|
-
<a href="https://kit.svelte.dev/docs/modules#$app-environment" target="_blank" rel="noreferrer"
|
|
195
|
-
>SvelteKit Browser environment context</a
|
|
196
|
-
> is available.
|
|
197
|
-
</p>
|
|
198
|
-
<CodeBlock
|
|
199
|
-
language="typescript"
|
|
200
|
-
code={`
|
|
201
|
-
import { browser } from '$app/environment';\n
|
|
202
|
-
if (browser) toastStore.trigger({...});
|
|
203
|
-
`}
|
|
204
|
-
/>
|
|
205
|
-
<p>
|
|
206
|
-
For additional context please see this <a href="https://github.com/skeletonlabs/skeleton/pull/580" target="_blank" rel="noreferrer"
|
|
207
|
-
>thread</a
|
|
208
|
-
>.
|
|
209
|
-
</p>
|
|
210
|
-
</section>
|
|
211
|
-
</svelte:fragment>
|
|
212
|
-
</DocsShell>
|