@skeletonlabs/skeleton 0.86.9 → 0.92.1

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.
Files changed (411) hide show
  1. package/.eslintrc.cjs +20 -0
  2. package/.github/FUNDING.yml +13 -0
  3. package/.github/ISSUE_TEMPLATE/bug_report.yml +30 -0
  4. package/.github/ISSUE_TEMPLATE/config.yml +8 -0
  5. package/.github/ISSUE_TEMPLATE/docs_issue.yml +23 -0
  6. package/.github/ISSUE_TEMPLATE/feature_request.yml +22 -0
  7. package/.github/pull_request_template.md +14 -0
  8. package/.prettierignore +12 -0
  9. package/.prettierrc +6 -0
  10. package/package.json +61 -149
  11. package/postcss.config.cjs +14 -0
  12. package/scripts/compile-css-to-js.cjs +50 -0
  13. package/scripts/generate-jss.js +67 -0
  14. package/scripts/post-build.js +17 -0
  15. package/scripts/pre-build.js +14 -0
  16. package/src/app.d.ts +13 -0
  17. package/src/app.html +43 -0
  18. package/src/app.postcss +10 -0
  19. package/src/docs/DocsAppBar/DocsAppBar.svelte +213 -0
  20. package/src/docs/DocsFooter/DocsFooter.svelte +78 -0
  21. package/src/docs/DocsLogo/DocsLogoAnim.svelte +44 -0
  22. package/src/docs/DocsLogo/DocsLogoFull.svelte +11 -0
  23. package/src/docs/DocsLogo/DocsLogoIcon.svelte +6 -0
  24. package/src/docs/DocsNavigation/DocsDrawer.svelte +23 -0
  25. package/src/docs/DocsNavigation/DocsSidebar.svelte +103 -0
  26. package/src/docs/DocsNavigation/links.ts +148 -0
  27. package/src/docs/DocsSearch/DocsSearch.svelte +78 -0
  28. package/src/docs/DocsShell/DocsShell.svelte +377 -0
  29. package/src/docs/DocsShell/sveldMapper.ts +143 -0
  30. package/src/docs/DocsShell/types.ts +96 -0
  31. package/src/docs/DocsStyles/blog.css +192 -0
  32. package/src/docs/DocsThemer/DocsThemer.svelte +254 -0
  33. package/src/docs/DocsThemer/Swatch.svelte +28 -0
  34. package/src/docs/DocsThemer/colors.ts +122 -0
  35. package/src/docs/DocsThemer/settings.ts +129 -0
  36. package/src/docs/DocsThemer/stores.ts +5 -0
  37. package/src/docs/DocsThemer/types.ts +20 -0
  38. package/src/docs/README.md +3 -0
  39. package/src/docs/stores.ts +15 -0
  40. package/src/lib/actions/Clipboard/clipboard.ts +39 -0
  41. package/src/lib/actions/Filters/filter.test.ts +40 -0
  42. package/src/lib/actions/Filters/filter.ts +23 -0
  43. package/{actions → src/lib/actions}/Filters/svg-filters/Apollo.svelte +0 -0
  44. package/{actions → src/lib/actions}/Filters/svg-filters/BlueNight.svelte +0 -0
  45. package/{actions → src/lib/actions}/Filters/svg-filters/Emerald.svelte +0 -0
  46. package/{actions → src/lib/actions}/Filters/svg-filters/GreenFall.svelte +0 -0
  47. package/{actions → src/lib/actions}/Filters/svg-filters/Noir.svelte +0 -0
  48. package/{actions → src/lib/actions}/Filters/svg-filters/NoirLight.svelte +0 -0
  49. package/{actions → src/lib/actions}/Filters/svg-filters/Rustic.svelte +0 -0
  50. package/{actions → src/lib/actions}/Filters/svg-filters/Summer84.svelte +0 -0
  51. package/{actions → src/lib/actions}/Filters/svg-filters/XPro.svelte +0 -0
  52. package/src/lib/actions/FocusTrap/focusTrap.ts +56 -0
  53. package/src/lib/components/Accordion/AccordionGroup.svelte +53 -0
  54. package/src/lib/components/Accordion/AccordionGroup.test.ts +22 -0
  55. package/src/lib/components/Accordion/AccordionItem.svelte +80 -0
  56. package/src/lib/components/Accordion/AccordionItem.test.ts +28 -0
  57. package/src/lib/components/Alert/Alert.svelte +71 -0
  58. package/src/lib/components/Alert/Alert.test.ts +30 -0
  59. package/src/lib/components/AppBar/AppBar.svelte +60 -0
  60. package/src/lib/components/AppBar/AppBar.test.ts +31 -0
  61. package/src/lib/components/AppRail/AppRail.svelte +58 -0
  62. package/src/lib/components/AppRail/AppRailTile.svelte +66 -0
  63. package/src/lib/components/AppShell/AppShell.svelte +84 -0
  64. package/src/lib/components/AppShell/AppShell.test.ts +26 -0
  65. package/src/lib/components/Avatar/Avatar.svelte +51 -0
  66. package/src/lib/components/Avatar/Avatar.test.ts +41 -0
  67. package/src/lib/components/Breadcrumb/Breadcrumb.svelte +30 -0
  68. package/src/lib/components/Breadcrumb/Breadcrumb.test.ts +20 -0
  69. package/{components → src/lib/components}/Breadcrumb/Crumb.svelte +23 -16
  70. package/src/lib/components/Breadcrumb/Crumb.test.ts +48 -0
  71. package/src/lib/components/ConicGradient/ConicGradient.svelte +88 -0
  72. package/src/lib/components/ConicGradient/ConicGradient.test.ts +26 -0
  73. package/src/lib/components/ConicGradient/settings.ts +345 -0
  74. package/src/lib/components/ConicGradient/types.ts +12 -0
  75. package/src/lib/components/Divider/Divider.svelte +26 -0
  76. package/src/lib/components/Divider/Divider.test.ts +32 -0
  77. package/src/lib/components/FileButton/FileButton.svelte +29 -0
  78. package/src/lib/components/FileButton/FileButton.test.ts +32 -0
  79. package/src/lib/components/FileDropzone/FileDropzone.svelte +108 -0
  80. package/src/lib/components/FileDropzone/FileDropzone.test.ts +32 -0
  81. package/src/lib/components/GradientHeading/GradientHeading.svelte +24 -0
  82. package/src/lib/components/GradientHeading/GradientHeading.test.ts +30 -0
  83. package/src/lib/components/InputChip/InputChip.svelte +118 -0
  84. package/src/lib/components/ListBox/ListBox.svelte +65 -0
  85. package/src/lib/components/ListBox/ListBox.test.ts +48 -0
  86. package/src/lib/components/ListBox/ListBoxItem.svelte +99 -0
  87. package/src/lib/components/ListBox/ListBoxItem.test.ts +22 -0
  88. package/src/lib/components/Paginator/Paginator.svelte +84 -0
  89. package/src/lib/components/Paginator/Paginator.test.ts +29 -0
  90. package/src/lib/components/Paginator/types.ts +12 -0
  91. package/src/lib/components/ProgressBar/ProgressBar.svelte +73 -0
  92. package/src/lib/components/ProgressBar/ProgressBar.test.ts +27 -0
  93. package/src/lib/components/ProgressRadial/ProgressRadial.svelte +98 -0
  94. package/src/lib/components/ProgressRadial/ProgressRadial.test.ts +26 -0
  95. package/src/lib/components/Radio/RadioGroup.svelte +54 -0
  96. package/src/lib/components/Radio/RadioGroup.test.ts +35 -0
  97. package/src/lib/components/Radio/RadioItem.svelte +71 -0
  98. package/src/lib/components/Radio/RadioItem.test.ts +32 -0
  99. package/src/lib/components/RangeSlider/RangeSlider.svelte +110 -0
  100. package/src/lib/components/RangeSlider/RangeSlider.test.ts +44 -0
  101. package/src/lib/components/SlideToggle/SlideToggle.svelte +106 -0
  102. package/src/lib/components/SlideToggle/SlideToggle.test.ts +23 -0
  103. package/src/lib/components/Stepper/Step.svelte +140 -0
  104. package/src/lib/components/Stepper/Step.test.ts +21 -0
  105. package/src/lib/components/Stepper/Stepper.svelte +71 -0
  106. package/src/lib/components/Stepper/Stepper.test.ts +31 -0
  107. package/src/lib/components/SvgIcon/SvgIcon.svelte +50 -0
  108. package/src/lib/components/SvgIcon/SvgIcon.test.ts +28 -0
  109. package/src/lib/components/SvgIcon/icons.ts +29 -0
  110. package/src/lib/components/Tab/Tab.svelte +79 -0
  111. package/src/lib/components/Tab/Tab.test.ts +26 -0
  112. package/src/lib/components/Tab/TabGroup.svelte +78 -0
  113. package/src/lib/components/Tab/TabGroup.test.ts +30 -0
  114. package/src/lib/components/Table/Table.svelte +106 -0
  115. package/src/lib/components/Table/types.ts +10 -0
  116. package/{components/Table/utils.js → src/lib/components/Table/utils.ts} +16 -10
  117. package/src/lib/components/TableOfContents/TableOfContents.svelte +139 -0
  118. package/{index.d.ts → src/lib/index.ts} +33 -1
  119. package/{styles → src/lib/styles}/all.css +0 -3
  120. package/{styles → src/lib/styles}/core.css +3 -0
  121. package/src/lib/styles/elements/alerts.css +43 -0
  122. package/{styles → src/lib/styles}/elements/badges.css +1 -1
  123. package/src/lib/styles/elements/breadcrumbs.css +27 -0
  124. package/{styles → src/lib/styles}/elements/buttons.css +1 -1
  125. package/{styles → src/lib/styles}/elements/cards.css +1 -1
  126. package/src/lib/styles/elements/chips.css +71 -0
  127. package/{styles → src/lib/styles}/elements/lists.css +1 -1
  128. package/{styles → src/lib/styles}/elements/logo-clouds.css +1 -1
  129. package/{styles → src/lib/styles}/elements/menus.css +1 -1
  130. package/{styles → src/lib/styles}/elements/placeholders.css +1 -1
  131. package/{styles → src/lib/styles}/elements/tables.css +0 -0
  132. package/{styles → src/lib/styles}/elements/tooltips.css +1 -1
  133. package/{styles → src/lib/styles}/elements.css +2 -0
  134. package/{styles → src/lib/styles}/forms.css +57 -40
  135. package/{styles → src/lib/styles}/highlight-js.css +0 -0
  136. package/{styles → src/lib/styles}/tailwind.css +0 -0
  137. package/{styles → src/lib/styles}/typography.css +2 -2
  138. package/src/lib/tailwind/settings.cjs +20 -0
  139. package/src/lib/tailwind/skeleton.cjs +50 -0
  140. package/src/lib/tailwind/theme/colors.cjs +18 -0
  141. package/src/lib/tailwind/tokens/backgrounds.cjs +40 -0
  142. package/src/lib/tailwind/tokens/border-radius.cjs +21 -0
  143. package/src/lib/tailwind/tokens/borders.cjs +20 -0
  144. package/src/lib/tailwind/tokens/fills.cjs +20 -0
  145. package/src/lib/tailwind/tokens/rings.cjs +42 -0
  146. package/src/lib/tailwind/tokens/text.cjs +33 -0
  147. package/{themes → src/lib/themes}/theme-crimson.css +0 -0
  148. package/{themes → src/lib/themes}/theme-gold-nouveau.css +0 -0
  149. package/{themes → src/lib/themes}/theme-hamlindigo.css +0 -0
  150. package/{themes → src/lib/themes}/theme-modern.css +0 -0
  151. package/{themes → src/lib/themes}/theme-rocket.css +0 -0
  152. package/{themes → src/lib/themes}/theme-sahara.css +0 -0
  153. package/{themes → src/lib/themes}/theme-seafoam.css +0 -0
  154. package/{themes → src/lib/themes}/theme-seasonal.css +2 -2
  155. package/{themes → src/lib/themes}/theme-skeleton.css +6 -6
  156. package/src/lib/themes/theme-test.css +96 -0
  157. package/{themes → src/lib/themes}/theme-vintage.css +0 -0
  158. package/src/lib/utilities/CodeBlock/CodeBlock.svelte +78 -0
  159. package/src/lib/utilities/CodeBlock/CodeBlock.test.ts +27 -0
  160. package/src/lib/utilities/CodeBlock/stores.ts +5 -0
  161. package/src/lib/utilities/DataTable/DataTable.ts +151 -0
  162. package/src/lib/utilities/DataTable/actions.ts +100 -0
  163. package/src/lib/utilities/DataTable/types.ts +33 -0
  164. package/src/lib/utilities/Drawer/Drawer.svelte +173 -0
  165. package/src/lib/utilities/Drawer/Drawer.test.ts +15 -0
  166. package/src/lib/utilities/Drawer/stores.ts +27 -0
  167. package/src/lib/utilities/Drawer/types.ts +47 -0
  168. package/src/lib/utilities/LightSwitch/LightSwitch.svelte +116 -0
  169. package/src/lib/utilities/LightSwitch/LightSwitch.test.ts +19 -0
  170. package/src/lib/utilities/LightSwitch/stores.ts +7 -0
  171. package/src/lib/utilities/LocalStorageStore/LocalStorageStore.test.ts +220 -0
  172. package/src/lib/utilities/LocalStorageStore/LocalStorageStore.ts +77 -0
  173. package/src/lib/utilities/Menu/menu.test.ts +22 -0
  174. package/src/lib/utilities/Menu/menu.ts +172 -0
  175. package/src/lib/utilities/Modal/Modal.svelte +206 -0
  176. package/src/lib/utilities/Modal/Modal.test.ts +50 -0
  177. package/{utilities → src/lib/utilities}/Modal/examples/ModalExampleEmbed.svelte +7 -5
  178. package/{utilities → src/lib/utilities}/Modal/examples/ModalExampleForm.svelte +24 -20
  179. package/{utilities → src/lib/utilities}/Modal/examples/ModalExampleList.svelte +18 -13
  180. package/src/lib/utilities/Modal/stores.ts +29 -0
  181. package/src/lib/utilities/Modal/types.ts +39 -0
  182. package/src/lib/utilities/Toast/Toast.svelte +95 -0
  183. package/src/lib/utilities/Toast/Toats.test.ts +25 -0
  184. package/src/lib/utilities/Toast/stores.ts +63 -0
  185. package/src/lib/utilities/Toast/types.ts +29 -0
  186. package/src/lib/utilities/Tooltip/tooltip.ts +137 -0
  187. package/src/routes/(inner)/+layout.svelte +3 -0
  188. package/src/routes/(inner)/actions/clipboard/+page.svelte +87 -0
  189. package/src/routes/(inner)/actions/filters/+page.svelte +151 -0
  190. package/src/routes/(inner)/actions/focus-trap/+page.svelte +59 -0
  191. package/src/routes/(inner)/components/accordions/+page.svelte +127 -0
  192. package/src/routes/(inner)/components/alerts/+page.svelte +130 -0
  193. package/src/routes/(inner)/components/app-bar/+page.svelte +52 -0
  194. package/src/routes/(inner)/components/app-rail/+page.svelte +105 -0
  195. package/src/routes/(inner)/components/app-shell/+page.svelte +159 -0
  196. package/src/routes/(inner)/components/avatars/+page.svelte +193 -0
  197. package/src/routes/(inner)/components/breadcrumbs/+page.svelte +121 -0
  198. package/src/routes/(inner)/components/conic-gradients/+page.svelte +161 -0
  199. package/src/routes/(inner)/components/dividers/+page.svelte +146 -0
  200. package/src/routes/(inner)/components/file-buttons/+page.svelte +46 -0
  201. package/src/routes/(inner)/components/file-dropzone/+page.svelte +71 -0
  202. package/src/routes/(inner)/components/gradient-headings/+page.svelte +138 -0
  203. package/src/routes/(inner)/components/input-chips/+page.svelte +128 -0
  204. package/src/routes/(inner)/components/listboxes/+page.svelte +92 -0
  205. package/src/routes/(inner)/components/paginators/+page.svelte +118 -0
  206. package/src/routes/(inner)/components/progress-bars/+page.svelte +157 -0
  207. package/src/routes/(inner)/components/progress-radials/+page.svelte +64 -0
  208. package/src/routes/(inner)/components/radio-groups/+page.svelte +91 -0
  209. package/src/routes/(inner)/components/range-sliders/+page.svelte +134 -0
  210. package/src/routes/(inner)/components/slide-toggles/+page.svelte +63 -0
  211. package/src/routes/(inner)/components/steppers/+page.svelte +168 -0
  212. package/src/routes/(inner)/components/svg-icons/+page.svelte +60 -0
  213. package/src/routes/(inner)/components/table-of-contents/+page.svelte +110 -0
  214. package/src/routes/(inner)/components/tables/+page.svelte +216 -0
  215. package/src/routes/(inner)/components/tabs/+page.svelte +146 -0
  216. package/src/routes/(inner)/docs/comparisons/+page.svelte +130 -0
  217. package/src/routes/(inner)/docs/contributions/+page.svelte +78 -0
  218. package/src/routes/(inner)/docs/contributions/documentation/+page.svelte +217 -0
  219. package/src/routes/(inner)/docs/contributions/requirements/+page.svelte +173 -0
  220. package/src/routes/(inner)/docs/contributions/style-guide/+page.svelte +164 -0
  221. package/src/routes/(inner)/docs/faqs/+page.svelte +80 -0
  222. package/src/routes/(inner)/docs/features/+page.svelte +121 -0
  223. package/src/routes/(inner)/docs/recommended/+page.svelte +162 -0
  224. package/src/routes/(inner)/docs/why/+page.svelte +104 -0
  225. package/src/routes/(inner)/elements/alerts/+page.svelte +142 -0
  226. package/src/routes/(inner)/elements/badges/+page.svelte +155 -0
  227. package/src/routes/(inner)/elements/breadcrumbs/+page.svelte +132 -0
  228. package/src/routes/(inner)/elements/buttons/+page.svelte +304 -0
  229. package/src/routes/(inner)/elements/cards/+page.svelte +117 -0
  230. package/src/routes/(inner)/elements/chips/+page.svelte +130 -0
  231. package/src/routes/(inner)/elements/core/+page.svelte +98 -0
  232. package/src/routes/(inner)/elements/forms/+page.svelte +89 -0
  233. package/src/routes/(inner)/elements/forms/preview/+page.svelte +256 -0
  234. package/src/routes/(inner)/elements/lists/+page.svelte +197 -0
  235. package/src/routes/(inner)/elements/logo-clouds/+page.svelte +105 -0
  236. package/src/routes/(inner)/elements/placeholders/+page.svelte +70 -0
  237. package/src/routes/(inner)/elements/tables/+page.svelte +138 -0
  238. package/src/routes/(inner)/elements/tokens/+page.svelte +176 -0
  239. package/src/routes/(inner)/elements/typography/+page.svelte +100 -0
  240. package/src/routes/(inner)/guides/install/+page.svelte +84 -0
  241. package/src/routes/(inner)/guides/quickstart/+page.svelte +118 -0
  242. package/src/routes/(inner)/guides/styling/+page.svelte +361 -0
  243. package/src/routes/(inner)/guides/tailwind/+page.svelte +150 -0
  244. package/src/routes/(inner)/guides/themes/+page.svelte +144 -0
  245. package/src/routes/(inner)/guides/themes/colors/+page.svelte +87 -0
  246. package/src/routes/(inner)/guides/themes/generator/+page.svelte +58 -0
  247. package/src/routes/(inner)/guides/themes/presets.ts +69 -0
  248. package/src/routes/(inner)/template/+page.svelte +52 -0
  249. package/src/routes/(inner)/utilities/codeblocks/+page.svelte +77 -0
  250. package/src/routes/(inner)/utilities/data-tables/+page.svelte +399 -0
  251. package/src/routes/(inner)/utilities/data-tables/+page.ts +18 -0
  252. package/src/routes/(inner)/utilities/drawers/+page.svelte +193 -0
  253. package/src/routes/(inner)/utilities/lightswitches/+page.svelte +86 -0
  254. package/src/routes/(inner)/utilities/local-storage-stores/+page.svelte +67 -0
  255. package/src/routes/(inner)/utilities/menus/+page.svelte +186 -0
  256. package/src/routes/(inner)/utilities/modals/+page.svelte +391 -0
  257. package/src/routes/(inner)/utilities/toasts/+page.svelte +212 -0
  258. package/src/routes/(inner)/utilities/tooltips/+page.svelte +153 -0
  259. package/src/routes/+error.svelte +16 -0
  260. package/src/routes/+layout.server.ts +13 -0
  261. package/src/routes/+layout.svelte +100 -0
  262. package/src/routes/+page.server.ts +12 -0
  263. package/src/routes/+page.svelte +197 -0
  264. package/src/routes/blog/+page.svelte +78 -0
  265. package/src/routes/blog/+page.ts +6 -0
  266. package/src/routes/blog/[slug]/+page.svelte +112 -0
  267. package/src/routes/blog/[slug]/+page.ts +6 -0
  268. package/src/routes/blog/blog-service.ts +31 -0
  269. package/src/routes/blog/rss/+server.ts +16 -0
  270. package/static/favicon.png +0 -0
  271. package/svelte.config.js +30 -0
  272. package/tailwind.config.cjs +14 -0
  273. package/tsconfig.json +37 -0
  274. package/vite.config.js +25 -0
  275. package/actions/Clipboard/clipboard.d.ts +0 -4
  276. package/actions/Clipboard/clipboard.js +0 -37
  277. package/actions/Filters/filter.d.ts +0 -3
  278. package/actions/Filters/filter.js +0 -23
  279. package/actions/Filters/svg-filters/Apollo.svelte.d.ts +0 -23
  280. package/actions/Filters/svg-filters/BlueNight.svelte.d.ts +0 -23
  281. package/actions/Filters/svg-filters/Emerald.svelte.d.ts +0 -23
  282. package/actions/Filters/svg-filters/GreenFall.svelte.d.ts +0 -23
  283. package/actions/Filters/svg-filters/Noir.svelte.d.ts +0 -23
  284. package/actions/Filters/svg-filters/NoirLight.svelte.d.ts +0 -23
  285. package/actions/Filters/svg-filters/Rustic.svelte.d.ts +0 -23
  286. package/actions/Filters/svg-filters/Summer84.svelte.d.ts +0 -23
  287. package/actions/Filters/svg-filters/XPro.svelte.d.ts +0 -23
  288. package/actions/FocusTrap/focusTrap.d.ts +0 -4
  289. package/actions/FocusTrap/focusTrap.js +0 -53
  290. package/components/Accordion/AccordionGroup.svelte +0 -46
  291. package/components/Accordion/AccordionGroup.svelte.d.ts +0 -24
  292. package/components/Accordion/AccordionItem.svelte +0 -70
  293. package/components/Accordion/AccordionItem.svelte.d.ts +0 -36
  294. package/components/Alert/Alert.svelte +0 -65
  295. package/components/Alert/Alert.svelte.d.ts +0 -30
  296. package/components/AppBar/AppBar.svelte +0 -54
  297. package/components/AppBar/AppBar.svelte.d.ts +0 -30
  298. package/components/AppRail/AppRail.svelte +0 -51
  299. package/components/AppRail/AppRail.svelte.d.ts +0 -32
  300. package/components/AppRail/AppRailTile.svelte +0 -57
  301. package/components/AppRail/AppRailTile.svelte.d.ts +0 -33
  302. package/components/AppShell/AppShell.svelte +0 -80
  303. package/components/AppShell/AppShell.svelte.d.ts +0 -31
  304. package/components/Avatar/Avatar.svelte +0 -46
  305. package/components/Avatar/Avatar.svelte.d.ts +0 -32
  306. package/components/Breadcrumb/Breadcrumb.svelte +0 -24
  307. package/components/Breadcrumb/Breadcrumb.svelte.d.ts +0 -21
  308. package/components/Breadcrumb/Crumb.svelte.d.ts +0 -26
  309. package/components/ConicGradient/ConicGradient.svelte +0 -80
  310. package/components/ConicGradient/ConicGradient.svelte.d.ts +0 -29
  311. package/components/ConicGradient/types.d.ts +0 -10
  312. package/components/ConicGradient/types.js +0 -2
  313. package/components/Divider/Divider.svelte +0 -21
  314. package/components/Divider/Divider.svelte.d.ts +0 -22
  315. package/components/FileButton/FileButton.svelte +0 -25
  316. package/components/FileButton/FileButton.svelte.d.ts +0 -25
  317. package/components/FileDropzone/FileDropzone.svelte +0 -98
  318. package/components/FileDropzone/FileDropzone.svelte.d.ts +0 -32
  319. package/components/GradientHeading/GradientHeading.svelte +0 -21
  320. package/components/GradientHeading/GradientHeading.svelte.d.ts +0 -22
  321. package/components/ListBox/ListBox.svelte +0 -57
  322. package/components/ListBox/ListBox.svelte.d.ts +0 -30
  323. package/components/ListBox/ListBoxItem.svelte +0 -89
  324. package/components/ListBox/ListBoxItem.svelte.d.ts +0 -32
  325. package/components/Paginator/Paginator.svelte +0 -74
  326. package/components/Paginator/Paginator.svelte.d.ts +0 -29
  327. package/components/Paginator/types.d.ts +0 -10
  328. package/components/Paginator/types.js +0 -2
  329. package/components/ProgressBar/ProgressBar.svelte +0 -67
  330. package/components/ProgressBar/ProgressBar.svelte.d.ts +0 -24
  331. package/components/ProgressRadial/ProgressRadial.svelte +0 -89
  332. package/components/ProgressRadial/ProgressRadial.svelte.d.ts +0 -25
  333. package/components/Radio/RadioGroup.svelte +0 -48
  334. package/components/Radio/RadioGroup.svelte.d.ts +0 -31
  335. package/components/Radio/RadioItem.svelte +0 -61
  336. package/components/Radio/RadioItem.svelte.d.ts +0 -33
  337. package/components/RangeSlider/RangeSlider.svelte +0 -101
  338. package/components/RangeSlider/RangeSlider.svelte.d.ts +0 -32
  339. package/components/SlideToggle/SlideToggle.svelte +0 -100
  340. package/components/SlideToggle/SlideToggle.svelte.d.ts +0 -34
  341. package/components/Stepper/Step.svelte +0 -114
  342. package/components/Stepper/Step.svelte.d.ts +0 -34
  343. package/components/Stepper/Stepper.svelte +0 -51
  344. package/components/Stepper/Stepper.svelte.d.ts +0 -30
  345. package/components/SvgIcon/SvgIcon.svelte +0 -45
  346. package/components/SvgIcon/SvgIcon.svelte.d.ts +0 -26
  347. package/components/SvgIcon/icons.d.ts +0 -1
  348. package/components/SvgIcon/icons.js +0 -171
  349. package/components/Tab/Tab.svelte +0 -69
  350. package/components/Tab/Tab.svelte.d.ts +0 -37
  351. package/components/Tab/TabGroup.svelte +0 -69
  352. package/components/Tab/TabGroup.svelte.d.ts +0 -30
  353. package/components/Table/Table.svelte +0 -99
  354. package/components/Table/Table.svelte.d.ts +0 -27
  355. package/components/Table/types.d.ts +0 -10
  356. package/components/Table/types.js +0 -1
  357. package/components/Table/utils.d.ts +0 -7
  358. package/index.js +0 -69
  359. package/styles/elements/chips.css +0 -20
  360. package/styles/tokens/backgrounds.css +0 -329
  361. package/styles/tokens/border-radius.css +0 -41
  362. package/styles/tokens/borders.css +0 -253
  363. package/styles/tokens/fills.css +0 -38
  364. package/styles/tokens/rings.css +0 -253
  365. package/styles/tokens/text.css +0 -293
  366. package/styles/tokens.css +0 -8
  367. package/tailwind/colors.d.ts +0 -13
  368. package/tailwind/colors.js +0 -335
  369. package/tailwind/theme.cjs +0 -39
  370. package/tailwind/theme.d.cts +0 -5
  371. package/utilities/CodeBlock/CodeBlock.svelte +0 -68
  372. package/utilities/CodeBlock/CodeBlock.svelte.d.ts +0 -25
  373. package/utilities/CodeBlock/stores.d.ts +0 -2
  374. package/utilities/CodeBlock/stores.js +0 -3
  375. package/utilities/DataTable/DataTable.d.ts +0 -18
  376. package/utilities/DataTable/DataTable.js +0 -137
  377. package/utilities/DataTable/actions.d.ts +0 -8
  378. package/utilities/DataTable/actions.js +0 -114
  379. package/utilities/DataTable/types.d.ts +0 -33
  380. package/utilities/DataTable/types.js +0 -2
  381. package/utilities/Drawer/Drawer.svelte +0 -157
  382. package/utilities/Drawer/Drawer.svelte.d.ts +0 -33
  383. package/utilities/Drawer/stores.d.ts +0 -10
  384. package/utilities/Drawer/stores.js +0 -21
  385. package/utilities/Drawer/types.d.ts +0 -33
  386. package/utilities/Drawer/types.js +0 -2
  387. package/utilities/LightSwitch/LightSwitch.svelte +0 -75
  388. package/utilities/LightSwitch/LightSwitch.svelte.d.ts +0 -21
  389. package/utilities/LightSwitch/stores.d.ts +0 -3
  390. package/utilities/LightSwitch/stores.js +0 -5
  391. package/utilities/LocalStorageStore/LocalStorageStore.d.ts +0 -12
  392. package/utilities/LocalStorageStore/LocalStorageStore.js +0 -49
  393. package/utilities/Menu/menu.d.ts +0 -18
  394. package/utilities/Menu/menu.js +0 -151
  395. package/utilities/Modal/Modal.svelte +0 -194
  396. package/utilities/Modal/Modal.svelte.d.ts +0 -35
  397. package/utilities/Modal/examples/ModalExampleEmbed.svelte.d.ts +0 -17
  398. package/utilities/Modal/examples/ModalExampleForm.svelte.d.ts +0 -17
  399. package/utilities/Modal/examples/ModalExampleList.svelte.d.ts +0 -17
  400. package/utilities/Modal/stores.d.ts +0 -12
  401. package/utilities/Modal/stores.js +0 -24
  402. package/utilities/Modal/types.d.ts +0 -34
  403. package/utilities/Modal/types.js +0 -2
  404. package/utilities/Toast/Toast.svelte +0 -117
  405. package/utilities/Toast/Toast.svelte.d.ts +0 -28
  406. package/utilities/Toast/stores.d.ts +0 -10
  407. package/utilities/Toast/stores.js +0 -61
  408. package/utilities/Toast/types.d.ts +0 -26
  409. package/utilities/Toast/types.js +0 -2
  410. package/utilities/Tooltip/tooltip.d.ts +0 -35
  411. package/utilities/Tooltip/tooltip.js +0 -94
