@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,377 +0,0 @@
|
|
|
1
|
-
<script lang="ts">
|
|
2
|
-
import { page } from '$app/stores';
|
|
3
|
-
import { writable, type Writable } from 'svelte/store';
|
|
4
|
-
|
|
5
|
-
// Types
|
|
6
|
-
import { DocsFeature, type DocsShellSettings } from '$docs/DocsShell/types';
|
|
7
|
-
|
|
8
|
-
// Components
|
|
9
|
-
import Table from '$lib/components/Table/Table.svelte';
|
|
10
|
-
import Tab from '$lib/components/Tab/Tab.svelte';
|
|
11
|
-
import TabGroup from '$lib/components/Tab/TabGroup.svelte';
|
|
12
|
-
import TableOfContents from '$lib/components/TableOfContents/TableOfContents.svelte';
|
|
13
|
-
|
|
14
|
-
// Utilities
|
|
15
|
-
import { toastStore } from '$lib/utilities/Toast/stores';
|
|
16
|
-
import type { ToastSettings } from '$lib/utilities/Toast/types';
|
|
17
|
-
import { sveldMapperProps, sveldMapperSlots, sveldeMapperEvents } from './sveldMapper';
|
|
18
|
-
|
|
19
|
-
// Props
|
|
20
|
-
export let settings: DocsShellSettings;
|
|
21
|
-
// Props (styles)
|
|
22
|
-
export let spacing = 'space-y-8 md:space-y-12';
|
|
23
|
-
// Props (regions)
|
|
24
|
-
export let regionHeader = 'card-glass-surface border-b border-black/5 dark:border-white/5';
|
|
25
|
-
export let regionDetails = 'overflow-x-auto whitespace-nowrap grid grid-cols-1 md:grid-cols-[128px_1fr] gap-3';
|
|
26
|
-
export let regionPanels = 'page-container';
|
|
27
|
-
|
|
28
|
-
// Classes
|
|
29
|
-
const cBase = '';
|
|
30
|
-
|
|
31
|
-
// Stores
|
|
32
|
-
let storeActiveTab: Writable<string> = writable('usage');
|
|
33
|
-
|
|
34
|
-
// Local
|
|
35
|
-
const githubSourcePath = 'https://github.com/skeletonlabs/skeleton/tree/master/src'; // FIXME: hardcoded path
|
|
36
|
-
const defaultSettings: DocsShellSettings = {
|
|
37
|
-
// Heading
|
|
38
|
-
feature: DocsFeature.Component,
|
|
39
|
-
name: '(name)',
|
|
40
|
-
description: '(description)',
|
|
41
|
-
// Meta
|
|
42
|
-
imports: [],
|
|
43
|
-
types: [],
|
|
44
|
-
stylesheetIncludes: [],
|
|
45
|
-
stylesheets: [],
|
|
46
|
-
package: { name: '@skeletonlabs/skeleton', url: 'https://www.npmjs.com/package/@skeletonlabs/skeleton' },
|
|
47
|
-
source: '',
|
|
48
|
-
docsPath: $page.url.pathname,
|
|
49
|
-
aria: undefined,
|
|
50
|
-
dependencies: [],
|
|
51
|
-
// Docs
|
|
52
|
-
components: [],
|
|
53
|
-
restProps: undefined,
|
|
54
|
-
parameters: [],
|
|
55
|
-
classes: [],
|
|
56
|
-
keyboard: []
|
|
57
|
-
};
|
|
58
|
-
const pageSettings: DocsShellSettings = { ...defaultSettings, ...settings };
|
|
59
|
-
|
|
60
|
-
function toastCopied(noun: string): void {
|
|
61
|
-
const t: ToastSettings = { message: `Copied ${noun} to clipboard.`, timeout: 2000 };
|
|
62
|
-
toastStore.trigger(t);
|
|
63
|
-
}
|
|
64
|
-
|
|
65
|
-
// Sveld Counts ---
|
|
66
|
-
// Conditional tab display based on Sveld reference counts
|
|
67
|
-
|
|
68
|
-
const sveldCounts = { props: 0, slots: 0, events: 0 };
|
|
69
|
-
|
|
70
|
-
if (pageSettings.components && pageSettings.components?.length > 0) {
|
|
71
|
-
pageSettings.components.forEach((comp) => {
|
|
72
|
-
sveldCounts.props += comp.sveld.props.length;
|
|
73
|
-
sveldCounts.slots += comp.sveld.slots.length;
|
|
74
|
-
sveldCounts.events += comp.sveld.events.length;
|
|
75
|
-
});
|
|
76
|
-
}
|
|
77
|
-
|
|
78
|
-
// Format ---
|
|
79
|
-
|
|
80
|
-
function formatImports(): string {
|
|
81
|
-
return `import { ${pageSettings.imports?.join(', ')} } from '${pageSettings.package?.name}';`;
|
|
82
|
-
}
|
|
83
|
-
|
|
84
|
-
function formatTypes(): string {
|
|
85
|
-
return `import type { ${pageSettings.types?.join(', ')} } from '${pageSettings.package?.name}';`;
|
|
86
|
-
}
|
|
87
|
-
|
|
88
|
-
function formatStylesheet(stylesheet: string): string {
|
|
89
|
-
return `import '${pageSettings.package?.name}/styles/${stylesheet}.css';`;
|
|
90
|
-
}
|
|
91
|
-
|
|
92
|
-
// Copy ---
|
|
93
|
-
|
|
94
|
-
function copyImports(): void {
|
|
95
|
-
navigator.clipboard.writeText(formatImports());
|
|
96
|
-
toastCopied('import');
|
|
97
|
-
}
|
|
98
|
-
|
|
99
|
-
function copyTypes(): void {
|
|
100
|
-
navigator.clipboard.writeText(formatTypes());
|
|
101
|
-
toastCopied('type import');
|
|
102
|
-
}
|
|
103
|
-
|
|
104
|
-
function copyStylesheet(stylesheet: string): void {
|
|
105
|
-
navigator.clipboard.writeText(formatStylesheet(stylesheet));
|
|
106
|
-
toastCopied('stylesheet');
|
|
107
|
-
}
|
|
108
|
-
|
|
109
|
-
// Reactive
|
|
110
|
-
$: classesBase = `${cBase} ${$$props.class ?? ''}`;
|
|
111
|
-
$: classesRegionHeader = `${regionHeader}`;
|
|
112
|
-
$: classesRegionPanels = `${regionPanels}`;
|
|
113
|
-
</script>
|
|
114
|
-
|
|
115
|
-
<div class="doc-shell {classesBase}">
|
|
116
|
-
<!-- Region: Header -->
|
|
117
|
-
<header class="doc-shell-header {classesRegionHeader}">
|
|
118
|
-
<!-- Information -->
|
|
119
|
-
<div class="doc-shell-info page-container !pb-0 lg:!space-y-10">
|
|
120
|
-
<!-- Intro -->
|
|
121
|
-
<section class="space-y-4">
|
|
122
|
-
<div class="flex items-center space-x-4">
|
|
123
|
-
<h1>{@html pageSettings.name}</h1>
|
|
124
|
-
<!-- Feature -->
|
|
125
|
-
<span class="badge badge-glass translate-y-1">{@html pageSettings.feature}</span>
|
|
126
|
-
</div>
|
|
127
|
-
<p>{@html pageSettings.description}</p>
|
|
128
|
-
</section>
|
|
129
|
-
|
|
130
|
-
<!-- Details -->
|
|
131
|
-
<section class="doc-shell-details {regionDetails}">
|
|
132
|
-
<!-- Imports -->
|
|
133
|
-
{#if pageSettings.imports?.length}
|
|
134
|
-
<p class="hidden md:inline-block w-32">Import</p>
|
|
135
|
-
<div>
|
|
136
|
-
<button class="chip chip-primary" on:click={copyImports}>{formatImports()}</button>
|
|
137
|
-
</div>
|
|
138
|
-
{/if}
|
|
139
|
-
<!-- Types -->
|
|
140
|
-
{#if pageSettings.types?.length}
|
|
141
|
-
<p class="hidden md:inline-block w-32">Types</p>
|
|
142
|
-
<div>
|
|
143
|
-
<button class="chip chip-primary" on:click={copyTypes}>{formatTypes()}</button>
|
|
144
|
-
</div>
|
|
145
|
-
{/if}
|
|
146
|
-
<!-- Stylesheets -->
|
|
147
|
-
{#if pageSettings.stylesheetIncludes?.length || pageSettings.stylesheets?.length}
|
|
148
|
-
<p class="hidden md:inline-block w-32">Stylesheets</p>
|
|
149
|
-
<!-- prettier-ignore -->
|
|
150
|
-
<div class="flex space-x-2">
|
|
151
|
-
<!-- Stylesheet Includes -->
|
|
152
|
-
{#if pageSettings.stylesheetIncludes?.length}
|
|
153
|
-
{#each pageSettings.stylesheetIncludes as si}
|
|
154
|
-
<button class="chip chip-primary" on:click={() => {copyStylesheet(si)}}>{si}.css</button>
|
|
155
|
-
{/each}
|
|
156
|
-
{/if}
|
|
157
|
-
<!-- Stylesheets -->
|
|
158
|
-
{#if pageSettings.stylesheets?.length}
|
|
159
|
-
{#each pageSettings.stylesheets as s}
|
|
160
|
-
<button class="chip chip-primary" on:click={() => {copyStylesheet(s)}}>{s}.css</button>
|
|
161
|
-
{/each}
|
|
162
|
-
{/if}
|
|
163
|
-
</div>
|
|
164
|
-
{/if}
|
|
165
|
-
<!-- Package -->
|
|
166
|
-
<p class="hidden md:inline-block w-32">Package</p>
|
|
167
|
-
<div class="flex items-center space-x-2">
|
|
168
|
-
<i class="fa-brands fa-npm" />
|
|
169
|
-
<a href={pageSettings.package?.url} target="_blank" rel="noreferrer">{pageSettings.package?.name}</a>
|
|
170
|
-
</div>
|
|
171
|
-
<!-- Source Code -->
|
|
172
|
-
<p class="hidden md:inline-block w-32">Source</p>
|
|
173
|
-
<div class="flex items-center space-x-2">
|
|
174
|
-
<i class="fa-brands fa-github" />
|
|
175
|
-
<a href={`${githubSourcePath}/lib/${pageSettings.source}`} target="_blank" rel="noreferrer">Source Code</a>
|
|
176
|
-
</div>
|
|
177
|
-
<!-- Doc Source -->
|
|
178
|
-
<p class="hidden md:inline-block w-32">Doc</p>
|
|
179
|
-
<div class="flex items-center space-x-2">
|
|
180
|
-
<i class="fa-solid fa-code" />
|
|
181
|
-
<a href={`${githubSourcePath}/routes/(inner)${pageSettings.docsPath}/+page.svelte`} target="_blank" rel="noreferrer">
|
|
182
|
-
View Page Source
|
|
183
|
-
</a>
|
|
184
|
-
</div>
|
|
185
|
-
<!-- Dependencies -->
|
|
186
|
-
{#if pageSettings.dependencies?.length}
|
|
187
|
-
<p class="hidden md:inline-block w-32">Dependencies</p>
|
|
188
|
-
<div class="flex items-center space-x-2">
|
|
189
|
-
<i class="fa-solid fa-down-left-and-up-right-to-center" />
|
|
190
|
-
<div class="grid grid-cols-1 gap-2">
|
|
191
|
-
{#each pageSettings.dependencies as d}
|
|
192
|
-
<a href={d.url} target="_blank" rel="noreferrer">{d.label}</a>
|
|
193
|
-
{/each}
|
|
194
|
-
</div>
|
|
195
|
-
</div>
|
|
196
|
-
{/if}
|
|
197
|
-
<!-- Accessibility -->
|
|
198
|
-
{#if pageSettings.aria}
|
|
199
|
-
<p class="hidden md:inline-block w-32">WAI-ARIA</p>
|
|
200
|
-
<div class="flex items-center space-x-2">
|
|
201
|
-
<i class="fa-solid fa-universal-access" />
|
|
202
|
-
<a href={pageSettings.aria} target="_blank" rel="noreferrer">Accessibility Reference</a>
|
|
203
|
-
</div>
|
|
204
|
-
{/if}
|
|
205
|
-
</section>
|
|
206
|
-
|
|
207
|
-
<!-- Tabs -->
|
|
208
|
-
<TabGroup selected={storeActiveTab} rail={false}>
|
|
209
|
-
<Tab value="usage">Usage</Tab>
|
|
210
|
-
<!-- Based on Sveld -->
|
|
211
|
-
{#if sveldCounts.props > 0}<Tab value="properties">Props</Tab>{/if}
|
|
212
|
-
{#if sveldCounts.slots > 0}<Tab value="slots">Slots</Tab>{/if}
|
|
213
|
-
{#if sveldCounts.events > 0}<Tab value="events">Events</Tab>{/if}
|
|
214
|
-
<!-- Based on Page Settings -->
|
|
215
|
-
{#if pageSettings.parameters?.length}<Tab value="parameters">Params</Tab>{/if}
|
|
216
|
-
{#if pageSettings.classes?.length}<Tab value="classes">Classes</Tab>{/if}
|
|
217
|
-
{#if pageSettings.keyboard?.length}<Tab value="keyboard">Keyboard</Tab>{/if}
|
|
218
|
-
</TabGroup>
|
|
219
|
-
</div>
|
|
220
|
-
</header>
|
|
221
|
-
|
|
222
|
-
<!-- Tab Panels -->
|
|
223
|
-
<div class="doc-shell-tab-panels relative">
|
|
224
|
-
<!-- Tab: Usage -->
|
|
225
|
-
{#if $storeActiveTab === 'usage'}
|
|
226
|
-
<div class="doc-shell-usage {classesRegionPanels}">
|
|
227
|
-
<div class="grid grid-cols-1 2xl:grid-cols-[1fr_240px]">
|
|
228
|
-
<!-- Content -->
|
|
229
|
-
<div class={spacing}>
|
|
230
|
-
<!-- Slot: Examples Sandbox -->
|
|
231
|
-
{#if $$slots.sandbox}
|
|
232
|
-
<div>
|
|
233
|
-
<h2 class="sr-only">Examples</h2>
|
|
234
|
-
<div class="doc-shell-sandbox {spacing}">
|
|
235
|
-
<slot name="sandbox">(sandbox)</slot>
|
|
236
|
-
</div>
|
|
237
|
-
</div>
|
|
238
|
-
{/if}
|
|
239
|
-
<div id="toc-target" class={spacing}>
|
|
240
|
-
<!-- Slot: Usage -->
|
|
241
|
-
{#if $$slots.usage}
|
|
242
|
-
<div>
|
|
243
|
-
<h2 class="sr-only">Getting Started</h2>
|
|
244
|
-
<div class="doc-shell-usage {spacing}">
|
|
245
|
-
<slot name="usage">(usage)</slot>
|
|
246
|
-
</div>
|
|
247
|
-
</div>
|
|
248
|
-
{/if}
|
|
249
|
-
<!-- Slot: Overflow -->
|
|
250
|
-
{#if $$slots.default}
|
|
251
|
-
<footer class="doc-shell-footer"><slot /></footer>
|
|
252
|
-
{/if}
|
|
253
|
-
</div>
|
|
254
|
-
</div>
|
|
255
|
-
<!-- Table of Contents -->
|
|
256
|
-
<div>
|
|
257
|
-
<TableOfContents target="#toc-target" minimumHeadings={1} class="sticky top-10 hidden 2xl:inline-block ml-4" />
|
|
258
|
-
</div>
|
|
259
|
-
</div>
|
|
260
|
-
</div>
|
|
261
|
-
{/if}
|
|
262
|
-
|
|
263
|
-
<!-- Tab: Component Properties -->
|
|
264
|
-
{#if $storeActiveTab === 'properties'}
|
|
265
|
-
<div class="doc-shell-properties {classesRegionPanels}">
|
|
266
|
-
<!-- Supports restProps -->
|
|
267
|
-
{#if pageSettings.restProps}
|
|
268
|
-
<p>
|
|
269
|
-
This component makes use of <a
|
|
270
|
-
href="https://svelte.dev/docs#template-syntax-attributes-and-props"
|
|
271
|
-
target="_blank"
|
|
272
|
-
rel="noreferrer">restProps</a
|
|
273
|
-
>
|
|
274
|
-
for the
|
|
275
|
-
<code>{pageSettings.restProps}</code> element.
|
|
276
|
-
</p>
|
|
277
|
-
{/if}
|
|
278
|
-
<!-- Tables -->
|
|
279
|
-
{#if pageSettings.components}
|
|
280
|
-
{#each pageSettings.components as comp}
|
|
281
|
-
{#if comp.sveld.props.length > 0}
|
|
282
|
-
{@const tableSource = sveldMapperProps(comp)}
|
|
283
|
-
<section class="space-y-4">
|
|
284
|
-
{#if comp.label}<h2>{comp.label}</h2>{/if}
|
|
285
|
-
{#if comp.descProps}<div>{@html comp.descProps}</div>{/if}
|
|
286
|
-
{#if tableSource.body.length > 0}<Table source={tableSource} />{/if}
|
|
287
|
-
{#if comp.overrideProps}<div>
|
|
288
|
-
<em>{comp.label} can override: <span class="text-primary-500">{comp.overrideProps.join(', ')}</span>.</em>
|
|
289
|
-
</div>{/if}
|
|
290
|
-
</section>
|
|
291
|
-
{/if}
|
|
292
|
-
{/each}
|
|
293
|
-
{/if}
|
|
294
|
-
</div>
|
|
295
|
-
{/if}
|
|
296
|
-
|
|
297
|
-
<!-- Tab: Component Slots -->
|
|
298
|
-
{#if $storeActiveTab === 'slots'}
|
|
299
|
-
<div class="doc-shell-slots {classesRegionPanels}">
|
|
300
|
-
{#if pageSettings.components}
|
|
301
|
-
{#each pageSettings.components as comp}
|
|
302
|
-
{#if comp.sveld.slots.length > 0}
|
|
303
|
-
{@const tableSource = sveldMapperSlots(comp)}
|
|
304
|
-
<section class="space-y-4">
|
|
305
|
-
{#if comp.label}<h2>{comp.label}</h2>{/if}
|
|
306
|
-
{#if comp.descSlots}<div>{@html comp.descSlots}</div>{/if}
|
|
307
|
-
{#if tableSource.body.length > 0}<Table source={tableSource} />{/if}
|
|
308
|
-
</section>
|
|
309
|
-
{/if}
|
|
310
|
-
{/each}
|
|
311
|
-
{/if}
|
|
312
|
-
</div>
|
|
313
|
-
{/if}
|
|
314
|
-
|
|
315
|
-
<!-- Tab: Component Events -->
|
|
316
|
-
{#if $storeActiveTab === 'events'}
|
|
317
|
-
<div class="doc-shell-events {classesRegionPanels}">
|
|
318
|
-
{#if pageSettings.components}
|
|
319
|
-
{#each pageSettings.components as comp}
|
|
320
|
-
{#if comp.sveld.events.length > 0}
|
|
321
|
-
{@const tableSource = sveldeMapperEvents(comp)}
|
|
322
|
-
<section class="space-y-4">
|
|
323
|
-
{#if comp.label}<h2>{comp.label}</h2>{/if}
|
|
324
|
-
{#if comp.descEvents}<div>{@html comp.descEvents}</div>{/if}
|
|
325
|
-
{#if tableSource.body.length > 0}<Table source={tableSource} />{/if}
|
|
326
|
-
</section>
|
|
327
|
-
{/if}
|
|
328
|
-
{/each}
|
|
329
|
-
{/if}
|
|
330
|
-
</div>
|
|
331
|
-
{/if}
|
|
332
|
-
|
|
333
|
-
<!-- Tab: Action Parameters -->
|
|
334
|
-
{#if pageSettings.parameters?.length && $storeActiveTab === 'parameters'}
|
|
335
|
-
<div class="doc-shell-parameters {classesRegionPanels}">
|
|
336
|
-
<Table
|
|
337
|
-
source={{
|
|
338
|
-
head: ['Prop', 'Type', 'Default', 'Values', 'Description'],
|
|
339
|
-
body: pageSettings.parameters
|
|
340
|
-
}}
|
|
341
|
-
/>
|
|
342
|
-
</div>
|
|
343
|
-
{/if}
|
|
344
|
-
|
|
345
|
-
<!-- Tab: Tailwind Element Classes -->
|
|
346
|
-
{#if pageSettings.classes?.length && $storeActiveTab === 'classes'}
|
|
347
|
-
<div class="doc-shell-classes {classesRegionPanels}">
|
|
348
|
-
<Table
|
|
349
|
-
source={{
|
|
350
|
-
head: ['Keys', 'Values', 'Description'],
|
|
351
|
-
body: pageSettings.classes
|
|
352
|
-
}}
|
|
353
|
-
/>
|
|
354
|
-
</div>
|
|
355
|
-
{/if}
|
|
356
|
-
|
|
357
|
-
<!-- Tab: Keyboard Interactions -->
|
|
358
|
-
{#if $storeActiveTab === 'keyboard'}
|
|
359
|
-
{#if pageSettings.keyboard?.length}
|
|
360
|
-
<div class="doc-shell-keyboard {classesRegionPanels}">
|
|
361
|
-
<Table
|
|
362
|
-
source={{
|
|
363
|
-
head: ['Keys', 'Description'],
|
|
364
|
-
body: pageSettings.keyboard
|
|
365
|
-
}}
|
|
366
|
-
/>
|
|
367
|
-
</div>
|
|
368
|
-
{/if}
|
|
369
|
-
{/if}
|
|
370
|
-
</div>
|
|
371
|
-
</div>
|
|
372
|
-
|
|
373
|
-
<style lang="postcss">
|
|
374
|
-
.doc-shell-info code {
|
|
375
|
-
@apply hover:!bg-primary-500/30 transition-colors duration-100 cursor-pointer;
|
|
376
|
-
}
|
|
377
|
-
</style>
|
|
@@ -1,143 +0,0 @@
|
|
|
1
|
-
import type { Component } from './types';
|
|
2
|
-
|
|
3
|
-
import type { TableSource } from './../../lib/components/Table/types';
|
|
4
|
-
|
|
5
|
-
// Mapper: Props
|
|
6
|
-
export function sveldMapperProps(component: Component): TableSource {
|
|
7
|
-
const { props } = component.sveld;
|
|
8
|
-
const propsHeadings = ['Name', 'Type', 'Value', 'Description'];
|
|
9
|
-
// Filter props with undefined types (exclude getContext)
|
|
10
|
-
const propsFiltered = props.filter((p) => p.type !== undefined);
|
|
11
|
-
// Return table headings/source
|
|
12
|
-
function cleanValue(value: string | undefined): string {
|
|
13
|
-
if (value === undefined || value === '' || value === "''") return '-';
|
|
14
|
-
return value;
|
|
15
|
-
}
|
|
16
|
-
return {
|
|
17
|
-
head: propsHeadings,
|
|
18
|
-
body: propsFiltered.map((p) => {
|
|
19
|
-
return [`<code>${p.name}<?code>`, `<em>${p.type}</em>`, cleanValue(p.value), p.description ? p?.description : '-'];
|
|
20
|
-
})
|
|
21
|
-
};
|
|
22
|
-
}
|
|
23
|
-
|
|
24
|
-
// Mapper: Slots
|
|
25
|
-
export function sveldMapperSlots(component: Component): TableSource {
|
|
26
|
-
const { slots } = component.sveld;
|
|
27
|
-
const slotsHeadings = ['Name', 'Default', 'Fallback', 'Description'];
|
|
28
|
-
return {
|
|
29
|
-
head: slotsHeadings,
|
|
30
|
-
body: slots.map((s) => {
|
|
31
|
-
// prettier-ignore
|
|
32
|
-
return [
|
|
33
|
-
`<code>${s.name.replaceAll('__', '')}</code>`,
|
|
34
|
-
s.default ? '✓' : '-',
|
|
35
|
-
s.fallback ? '✓' : '-',
|
|
36
|
-
// s.slot_props ? s.slot_props : '-', // NOTE: we don't currently use this
|
|
37
|
-
s.description ? s.description : '-'
|
|
38
|
-
];
|
|
39
|
-
})
|
|
40
|
-
};
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
// Mapper: Events
|
|
44
|
-
export function sveldeMapperEvents(component: Component): TableSource {
|
|
45
|
-
const { events } = component.sveld;
|
|
46
|
-
const eventsHeadings = ['Name', 'Type', 'Element', 'Response', 'Description'];
|
|
47
|
-
return {
|
|
48
|
-
head: eventsHeadings,
|
|
49
|
-
body: events.map((e) => {
|
|
50
|
-
// prettier-ignore
|
|
51
|
-
return [
|
|
52
|
-
`<code>on:${e.name}</code>`,
|
|
53
|
-
`<em>${e.type}</em>`,
|
|
54
|
-
e.element ? escapeHtml(`<${e.element}>`) : '-',
|
|
55
|
-
e.detail ? e.detail : '-',
|
|
56
|
-
e.description ? e.description : '-'
|
|
57
|
-
];
|
|
58
|
-
})
|
|
59
|
-
};
|
|
60
|
-
}
|
|
61
|
-
|
|
62
|
-
// ---
|
|
63
|
-
|
|
64
|
-
// prettier-ignore
|
|
65
|
-
/**
|
|
66
|
-
* @param unsafe The unsafe raw HTML string
|
|
67
|
-
* @returns a nice, safely escaped string
|
|
68
|
-
* @see https://stackoverflow.com/questions/6234773/can-i-escape-html-special-chars-in-javascript
|
|
69
|
-
*/
|
|
70
|
-
function escapeHtml(unsafe: string) {
|
|
71
|
-
return unsafe
|
|
72
|
-
.replace(/&/g, "&")
|
|
73
|
-
.replace(/</g, "<")
|
|
74
|
-
.replace(/>/g, ">")
|
|
75
|
-
.replace(/"/g, """)
|
|
76
|
-
.replace(/'/g, "'");
|
|
77
|
-
}
|
|
78
|
-
|
|
79
|
-
// ---
|
|
80
|
-
|
|
81
|
-
/*
|
|
82
|
-
FROM CHRIS:
|
|
83
|
-
Let's aim for something more like this. Rather than trying to format every
|
|
84
|
-
description element in every single Sveld item, we handle it per instance.
|
|
85
|
-
The idea being that prop desc tags may differ from slot desc tags. It also
|
|
86
|
-
allows us to pass unique settings per instance rather than just assuming
|
|
87
|
-
they'll all be the same.
|
|
88
|
-
|
|
89
|
-
Likewise we might follow the lead above and have unique versions of the desc parser
|
|
90
|
-
per each type of data as well so they can be purpose-built for only the description
|
|
91
|
-
data they are handling. Though the universal method above may suffice.
|
|
92
|
-
*/
|
|
93
|
-
// function propDescTagParser(d) {}
|
|
94
|
-
|
|
95
|
-
// ----
|
|
96
|
-
|
|
97
|
-
// export function parseDescriptionAndTagsFromJSDocs(jsDocs: string) {
|
|
98
|
-
// let description: string = '';
|
|
99
|
-
// let tags: { [key: string]: string } = {};
|
|
100
|
-
// let capturingDescription = true;
|
|
101
|
-
// let currentTag = '';
|
|
102
|
-
// let currentCapture = '';
|
|
103
|
-
// let currentChar = '';
|
|
104
|
-
|
|
105
|
-
// for (let x = 0; x < jsDocs.length; x++) {
|
|
106
|
-
// currentChar = jsDocs[x];
|
|
107
|
-
// switch (currentChar) {
|
|
108
|
-
// case '@':
|
|
109
|
-
// //tag at front wipes out description
|
|
110
|
-
// if (capturingDescription && x < 1) {
|
|
111
|
-
// capturingDescription = false;
|
|
112
|
-
// }
|
|
113
|
-
// // normal capture of leading description till a tag
|
|
114
|
-
// if (capturingDescription && currentCapture.length > 1) {
|
|
115
|
-
// description = currentCapture;
|
|
116
|
-
// currentCapture = '';
|
|
117
|
-
// capturingDescription = false;
|
|
118
|
-
// }
|
|
119
|
-
// //two tags in a row, stash the first before capturing name of second below.
|
|
120
|
-
// if (currentTag.length > 1) {
|
|
121
|
-
// tags[currentTag] = currentCapture;
|
|
122
|
-
// currentTag = '';
|
|
123
|
-
// currentCapture = '';
|
|
124
|
-
// }
|
|
125
|
-
// //at start of tag, seek till space char for tag name
|
|
126
|
-
// while (x != jsDocs.length && currentChar != ' ') {
|
|
127
|
-
// currentTag += currentChar;
|
|
128
|
-
// x++;
|
|
129
|
-
// currentChar = jsDocs[x];
|
|
130
|
-
// }
|
|
131
|
-
// break;
|
|
132
|
-
// default:
|
|
133
|
-
// // capturing value of description or tag
|
|
134
|
-
// currentCapture += currentChar;
|
|
135
|
-
// break;
|
|
136
|
-
// }
|
|
137
|
-
// }
|
|
138
|
-
// //if a tag finishes the jsDoc string
|
|
139
|
-
// if (currentTag.length) {
|
|
140
|
-
// tags[currentTag] = currentCapture;
|
|
141
|
-
// }
|
|
142
|
-
// return [description, tags];
|
|
143
|
-
// }
|
|
@@ -1,96 +0,0 @@
|
|
|
1
|
-
export enum DocsFeature {
|
|
2
|
-
Element = 'Tailwind',
|
|
3
|
-
Component = 'Svelte Component',
|
|
4
|
-
Action = 'Svelte Action',
|
|
5
|
-
Utility = 'Utility'
|
|
6
|
-
}
|
|
7
|
-
|
|
8
|
-
interface Link {
|
|
9
|
-
label: string;
|
|
10
|
-
url: string;
|
|
11
|
-
}
|
|
12
|
-
|
|
13
|
-
export interface Component {
|
|
14
|
-
/** Provide a semantic component label. */
|
|
15
|
-
label?: string;
|
|
16
|
-
/** Provide HTML markup for a props description. */
|
|
17
|
-
descProps?: string;
|
|
18
|
-
/** Provide HTML markup for a slots description. */
|
|
19
|
-
descSlots?: string;
|
|
20
|
-
/** Provide HTML markup for a events description. */
|
|
21
|
-
descEvents?: string;
|
|
22
|
-
/** Provide a list of props that children can override. */
|
|
23
|
-
overrideProps?: string[];
|
|
24
|
-
/** Provide the raw component Sveld doc source. */
|
|
25
|
-
sveld: Record<string, SveldObj[]>;
|
|
26
|
-
}
|
|
27
|
-
|
|
28
|
-
export interface SveldObj {
|
|
29
|
-
name: string;
|
|
30
|
-
type: string;
|
|
31
|
-
description?: string;
|
|
32
|
-
value?: string;
|
|
33
|
-
detail?: string;
|
|
34
|
-
element?: string;
|
|
35
|
-
tags?: {
|
|
36
|
-
tag: string;
|
|
37
|
-
value?: string;
|
|
38
|
-
}[];
|
|
39
|
-
[key: string]: any;
|
|
40
|
-
}
|
|
41
|
-
|
|
42
|
-
export interface DocsShellSettings {
|
|
43
|
-
/** Documentation | Element | Component | Action | Utility */
|
|
44
|
-
feature: DocsFeature;
|
|
45
|
-
/** The feature name. */
|
|
46
|
-
name: string;
|
|
47
|
-
/** The feature description */
|
|
48
|
-
description: string;
|
|
49
|
-
/** Specifiy the GitHub source path for the feature (partial) */
|
|
50
|
-
source: string;
|
|
51
|
-
/** List of import alias names. */
|
|
52
|
-
imports?: string[];
|
|
53
|
-
/** List of import Typescript interface imports. */
|
|
54
|
-
types?: string[];
|
|
55
|
-
/** List of stylesheets that include the required styles. */
|
|
56
|
-
stylesheetIncludes?: string[];
|
|
57
|
-
/** List of CSS import paths (partials) */
|
|
58
|
-
stylesheets?: string[];
|
|
59
|
-
/** The NPM package this feature belongs to. */
|
|
60
|
-
package?: {
|
|
61
|
-
/** Package Name */
|
|
62
|
-
name: string;
|
|
63
|
-
/** Package URL */
|
|
64
|
-
url: string;
|
|
65
|
-
};
|
|
66
|
-
/** Specifify the GitHub documentation source for the feature (partial) */
|
|
67
|
-
docsPath?: string;
|
|
68
|
-
/** Provide list of depedency links. */
|
|
69
|
-
dependencies?: Link[];
|
|
70
|
-
/** WAI-ARIA APG reference page URL. */
|
|
71
|
-
aria?: string;
|
|
72
|
-
/** Component documentation, which utilizes Sveld. */
|
|
73
|
-
components?: Component[];
|
|
74
|
-
/** Component element that uses restProps */
|
|
75
|
-
restProps?: string;
|
|
76
|
-
/** Action parameter table source [prop, type, default, values, description] */
|
|
77
|
-
parameters?: [string, string, string, string, string][];
|
|
78
|
-
/** Tailwind Element classes table source [name, values, description] */
|
|
79
|
-
classes?: [string, string, string][];
|
|
80
|
-
/** Keyboard interaction table source [name, description]. */
|
|
81
|
-
keyboard?: [string, string][];
|
|
82
|
-
}
|
|
83
|
-
|
|
84
|
-
// NOTE: this will be removed alongside the move to the JSDocs documentation.
|
|
85
|
-
// export interface DocsShellTable {
|
|
86
|
-
// /** Provide a semantic label. */
|
|
87
|
-
// label?: string;
|
|
88
|
-
// /** Provide HTML for description region. */
|
|
89
|
-
// description?: string;
|
|
90
|
-
// /** Provide the table headings. */
|
|
91
|
-
// headings?: string[];
|
|
92
|
-
// /** Provide the table source data. */
|
|
93
|
-
// source?: string[][];
|
|
94
|
-
// /** WAI-ARIA APG page link. */
|
|
95
|
-
// aria?: string; // TODO: remove this
|
|
96
|
-
// }
|