@@ -0,0 +1,399 @@
1
+ <script lang="ts">
2
+ // HTTP response data provided by +page.ts
3
+ import type { PageData } from './$types';
4
+ export let data: PageData;
5
+ const httpPosts = data.posts;
6
+
7
+ import DocsShell from '$docs/DocsShell/DocsShell.svelte';
8
+ import { DocsFeature, type DocsShellSettings } from '$docs/DocsShell/types';
9
+
10
+ // Components
11
+ import Avatar from '$lib/components/Avatar/Avatar.svelte';
12
+ import Paginator from '$lib/components/Paginator/Paginator.svelte';
13
+ // Utilities
14
+ import { createDataTableStore, dataTableHandler, tableInteraction, tableA11y } from '$lib/utilities/DataTable/DataTable';
15
+ import CodeBlock from '$lib/utilities/CodeBlock/CodeBlock.svelte';
16
+
17
+ // Docs Shell
18
+ const settings: DocsShellSettings = {
19
+ feature: DocsFeature.Utility,
20
+ name: 'Data Tables',
21
+ description: 'A set of utility features for creating template-driven data tables.',
22
+ imports: ['dataTableHandler'],
23
+ types: ['DataTableModel'],
24
+ source: 'utilities/DataTable',
25
+ aria: 'https://www.w3.org/WAI/ARIA/apg/patterns/grid/',
26
+ keyboard: [
27
+ ['<kbd>Right Arrow</kbd>', 'Moves focus one cell to the right. If focus is on the right-most cell in the row, focus does not move.'],
28
+ ['<kbd>Left Arrow</kbd>', 'Moves focus one cell to the left. If focus is on the left-most cell in the row, focus does not move.'],
29
+ ['<kbd>Down Arrow</kbd>', 'Moves focus one cell down. If focus is on the bottom cell in the column, focus does not move.'],
30
+ ['<kbd>Up Arrow</kbd>', 'Moves focus one cell Up. If focus is on the top cell in the column, focus does not move.'],
31
+ ['<kbd>Home</kbd>', 'Moves focus to the first cell in the row that contains focus.'],
32
+ ['<kbd>End</kbd>', ' Moves focus to the last cell in the row that contains focus.']
33
+ // ['<kbd>Enter</kbd> or <kbd>Space</kbd>', 'Triggers the on:click event for the current row.']
34
+ ]
35
+ };
36
+ const post = httpPosts.pop()!;
37
+
38
+ // Store
39
+ const dataTableStore = createDataTableStore(httpPosts, {
40
+ sort: '',
41
+ search: '',
42
+ pagination: { offset: 0, limit: 5, size: 0, amounts: [1, 2, 5, 10] }
43
+ });
44
+ dataTableStore.subscribe((model) => dataTableHandler(model));
45
+
46
+ // Manual Selection
47
+ dataTableStore.select('id', [1]);
48
+
49
+ // Update the source data
50
+ httpPosts.push(post);
51
+ dataTableStore.updateSource(httpPosts);
52
+ </script>
53
+
54
+ <DocsShell {settings}>
55
+ <!-- Slot: Sandbox -->
56
+ <svelte:fragment slot="sandbox">
57
+ <!-- Alert -->
58
+ <aside class="alert alert-error">
59
+ <i class="fa-solid fa-triangle-exclamation text-4xl animate-pulse" />
60
+ <div class="alert-message">
61
+ <h3>Experimental Feature</h3>
62
+ <p>
63
+ This feature currently available as in early access. It is not feature complete, may contain bugs, and is not ready for production
64
+ use. We've provided an alternative and linked the GitHub ticket if you wish to track the progress of this feature.
65
+ </p>
66
+ </div>
67
+ <div class="alert-message">
68
+ <a href="https://github.com/skeletonlabs/skeleton/issues/538" target="_blank" rel="noreferrer" class="btn btn-ghost w-full">
69
+ Track Progress
70
+ </a>
71
+ <a href="https://svelte-headless-table.bryanmylee.com/" target="_blank" rel="noreferrer" class="btn btn-filled w-full">
72
+ View Alternative
73
+ </a>
74
+ </div>
75
+ </aside>
76
+
77
+ <section class="card !bg-secondary-500/5">
78
+ <!-- Search Input -->
79
+ <div class="card-header">
80
+ <input bind:value={$dataTableStore.search} type="search" placeholder="Search Table..." />
81
+ </div>
82
+ <!-- Table -->
83
+ <div class="p-4">
84
+ <div class="table-container">
85
+ <!-- prettier-ignore -->
86
+ <table class="table table-hover" role="grid" use:tableInteraction use:tableA11y>
87
+ <thead on:click={(e) => { dataTableStore.sort(e) }} on:keypress>
88
+ <tr>
89
+ <th><input type="checkbox" on:click={(e) => { dataTableStore.selectAll(e.currentTarget.checked) }} /></th>
90
+ <th data-sort="id">ID</th>
91
+ <th>User</th>
92
+ <th data-sort="title">Title</th>
93
+ <th data-sort="body">Body</th>
94
+ <th class="table-cell-fit"></th>
95
+ </tr>
96
+ </thead>
97
+ <tbody>
98
+ {#each $dataTableStore.filtered as row, rowIndex}
99
+ <tr class:table-row-checked={row.dataTableChecked} aria-rowindex={rowIndex + 1}>
100
+ <td role="gridcell" aria-colindex={1} tabindex="0">
101
+ <input type="checkbox" bind:checked={row.dataTableChecked} />
102
+ </td>
103
+ <td role="gridcell" aria-colindex={2} tabindex="0">
104
+ <em class="opacity-50">{row.id}</em>
105
+ </td>
106
+ <td role="gridcell" aria-colindex={3} tabindex="0">
107
+ <Avatar src={`https://i.pravatar.cc/?img=${row.id}`} width="w-8" />
108
+ </td>
109
+ <td role="gridcell" aria-colindex={4} tabindex="0" class="md:!whitespace-normal capitalize">
110
+ {row.title}
111
+ </td>
112
+ <td role="gridcell" aria-colindex={5} tabindex="0" class="md:!whitespace-normal">
113
+ {row.body}
114
+ </td>
115
+ <td role="gridcell" aria-colindex={6} tabindex="0" class="table-cell-fit">
116
+ <button class="btn btn-ghost-surface btn-sm" on:click={()=>{console.log(row,rowIndex)}}>Console Log</button>
117
+ </td>
118
+ </tr>
119
+ {/each}
120
+ </tbody>
121
+ </table>
122
+ </div>
123
+ </div>
124
+ <div class="card-footer">
125
+ <Paginator bind:settings={$dataTableStore.pagination} />
126
+ </div>
127
+ </section>
128
+ <!-- Debugging -->
129
+ <!-- <pre>{JSON.stringify($dataTableStore, null, 2)}</pre> -->
130
+ </svelte:fragment>
131
+
132
+ <!-- Slot: Usage -->
133
+ <svelte:fragment slot="usage">
134
+ <!-- Intro -->
135
+ <section class="space-y-4">
136
+ <h2>What are Data Tables?</h2>
137
+ <p>
138
+ Within the context of Skeleton, data tables are not a singular feature, but rather a collection of utilities. These utilty features
139
+ are opt-in, meaning you can progressively enhance any native HTML table to meet your requirements. This is one of the most complex
140
+ features Skeleton provides, so please read carefully.
141
+ </p>
142
+ </section>
143
+
144
+ <hr />
145
+ <!-- Getting Started -->
146
+ <section class="space-y-4">
147
+ <h2>Getting Started</h2>
148
+ <p>Let's start by importing all the utility features we'll need. We'll cover each of these in greater detail below.</p>
149
+ <CodeBlock
150
+ language="ts"
151
+ code={`
152
+ import {
153
+ // Utilities
154
+ createDataTableStore,
155
+ dataTableHandler,
156
+ // Svelte Actions
157
+ tableInteraction,
158
+ tableA11y
159
+ } from '@skeletonlabs/skeleton';`}
160
+ />
161
+ <!-- prettier-ignore -->
162
+ <p>
163
+ We need data to populate the table. For simplicity, let's create this locally. In a real world app you might fetch this from an
164
+ external API. We demonstrate this in the <a href="https://github.com/skeletonlabs/skeleton/blob/master/src/routes/(inner)/utilities/data-tables/%2Bpage.svelte" target="_blank" rel="noreferrer">example on this page</a>. See the use of <code>PageData</code> in the source.
165
+ </p>
166
+ <CodeBlock
167
+ language="ts"
168
+ code={`
169
+ const sourceData = [
170
+ { position: 1, name: 'Hydrogen', weight: 1.0079, symbol: 'H' },
171
+ { position: 2, name: 'Helium', weight: 4.0026, symbol: 'He' },
172
+ { position: 3, name: 'Lithium', weight: 6.941, symbol: 'Li' },
173
+ { position: 4, name: 'Beryllium', weight: 9.0122, symbol: 'Be' },
174
+ { position: 5, name: 'Boron', weight: 10.811, symbol: 'B' },
175
+ { position: 6, name: 'Carbon', weight: 12.0107, symbol: 'C' },
176
+ { position: 7, name: 'Nitrogen', weight: 14.0067, symbol: 'N' },
177
+ { position: 8, name: 'Oxygen', weight: 15.9994, symbol: 'O' },
178
+ { position: 9, name: 'Fluorine', weight: 18.9984, symbol: 'F' },
179
+ { position: 10, name: 'Neon', weight: 20.1797, symbol: 'Ne' }
180
+ ];`}
181
+ />
182
+ <p>
183
+ We'll make use of Skeleton's <a href="/elements/tables">table element classes</a> to provide base styles to our native HTML table element.
184
+ These are optional, but recommended.
185
+ </p>
186
+ <CodeBlock
187
+ language="html"
188
+ code={`
189
+ <div class="table-container">
190
+ <table class="table table-hover">
191
+ <thead>
192
+ <tr>
193
+ <th>Heading 1</th>
194
+ </tr>
195
+ </thead>
196
+ <tbody>
197
+ <tr>
198
+ <td>Cell 1</td>
199
+ </tr>
200
+ </tbody>
201
+ </table>
202
+ </div>`}
203
+ />
204
+ </section>
205
+ <section class="space-y-4">
206
+ <h2>Data Table Model</h2>
207
+ <p>
208
+ To unlock the power of our data tables, we'll need to create what we'll refer to as a <em>data table model</em>. Create a new Svelte
209
+ writable store with <code>createDataTableStore</code>, then pass the model of our store to the <code>dataTableHandler</code> method.
210
+ </p>
211
+ <CodeBlock
212
+ language="ts"
213
+ code={`
214
+ const dataTableStore = createDataTableStore(
215
+ // Pass your source data here:
216
+ sourceData,
217
+ // Provide optional settings:
218
+ {
219
+ // The current search term.
220
+ search: '',
221
+ // The current sort key.
222
+ sort: '',
223
+ // Paginator component settings.
224
+ pagination: { offset: 0, limit: 5, size: 0, amounts: [1, 2, 5, 10] }
225
+ }
226
+ );\n
227
+ // This automatically handles search, sort, etc when the model updates.
228
+ dataTableStore.subscribe((model) => dataTableHandler(model));`}
229
+ />
230
+ <p>
231
+ Next, we'll update our table markup to display our model data. Implement matching parent headings and body cells. We'll use an <code
232
+ >#each</code
233
+ >
234
+ loop to generate each table row. Note we use <code>$dataTableStore.filtered</code>
235
+ as our loop source. This represents the data as modified by search, sort, pagination, and more.
236
+ </p>
237
+ <CodeBlock
238
+ language="ts"
239
+ code={`
240
+ <thead>
241
+ <tr>
242
+ <th>Position</th>
243
+ <th>Name</th>
244
+ <!-- ... --->
245
+ </tr>
246
+ </thead>
247
+ <tbody>
248
+ {#each $dataTableStore.filtered as row, rowIndex}
249
+ <tr>
250
+ <td>{row.position}</td>
251
+ <td>{row.name}</td>
252
+ <!-- ... --->
253
+ </tr>
254
+ {/each}
255
+ </tbody>`}
256
+ />
257
+ </section>
258
+ <hr />
259
+ <!-- Updating Source -->
260
+ <section class="space-y-4">
261
+ <h2>Updating the Source</h2>
262
+ <p>
263
+ To update the content of the data table, just call the <code>dataTableStore.updateSource()</code> method and pass in your new source
264
+ data.
265
+ </p>
266
+ <CodeBlock language="ts" code={`dataTableStore.updateSource(newSourceData)`} />
267
+ </section>
268
+ <!-- Search -->
269
+ <section class="space-y-4">
270
+ <h2>Search</h2>
271
+ <p>
272
+ To implement search, bind <code>$dataTableStore.search</code> to any search input. You may add this anywhere as long as it has scope
273
+ of your table model (the store).
274
+ </p>
275
+ <CodeBlock language="html" code={`<input bind:value={$dataTableStore.search} type="search" placeholder="Search..." />`} />
276
+ </section>
277
+ <!-- Sort -->
278
+ <section class="space-y-4">
279
+ <h2>Sort</h2>
280
+ <p>
281
+ We'll use the <code>dataTableStore.sort()</code> method to automatically set <code>$dataTableStore.sort</code> when a table heading
282
+ is tapped. Add the following click method once to your table's <code>thead</code> element.
283
+ </p>
284
+ <CodeBlock language="html" code={`<thead on:click={(e) => { dataTableStore.sort(e) }} on:keypress>`} />
285
+ <p>
286
+ Add a <code>data-sort="(key)"</code> attribute to each heading you wish to be sortable. Tapping a heading will set the
287
+ <code>$dataTableStore.sort</code>
288
+ value and update the UI. Tapping a heading repeatedly will toggle between <em>ascending</em> and <em>descending</em> sort order.
289
+ </p>
290
+ <CodeBlock
291
+ language="html"
292
+ code={`
293
+ <th data-sort="position">Position</th>
294
+ <th data-sort="name">Name</th>
295
+ <!-- ... -->
296
+ `}
297
+ />
298
+ <p>
299
+ While sort is working, there's currently no visual UI indicator. To handle this, implement the Svelte Action called <code
300
+ >tableInteraction</code
301
+ >
302
+ to your table element. This will toggle the appropriate CSS classes and show &uarr and &darr; sort arrows.
303
+ </p>
304
+ <CodeBlock language="html" code={`<table ... use:tableInteraction>`} />
305
+ </section>
306
+ <!-- Selection -->
307
+ <section class="space-y-4">
308
+ <h2>Selection</h2>
309
+ <h3>Per Row</h3>
310
+ <p>To handle row selection, we'll add a new heading column. Keep the comment shown, as we'll replace it in a following step.</p>
311
+ <CodeBlock language="html" code={`<th><!-- selection --></th>`} />
312
+ <p>
313
+ Pair this with a matching table body cell that includes a checkbox input. Append <code>bind:checked</code> to the input to extend
314
+ the row object source data. When checked on/off, the <code>dataTableHandler</code> will automatically include/exclude the entire row
315
+ object in
316
+ <code>$dataTableStore.selection</code>.
317
+ </p>
318
+ <CodeBlock language="html" code={`<td><input type="checkbox" bind:checked={row.dataTableChecked} /></td>`} />
319
+ <p>
320
+ If you wish to visually highlight the row selection, Tailwind Elements includes a semantic class for this. Append this to your table
321
+ body row element.
322
+ </p>
323
+ <CodeBlock language="html" code={`<tr class:table-row-checked={row.dataTableChecked}>`} />
324
+ <h3>Pre-Selected</h3>
325
+ <p>
326
+ You may wish to pre-select certain table rows. We've provided a utility method to handle this. Pass in the key to query against, and
327
+ a whitelist of values. Any object that matches the conditions will be selected. Trigger this multiple times for multiple selection
328
+ queries.
329
+ </p>
330
+ <CodeBlock
331
+ language="ts"
332
+ code={`// Selects all objects with a position value of 1 or 2:\ndataTableStore.select('position', [1,2]);`}
333
+ />
334
+ <h3>Select All</h3>
335
+ <p>
336
+ If you wish to add a <em>select all</em> feature, replace <code>{`<th><!-- selection --></th>`}</code> with the following.
337
+ </p>
338
+ <CodeBlock
339
+ language="html"
340
+ code={`<th><input type="checkbox" on:click={(e) => { dataTableStore.selectAll(e.currentTarget.checked) }} /></th>`}
341
+ />
342
+ </section>
343
+ <!-- Pagination -->
344
+ <section class="space-y-4">
345
+ <h2>Pagination</h2>
346
+ <p>
347
+ Please refer to the <a href="/components/paginators">Paginators component</a> to learn more about this feature. For data tables, use
348
+ <code>$dataTableStore.pagination</code> to ensures the model updates reactively. The wrapping <em>if</em> statement is required.
349
+ </p>
350
+ <CodeBlock language="html" code={`{#if $dataTableStore.pagination}<Paginator bind:settings={$dataTableStore.pagination} />{/if}`} />
351
+ </section>
352
+ <!-- A11y -->
353
+ <section class="space-y-4">
354
+ <h2>Accessibility</h2>
355
+ <p>
356
+ Since data tables make use of native HTML table elements, you will need to implement accessibility features directly. However, we've
357
+ simplified this by providing a Svelte Action called <code>tableA11y</code>. This implements the required event listeners for
358
+ keyboard interaction. Start by appending <em>role</em> and <em>action</em> to your <em>table</em> element.
359
+ </p>
360
+ <CodeBlock language="html" code={`<table ... role="grid" use:tableA11y>`} />
361
+ <p>
362
+ Implement the <code>aria-rowindex</code> attribute. This starts at <strong>1</strong> and increments per <em>tr</em> row. We can
363
+ utilize the <em>#each</em> loop index value, named <code>rowIndex</code>.
364
+ </p>
365
+ <CodeBlock language="html" code={`<tr ... aria-rowindex={rowIndex + 1}>`} />
366
+ <p>
367
+ Implement three attributes per table body <em>td</em> cell. <code>role</code> and <code>tabindex</code> are static, while
368
+ <code>aria-colindex</code>
369
+ starts at <strong>1</strong> and increments per cell.
370
+ </p>
371
+ <CodeBlock
372
+ language="html"
373
+ code={`
374
+ <td ... role="gridcell" aria-colindex={1} tabindex="0">...</td>
375
+ <td ... role="gridcell" aria-colindex={2} tabindex="0">...</td>
376
+ <!-- ... -->`}
377
+ />
378
+ <p>Reference the <em>Keyboard</em> tab section at the top of this page for a list of available keyboard interactions.</p>
379
+ </section>
380
+ <hr />
381
+ <!-- Reference -->
382
+ <section class="space-y-4">
383
+ <h2>View Reference</h2>
384
+ <p>
385
+ If you wish to see a complete data table, we recommend tapping the <em>Doc Source</em> link at the top of this page. This will allow
386
+ you to inspect how the featured example at the top of this page was constructed. This implements every available data table feature.
387
+ </p>
388
+ </section>
389
+ <hr />
390
+ <!-- Simple Table Callout -->
391
+ <section class="grid grid-cols-[1fr_auto] gap-4">
392
+ <div class="space-y-4">
393
+ <h2>Table Components</h2>
394
+ <p>Looking for a simpler data-driven table component? Visit the Table documentation.</p>
395
+ </div>
396
+ <a class="btn btn-filled-secondary place-self-center" href="/components/tables">View Tables</a>
397
+ </section>
398
+ </svelte:fragment>
399
+ </DocsShell>
@@ -0,0 +1,18 @@
1
+ import type { PageLoad } from './$types';
2
+
3
+ export const load: PageLoad = async ({ fetch }) => {
4
+ const getPlaceholderPosts = async () => {
5
+ const res = await fetch('https://jsonplaceholder.typicode.com/user/1/posts');
6
+ if (!res.ok) throw new Error('failed to fetch posts: ' + res.body); // ? needs to be a message
7
+ const body = (await res.json()) as Post[];
8
+ return body;
9
+ };
10
+ return { posts: getPlaceholderPosts() };
11
+ };
12
+
13
+ type Post = {
14
+ id: number;
15
+ title: string;
16
+ body: string;
17
+ userId: number;
18
+ };
@@ -0,0 +1,193 @@
1
+ <script lang="ts">
2
+ import DocsShell from '$docs/DocsShell/DocsShell.svelte';
3
+ import { DocsFeature, type DocsShellSettings } from '$docs/DocsShell/types';
4
+
5
+ import CodeBlock from '$lib/utilities/CodeBlock/CodeBlock.svelte';
6
+
7
+ // @ts-expect-error sveld import
8
+ import sveldDrawer from '$lib/utilities/Drawer/Drawer.svelte?raw&sveld';
9
+
10
+ // Drawer Utils
11
+ import { drawerStore } from '$lib/utilities/Drawer/stores';
12
+ import type { DrawerSettings } from '$lib/utilities/Drawer/types';
13
+
14
+ // Docs Shell
15
+ const settings: DocsShellSettings = {
16
+ feature: DocsFeature.Utility,
17
+ name: 'Drawers',
18
+ description: 'Displays an overlay panel that attaches to any side of the screen.',
19
+ imports: ['Drawer', 'drawerStore'],
20
+ types: ['DrawerSettings'],
21
+ source: 'utilities/Drawer',
22
+ aria: 'https://www.w3.org/WAI/ARIA/apg/patterns/dialogmodal/',
23
+ components: [{ sveld: sveldDrawer }],
24
+ keyboard: [['<kbd>Esc</kbd>', ' Closes the drawer.']]
25
+ };
26
+
27
+ function trigger(position: 'left' | 'top' | 'right' | 'bottom'): void {
28
+ const s: DrawerSettings = { id: 'demo', position };
29
+ drawerStore.open(s);
30
+ }
31
+ function triggerStyled(): void {
32
+ const s: DrawerSettings = {
33
+ id: 'demo',
34
+ position: 'left',
35
+ bgDrawer: 'bg-primary-500 text-on-primary-token',
36
+ bgBackdrop: 'bg-primary-500/50',
37
+ meta: 'Styled Drawer'
38
+ };
39
+ drawerStore.open(s);
40
+ }
41
+ </script>
42
+
43
+ <DocsShell {settings}>
44
+ <!-- Slot: Sandbox -->
45
+ <svelte:fragment slot="sandbox">
46
+ <div class="card p-4 text-center space-y-4">
47
+ <p>Select a drawer to preview.</p>
48
+ <!-- prettier-ignore -->
49
+ <div class="flex justify-center items-center space-x-2 sm:space-x-4">
50
+ <button class="btn-icon btn-ghost-surface" on:click={() => { trigger('right'); }}>
51
+ <i class="fa-solid fa-arrow-left"></i>
52
+ </button>
53
+ <button class="btn-icon btn-ghost-surface" on:click={() => { trigger('left'); }}>
54
+ <i class="fa-solid fa-arrow-right"></i>
55
+ </button>
56
+ <button class="btn-icon btn-ghost-surface" on:click={() => { trigger('bottom'); }}>
57
+ <i class="fa-solid fa-arrow-up"></i>
58
+ </button>
59
+ <button class="btn-icon btn-ghost-surface" on:click={() => { trigger('top'); }}>
60
+ <i class="fa-solid fa-arrow-down"></i>
61
+ </button>
62
+ <button class="btn btn-ghost-surface" on:click={() => { triggerStyled(); }}>Styled</button>
63
+ </div>
64
+ </div>
65
+ </svelte:fragment>
66
+
67
+ <!-- Slot: Usage -->
68
+ <svelte:fragment slot="usage">
69
+ <section class="space-y-4">
70
+ <p>
71
+ Import and add a single instance of the Drawer component in your app's root layout. Since this is in global scope it will be
72
+ possible to reuse this feature throughout your entire application.
73
+ </p>
74
+ <CodeBlock language="html" code={`<Drawer />`} />
75
+ </section>
76
+ <section class="space-y-4">
77
+ <h2>Drawer Store</h2>
78
+ <p>This contains the drawer's current state and settings.</p>
79
+ <CodeBlock language="typescript" code={`import { drawerStore } from '@skeletonlabs/skeleton';`} />
80
+ <h3>Open</h3>
81
+ <p>To open the drawer, use the store's <code>open()</code> method to show the drawer.</p>
82
+ <CodeBlock
83
+ language="typescript"
84
+ code={`
85
+ function drawerOpen(): void {
86
+ drawerStore.open();
87
+ }
88
+ `}
89
+ />
90
+ <h3>Close</h3>
91
+ <p>To close the drawer, use the store's <code>close()</code> method to hide the drawer.</p>
92
+ <CodeBlock
93
+ language="typescript"
94
+ code={`
95
+ function drawerClose(): void {
96
+ drawerStore.close();
97
+ }
98
+ `}
99
+ />
100
+ <h3>Handling Contents</h3>
101
+ <p>If you wish to swap out the contents of your drawer, set a unique <code>id</code> per drawer instance.</p>
102
+ <CodeBlock
103
+ language="typescript"
104
+ code={`
105
+ function drawerOpen(): void {
106
+ const settings: DrawerSettings = { id: 'example-1' };
107
+ drawerStore.open(settings);
108
+ }
109
+ `}
110
+ />
111
+ <!-- prettier-ignore -->
112
+ <p>Then, conditionally update your drawer's default slot content via <code>$drawerStore.id</code>. We <a href="https://github.com/skeletonlabs/skeleton/blob/master/src/docs/DocsNavigation/DocsDrawer.svelte" target="_blank" rel="noreferrer">use this technique</a> for the Skeleton documentation site.</p>
113
+ <CodeBlock
114
+ language="html"
115
+ code={`
116
+ <Drawer>
117
+ {#if $drawerStore.id === 'example-1'}
118
+ <p>(show 'example-1' contents)</p>
119
+ {:else if $drawerStore.id === 'example-2'}
120
+ <p>(show 'example-2' contents)</p>
121
+ {:else}
122
+ <p>(fallback contents)</p>
123
+ {/if}
124
+ </Drawer>
125
+ `}
126
+ />
127
+ <p>
128
+ If you need to pass custom abitrary metadata use the <code>meta</code> key. Use <code>$drawerStore.meta</code> to retreive this.
129
+ </p>
130
+ <CodeBlock
131
+ language="typescript"
132
+ code={`
133
+ function drawerOpen(): void {
134
+ const settings: DrawerSettings = {
135
+ id: 'example-2',
136
+ meta: { foo: 'bar', fizz: 'buzz', age: 40 }
137
+ };
138
+ drawerStore.open(settings);
139
+ }
140
+ `}
141
+ />
142
+ </section>
143
+ <section class="space-y-4">
144
+ <h2>Styling</h2>
145
+ <p>
146
+ In most cases we recommend setting default styles via the Drawer component props. However, you may override prop values per drawer
147
+ instance by passing a key/value pair as shown below. See the <em>Props</em> tab near the top of this page for a full list of available
148
+ options.
149
+ </p>
150
+ <CodeBlock
151
+ language="typescript"
152
+ code={`
153
+ function drawerOpenStyled(): void {
154
+ const settings: DrawerSettings = {
155
+ id: 'demo',
156
+ // Provide your prop overrides
157
+ position: 'right',
158
+ bgDrawer: 'bg-primary-500 text-on-primary-token',
159
+ bgBackdrop: 'bg-primary-500/50',
160
+ };
161
+ drawerStore.open(settings);
162
+ }
163
+ `}
164
+ />
165
+ </section>
166
+ <section class="space-y-4">
167
+ <h2>SvelteKit SSR Warning</h2>
168
+ <p>
169
+ Be aware that there are <a
170
+ href="https://github.com/sveltejs/kit/discussions/4339#discussioncomment-2384978"
171
+ target="_blank"
172
+ rel="noreferrer">known issues when using Svelte stores with SSR</a
173
+ >, such as our drawer store. To prevent these issues please avoid the use of the drawer store within any SvelteKit Load function.
174
+ Likewise, if you need a drawer to open on route initilization we advise triggering the <code>open()</code> method after the
175
+ <a href="https://kit.svelte.dev/docs/modules#$app-environment" target="_blank" rel="noreferrer"
176
+ >SvelteKit Browser environment context</a
177
+ > is available.
178
+ </p>
179
+ <CodeBlock
180
+ language="typescript"
181
+ code={`
182
+ import { browser } from '$app/environment';\n
183
+ if (browser) drawerStore.open(settings);
184
+ `}
185
+ />
186
+ <p>
187
+ For additional context please see this <a href="https://github.com/skeletonlabs/skeleton/pull/580" target="_blank" rel="noreferrer"
188
+ >thread</a
189
+ >.
190
+ </p>
191
+ </section>
192
+ </svelte:fragment>
193
+ </DocsShell>