@skeletonlabs/skeleton 0.92.1 → 0.92.2

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 (416) hide show
  1. package/actions/Clipboard/clipboard.d.ts +4 -0
  2. package/actions/Clipboard/clipboard.js +37 -0
  3. package/actions/Filters/filter.d.ts +3 -0
  4. package/actions/Filters/filter.js +23 -0
  5. package/{src/lib/actions → actions}/Filters/svg-filters/Apollo.svelte +0 -0
  6. package/actions/Filters/svg-filters/Apollo.svelte.d.ts +23 -0
  7. package/{src/lib/actions → actions}/Filters/svg-filters/BlueNight.svelte +0 -0
  8. package/actions/Filters/svg-filters/BlueNight.svelte.d.ts +23 -0
  9. package/{src/lib/actions → actions}/Filters/svg-filters/Emerald.svelte +0 -0
  10. package/actions/Filters/svg-filters/Emerald.svelte.d.ts +23 -0
  11. package/{src/lib/actions → actions}/Filters/svg-filters/GreenFall.svelte +0 -0
  12. package/actions/Filters/svg-filters/GreenFall.svelte.d.ts +23 -0
  13. package/{src/lib/actions → actions}/Filters/svg-filters/Noir.svelte +0 -0
  14. package/actions/Filters/svg-filters/Noir.svelte.d.ts +23 -0
  15. package/{src/lib/actions → actions}/Filters/svg-filters/NoirLight.svelte +0 -0
  16. package/actions/Filters/svg-filters/NoirLight.svelte.d.ts +23 -0
  17. package/{src/lib/actions → actions}/Filters/svg-filters/Rustic.svelte +0 -0
  18. package/actions/Filters/svg-filters/Rustic.svelte.d.ts +23 -0
  19. package/{src/lib/actions → actions}/Filters/svg-filters/Summer84.svelte +0 -0
  20. package/actions/Filters/svg-filters/Summer84.svelte.d.ts +23 -0
  21. package/{src/lib/actions → actions}/Filters/svg-filters/XPro.svelte +0 -0
  22. package/actions/Filters/svg-filters/XPro.svelte.d.ts +23 -0
  23. package/actions/FocusTrap/focusTrap.d.ts +4 -0
  24. package/actions/FocusTrap/focusTrap.js +53 -0
  25. package/components/Accordion/AccordionGroup.svelte +46 -0
  26. package/components/Accordion/AccordionGroup.svelte.d.ts +24 -0
  27. package/components/Accordion/AccordionItem.svelte +73 -0
  28. package/components/Accordion/AccordionItem.svelte.d.ts +36 -0
  29. package/components/Alert/Alert.svelte +65 -0
  30. package/components/Alert/Alert.svelte.d.ts +30 -0
  31. package/components/AppBar/AppBar.svelte +54 -0
  32. package/components/AppBar/AppBar.svelte.d.ts +30 -0
  33. package/components/AppRail/AppRail.svelte +51 -0
  34. package/components/AppRail/AppRail.svelte.d.ts +32 -0
  35. package/components/AppRail/AppRailTile.svelte +57 -0
  36. package/components/AppRail/AppRailTile.svelte.d.ts +33 -0
  37. package/components/AppShell/AppShell.svelte +80 -0
  38. package/components/AppShell/AppShell.svelte.d.ts +31 -0
  39. package/components/Avatar/Avatar.svelte +46 -0
  40. package/components/Avatar/Avatar.svelte.d.ts +32 -0
  41. package/components/Breadcrumb/Breadcrumb.svelte +24 -0
  42. package/components/Breadcrumb/Breadcrumb.svelte.d.ts +21 -0
  43. package/{src/lib/components → components}/Breadcrumb/Crumb.svelte +16 -23
  44. package/components/Breadcrumb/Crumb.svelte.d.ts +26 -0
  45. package/components/ConicGradient/ConicGradient.svelte +80 -0
  46. package/components/ConicGradient/ConicGradient.svelte.d.ts +29 -0
  47. package/components/ConicGradient/settings.d.ts +13 -0
  48. package/components/ConicGradient/settings.js +335 -0
  49. package/components/ConicGradient/types.d.ts +10 -0
  50. package/components/ConicGradient/types.js +2 -0
  51. package/components/Divider/Divider.svelte +21 -0
  52. package/components/Divider/Divider.svelte.d.ts +22 -0
  53. package/components/FileButton/FileButton.svelte +25 -0
  54. package/components/FileButton/FileButton.svelte.d.ts +25 -0
  55. package/components/FileDropzone/FileDropzone.svelte +95 -0
  56. package/components/FileDropzone/FileDropzone.svelte.d.ts +32 -0
  57. package/components/GradientHeading/GradientHeading.svelte +21 -0
  58. package/components/GradientHeading/GradientHeading.svelte.d.ts +22 -0
  59. package/components/InputChip/InputChip.svelte +107 -0
  60. package/components/InputChip/InputChip.svelte.d.ts +29 -0
  61. package/components/ListBox/ListBox.svelte +57 -0
  62. package/components/ListBox/ListBox.svelte.d.ts +30 -0
  63. package/components/ListBox/ListBoxItem.svelte +88 -0
  64. package/components/ListBox/ListBoxItem.svelte.d.ts +32 -0
  65. package/components/Paginator/Paginator.svelte +74 -0
  66. package/components/Paginator/Paginator.svelte.d.ts +29 -0
  67. package/components/Paginator/types.d.ts +10 -0
  68. package/components/Paginator/types.js +2 -0
  69. package/components/ProgressBar/ProgressBar.svelte +67 -0
  70. package/components/ProgressBar/ProgressBar.svelte.d.ts +24 -0
  71. package/components/ProgressRadial/ProgressRadial.svelte +89 -0
  72. package/components/ProgressRadial/ProgressRadial.svelte.d.ts +25 -0
  73. package/components/Radio/RadioGroup.svelte +48 -0
  74. package/components/Radio/RadioGroup.svelte.d.ts +31 -0
  75. package/components/Radio/RadioItem.svelte +61 -0
  76. package/components/Radio/RadioItem.svelte.d.ts +33 -0
  77. package/components/RangeSlider/RangeSlider.svelte +101 -0
  78. package/components/RangeSlider/RangeSlider.svelte.d.ts +32 -0
  79. package/components/SlideToggle/SlideToggle.svelte +100 -0
  80. package/components/SlideToggle/SlideToggle.svelte.d.ts +34 -0
  81. package/components/Stepper/Step.svelte +133 -0
  82. package/components/Stepper/Step.svelte.d.ts +39 -0
  83. package/components/Stepper/Stepper.svelte +64 -0
  84. package/components/Stepper/Stepper.svelte.d.ts +32 -0
  85. package/components/SvgIcon/SvgIcon.svelte +45 -0
  86. package/components/SvgIcon/SvgIcon.svelte.d.ts +26 -0
  87. package/components/SvgIcon/icons.d.ts +1 -0
  88. package/components/SvgIcon/icons.js +25 -0
  89. package/components/Tab/Tab.svelte +69 -0
  90. package/components/Tab/Tab.svelte.d.ts +37 -0
  91. package/components/Tab/TabGroup.svelte +69 -0
  92. package/components/Tab/TabGroup.svelte.d.ts +30 -0
  93. package/components/Table/Table.svelte +99 -0
  94. package/components/Table/Table.svelte.d.ts +27 -0
  95. package/components/Table/types.d.ts +10 -0
  96. package/components/Table/types.js +1 -0
  97. package/components/Table/utils.d.ts +7 -0
  98. package/{src/lib/components/Table/utils.ts → components/Table/utils.js} +10 -16
  99. package/components/TableOfContents/TableOfContents.svelte +132 -0
  100. package/components/TableOfContents/TableOfContents.svelte.d.ts +32 -0
  101. package/{src/lib/index.ts → index.d.ts} +1 -31
  102. package/index.js +71 -0
  103. package/package.json +158 -61
  104. package/{src/lib/styles → styles}/all.css +0 -0
  105. package/{src/lib/styles → styles}/core.css +0 -0
  106. package/{src/lib/styles → styles}/elements/alerts.css +0 -0
  107. package/{src/lib/styles → styles}/elements/badges.css +0 -0
  108. package/{src/lib/styles → styles}/elements/breadcrumbs.css +0 -0
  109. package/{src/lib/styles → styles}/elements/buttons.css +0 -0
  110. package/{src/lib/styles → styles}/elements/cards.css +0 -0
  111. package/{src/lib/styles → styles}/elements/chips.css +0 -0
  112. package/{src/lib/styles → styles}/elements/lists.css +0 -0
  113. package/{src/lib/styles → styles}/elements/logo-clouds.css +0 -0
  114. package/{src/lib/styles → styles}/elements/menus.css +0 -0
  115. package/{src/lib/styles → styles}/elements/placeholders.css +0 -0
  116. package/{src/lib/styles → styles}/elements/tables.css +0 -0
  117. package/{src/lib/styles → styles}/elements/tooltips.css +0 -0
  118. package/{src/lib/styles → styles}/elements.css +0 -0
  119. package/{src/lib/styles → styles}/forms.css +0 -0
  120. package/{src/lib/styles → styles}/highlight-js.css +0 -0
  121. package/{src/lib/styles → styles}/tailwind.css +0 -0
  122. package/{src/lib/styles → styles}/typography.css +0 -0
  123. package/tailwind/generated/allComponents.cjs +1 -0
  124. package/tailwind/generated/allComponents.d.cts +2156 -0
  125. package/{src/lib/tailwind → tailwind}/settings.cjs +0 -0
  126. package/tailwind/settings.d.cts +6 -0
  127. package/{src/lib/tailwind → tailwind}/skeleton.cjs +0 -0
  128. package/tailwind/skeleton.d.cts +5 -0
  129. package/{src/lib/tailwind → tailwind}/theme/colors.cjs +0 -0
  130. package/tailwind/theme/colors.d.cts +2 -0
  131. package/{src/lib/tailwind → tailwind}/tokens/backgrounds.cjs +0 -0
  132. package/tailwind/tokens/backgrounds.d.cts +2 -0
  133. package/{src/lib/tailwind → tailwind}/tokens/border-radius.cjs +0 -0
  134. package/tailwind/tokens/border-radius.d.cts +33 -0
  135. package/{src/lib/tailwind → tailwind}/tokens/borders.cjs +0 -0
  136. package/tailwind/tokens/borders.d.cts +6 -0
  137. package/{src/lib/tailwind → tailwind}/tokens/fills.cjs +0 -0
  138. package/tailwind/tokens/fills.d.cts +15 -0
  139. package/{src/lib/tailwind → tailwind}/tokens/rings.cjs +0 -0
  140. package/tailwind/tokens/rings.d.cts +17 -0
  141. package/{src/lib/tailwind → tailwind}/tokens/text.cjs +0 -0
  142. package/tailwind/tokens/text.d.cts +21 -0
  143. package/{src/lib/themes → themes}/theme-crimson.css +0 -0
  144. package/{src/lib/themes → themes}/theme-gold-nouveau.css +0 -0
  145. package/{src/lib/themes → themes}/theme-hamlindigo.css +0 -0
  146. package/{src/lib/themes → themes}/theme-modern.css +0 -0
  147. package/{src/lib/themes → themes}/theme-rocket.css +0 -0
  148. package/{src/lib/themes → themes}/theme-sahara.css +0 -0
  149. package/{src/lib/themes → themes}/theme-seafoam.css +0 -0
  150. package/{src/lib/themes → themes}/theme-seasonal.css +0 -0
  151. package/{src/lib/themes → themes}/theme-skeleton.css +0 -0
  152. package/{src/lib/themes → themes}/theme-vintage.css +0 -0
  153. package/utilities/CodeBlock/CodeBlock.svelte +68 -0
  154. package/utilities/CodeBlock/CodeBlock.svelte.d.ts +25 -0
  155. package/utilities/CodeBlock/stores.d.ts +2 -0
  156. package/utilities/CodeBlock/stores.js +3 -0
  157. package/utilities/DataTable/DataTable.d.ts +18 -0
  158. package/utilities/DataTable/DataTable.js +137 -0
  159. package/utilities/DataTable/actions.d.ts +8 -0
  160. package/utilities/DataTable/actions.js +114 -0
  161. package/utilities/DataTable/types.d.ts +33 -0
  162. package/utilities/DataTable/types.js +2 -0
  163. package/utilities/Drawer/Drawer.svelte +157 -0
  164. package/utilities/Drawer/Drawer.svelte.d.ts +33 -0
  165. package/utilities/Drawer/stores.d.ts +10 -0
  166. package/utilities/Drawer/stores.js +21 -0
  167. package/utilities/Drawer/types.d.ts +33 -0
  168. package/utilities/Drawer/types.js +2 -0
  169. package/utilities/LightSwitch/LightSwitch.svelte +98 -0
  170. package/utilities/LightSwitch/LightSwitch.svelte.d.ts +21 -0
  171. package/utilities/LightSwitch/stores.d.ts +2 -0
  172. package/utilities/LightSwitch/stores.js +5 -0
  173. package/utilities/LocalStorageStore/LocalStorageStore.d.ts +12 -0
  174. package/utilities/LocalStorageStore/LocalStorageStore.js +49 -0
  175. package/utilities/Menu/menu.d.ts +18 -0
  176. package/utilities/Menu/menu.js +151 -0
  177. package/utilities/Modal/Modal.svelte +195 -0
  178. package/utilities/Modal/Modal.svelte.d.ts +35 -0
  179. package/{src/lib/utilities → utilities}/Modal/examples/ModalExampleEmbed.svelte +5 -7
  180. package/utilities/Modal/examples/ModalExampleEmbed.svelte.d.ts +17 -0
  181. package/{src/lib/utilities → utilities}/Modal/examples/ModalExampleForm.svelte +20 -24
  182. package/utilities/Modal/examples/ModalExampleForm.svelte.d.ts +17 -0
  183. package/{src/lib/utilities → utilities}/Modal/examples/ModalExampleList.svelte +13 -18
  184. package/utilities/Modal/examples/ModalExampleList.svelte.d.ts +17 -0
  185. package/utilities/Modal/stores.d.ts +12 -0
  186. package/utilities/Modal/stores.js +24 -0
  187. package/utilities/Modal/types.d.ts +36 -0
  188. package/utilities/Modal/types.js +2 -0
  189. package/utilities/Toast/Toast.svelte +117 -0
  190. package/utilities/Toast/Toast.svelte.d.ts +28 -0
  191. package/utilities/Toast/stores.d.ts +10 -0
  192. package/utilities/Toast/stores.js +60 -0
  193. package/utilities/Toast/types.d.ts +26 -0
  194. package/utilities/Toast/types.js +2 -0
  195. package/utilities/Tooltip/tooltip.d.ts +35 -0
  196. package/utilities/Tooltip/tooltip.js +94 -0
  197. package/.eslintrc.cjs +0 -20
  198. package/.github/FUNDING.yml +0 -13
  199. package/.github/ISSUE_TEMPLATE/bug_report.yml +0 -30
  200. package/.github/ISSUE_TEMPLATE/config.yml +0 -8
  201. package/.github/ISSUE_TEMPLATE/docs_issue.yml +0 -23
  202. package/.github/ISSUE_TEMPLATE/feature_request.yml +0 -22
  203. package/.github/pull_request_template.md +0 -14
  204. package/.prettierignore +0 -12
  205. package/.prettierrc +0 -6
  206. package/postcss.config.cjs +0 -14
  207. package/scripts/compile-css-to-js.cjs +0 -50
  208. package/scripts/generate-jss.js +0 -67
  209. package/scripts/post-build.js +0 -17
  210. package/scripts/pre-build.js +0 -14
  211. package/src/app.d.ts +0 -13
  212. package/src/app.html +0 -43
  213. package/src/app.postcss +0 -10
  214. package/src/docs/DocsAppBar/DocsAppBar.svelte +0 -213
  215. package/src/docs/DocsFooter/DocsFooter.svelte +0 -78
  216. package/src/docs/DocsLogo/DocsLogoAnim.svelte +0 -44
  217. package/src/docs/DocsLogo/DocsLogoFull.svelte +0 -11
  218. package/src/docs/DocsLogo/DocsLogoIcon.svelte +0 -6
  219. package/src/docs/DocsNavigation/DocsDrawer.svelte +0 -23
  220. package/src/docs/DocsNavigation/DocsSidebar.svelte +0 -103
  221. package/src/docs/DocsNavigation/links.ts +0 -148
  222. package/src/docs/DocsSearch/DocsSearch.svelte +0 -78
  223. package/src/docs/DocsShell/DocsShell.svelte +0 -377
  224. package/src/docs/DocsShell/sveldMapper.ts +0 -143
  225. package/src/docs/DocsShell/types.ts +0 -96
  226. package/src/docs/DocsStyles/blog.css +0 -192
  227. package/src/docs/DocsThemer/DocsThemer.svelte +0 -254
  228. package/src/docs/DocsThemer/Swatch.svelte +0 -28
  229. package/src/docs/DocsThemer/colors.ts +0 -122
  230. package/src/docs/DocsThemer/settings.ts +0 -129
  231. package/src/docs/DocsThemer/stores.ts +0 -5
  232. package/src/docs/DocsThemer/types.ts +0 -20
  233. package/src/docs/README.md +0 -3
  234. package/src/docs/stores.ts +0 -15
  235. package/src/lib/actions/Clipboard/clipboard.ts +0 -39
  236. package/src/lib/actions/Filters/filter.test.ts +0 -40
  237. package/src/lib/actions/Filters/filter.ts +0 -23
  238. package/src/lib/actions/FocusTrap/focusTrap.ts +0 -56
  239. package/src/lib/components/Accordion/AccordionGroup.svelte +0 -53
  240. package/src/lib/components/Accordion/AccordionGroup.test.ts +0 -22
  241. package/src/lib/components/Accordion/AccordionItem.svelte +0 -80
  242. package/src/lib/components/Accordion/AccordionItem.test.ts +0 -28
  243. package/src/lib/components/Alert/Alert.svelte +0 -71
  244. package/src/lib/components/Alert/Alert.test.ts +0 -30
  245. package/src/lib/components/AppBar/AppBar.svelte +0 -60
  246. package/src/lib/components/AppBar/AppBar.test.ts +0 -31
  247. package/src/lib/components/AppRail/AppRail.svelte +0 -58
  248. package/src/lib/components/AppRail/AppRailTile.svelte +0 -66
  249. package/src/lib/components/AppShell/AppShell.svelte +0 -84
  250. package/src/lib/components/AppShell/AppShell.test.ts +0 -26
  251. package/src/lib/components/Avatar/Avatar.svelte +0 -51
  252. package/src/lib/components/Avatar/Avatar.test.ts +0 -41
  253. package/src/lib/components/Breadcrumb/Breadcrumb.svelte +0 -30
  254. package/src/lib/components/Breadcrumb/Breadcrumb.test.ts +0 -20
  255. package/src/lib/components/Breadcrumb/Crumb.test.ts +0 -48
  256. package/src/lib/components/ConicGradient/ConicGradient.svelte +0 -88
  257. package/src/lib/components/ConicGradient/ConicGradient.test.ts +0 -26
  258. package/src/lib/components/ConicGradient/settings.ts +0 -345
  259. package/src/lib/components/ConicGradient/types.ts +0 -12
  260. package/src/lib/components/Divider/Divider.svelte +0 -26
  261. package/src/lib/components/Divider/Divider.test.ts +0 -32
  262. package/src/lib/components/FileButton/FileButton.svelte +0 -29
  263. package/src/lib/components/FileButton/FileButton.test.ts +0 -32
  264. package/src/lib/components/FileDropzone/FileDropzone.svelte +0 -108
  265. package/src/lib/components/FileDropzone/FileDropzone.test.ts +0 -32
  266. package/src/lib/components/GradientHeading/GradientHeading.svelte +0 -24
  267. package/src/lib/components/GradientHeading/GradientHeading.test.ts +0 -30
  268. package/src/lib/components/InputChip/InputChip.svelte +0 -118
  269. package/src/lib/components/ListBox/ListBox.svelte +0 -65
  270. package/src/lib/components/ListBox/ListBox.test.ts +0 -48
  271. package/src/lib/components/ListBox/ListBoxItem.svelte +0 -99
  272. package/src/lib/components/ListBox/ListBoxItem.test.ts +0 -22
  273. package/src/lib/components/Paginator/Paginator.svelte +0 -84
  274. package/src/lib/components/Paginator/Paginator.test.ts +0 -29
  275. package/src/lib/components/Paginator/types.ts +0 -12
  276. package/src/lib/components/ProgressBar/ProgressBar.svelte +0 -73
  277. package/src/lib/components/ProgressBar/ProgressBar.test.ts +0 -27
  278. package/src/lib/components/ProgressRadial/ProgressRadial.svelte +0 -98
  279. package/src/lib/components/ProgressRadial/ProgressRadial.test.ts +0 -26
  280. package/src/lib/components/Radio/RadioGroup.svelte +0 -54
  281. package/src/lib/components/Radio/RadioGroup.test.ts +0 -35
  282. package/src/lib/components/Radio/RadioItem.svelte +0 -71
  283. package/src/lib/components/Radio/RadioItem.test.ts +0 -32
  284. package/src/lib/components/RangeSlider/RangeSlider.svelte +0 -110
  285. package/src/lib/components/RangeSlider/RangeSlider.test.ts +0 -44
  286. package/src/lib/components/SlideToggle/SlideToggle.svelte +0 -106
  287. package/src/lib/components/SlideToggle/SlideToggle.test.ts +0 -23
  288. package/src/lib/components/Stepper/Step.svelte +0 -140
  289. package/src/lib/components/Stepper/Step.test.ts +0 -21
  290. package/src/lib/components/Stepper/Stepper.svelte +0 -71
  291. package/src/lib/components/Stepper/Stepper.test.ts +0 -31
  292. package/src/lib/components/SvgIcon/SvgIcon.svelte +0 -50
  293. package/src/lib/components/SvgIcon/SvgIcon.test.ts +0 -28
  294. package/src/lib/components/SvgIcon/icons.ts +0 -29
  295. package/src/lib/components/Tab/Tab.svelte +0 -79
  296. package/src/lib/components/Tab/Tab.test.ts +0 -26
  297. package/src/lib/components/Tab/TabGroup.svelte +0 -78
  298. package/src/lib/components/Tab/TabGroup.test.ts +0 -30
  299. package/src/lib/components/Table/Table.svelte +0 -106
  300. package/src/lib/components/Table/types.ts +0 -10
  301. package/src/lib/components/TableOfContents/TableOfContents.svelte +0 -139
  302. package/src/lib/themes/theme-test.css +0 -96
  303. package/src/lib/utilities/CodeBlock/CodeBlock.svelte +0 -78
  304. package/src/lib/utilities/CodeBlock/CodeBlock.test.ts +0 -27
  305. package/src/lib/utilities/CodeBlock/stores.ts +0 -5
  306. package/src/lib/utilities/DataTable/DataTable.ts +0 -151
  307. package/src/lib/utilities/DataTable/actions.ts +0 -100
  308. package/src/lib/utilities/DataTable/types.ts +0 -33
  309. package/src/lib/utilities/Drawer/Drawer.svelte +0 -173
  310. package/src/lib/utilities/Drawer/Drawer.test.ts +0 -15
  311. package/src/lib/utilities/Drawer/stores.ts +0 -27
  312. package/src/lib/utilities/Drawer/types.ts +0 -47
  313. package/src/lib/utilities/LightSwitch/LightSwitch.svelte +0 -116
  314. package/src/lib/utilities/LightSwitch/LightSwitch.test.ts +0 -19
  315. package/src/lib/utilities/LightSwitch/stores.ts +0 -7
  316. package/src/lib/utilities/LocalStorageStore/LocalStorageStore.test.ts +0 -220
  317. package/src/lib/utilities/LocalStorageStore/LocalStorageStore.ts +0 -77
  318. package/src/lib/utilities/Menu/menu.test.ts +0 -22
  319. package/src/lib/utilities/Menu/menu.ts +0 -172
  320. package/src/lib/utilities/Modal/Modal.svelte +0 -206
  321. package/src/lib/utilities/Modal/Modal.test.ts +0 -50
  322. package/src/lib/utilities/Modal/stores.ts +0 -29
  323. package/src/lib/utilities/Modal/types.ts +0 -39
  324. package/src/lib/utilities/Toast/Toast.svelte +0 -95
  325. package/src/lib/utilities/Toast/Toats.test.ts +0 -25
  326. package/src/lib/utilities/Toast/stores.ts +0 -63
  327. package/src/lib/utilities/Toast/types.ts +0 -29
  328. package/src/lib/utilities/Tooltip/tooltip.ts +0 -137
  329. package/src/routes/(inner)/+layout.svelte +0 -3
  330. package/src/routes/(inner)/actions/clipboard/+page.svelte +0 -87
  331. package/src/routes/(inner)/actions/filters/+page.svelte +0 -151
  332. package/src/routes/(inner)/actions/focus-trap/+page.svelte +0 -59
  333. package/src/routes/(inner)/components/accordions/+page.svelte +0 -127
  334. package/src/routes/(inner)/components/alerts/+page.svelte +0 -130
  335. package/src/routes/(inner)/components/app-bar/+page.svelte +0 -52
  336. package/src/routes/(inner)/components/app-rail/+page.svelte +0 -105
  337. package/src/routes/(inner)/components/app-shell/+page.svelte +0 -159
  338. package/src/routes/(inner)/components/avatars/+page.svelte +0 -193
  339. package/src/routes/(inner)/components/breadcrumbs/+page.svelte +0 -121
  340. package/src/routes/(inner)/components/conic-gradients/+page.svelte +0 -161
  341. package/src/routes/(inner)/components/dividers/+page.svelte +0 -146
  342. package/src/routes/(inner)/components/file-buttons/+page.svelte +0 -46
  343. package/src/routes/(inner)/components/file-dropzone/+page.svelte +0 -71
  344. package/src/routes/(inner)/components/gradient-headings/+page.svelte +0 -138
  345. package/src/routes/(inner)/components/input-chips/+page.svelte +0 -128
  346. package/src/routes/(inner)/components/listboxes/+page.svelte +0 -92
  347. package/src/routes/(inner)/components/paginators/+page.svelte +0 -118
  348. package/src/routes/(inner)/components/progress-bars/+page.svelte +0 -157
  349. package/src/routes/(inner)/components/progress-radials/+page.svelte +0 -64
  350. package/src/routes/(inner)/components/radio-groups/+page.svelte +0 -91
  351. package/src/routes/(inner)/components/range-sliders/+page.svelte +0 -134
  352. package/src/routes/(inner)/components/slide-toggles/+page.svelte +0 -63
  353. package/src/routes/(inner)/components/steppers/+page.svelte +0 -168
  354. package/src/routes/(inner)/components/svg-icons/+page.svelte +0 -60
  355. package/src/routes/(inner)/components/table-of-contents/+page.svelte +0 -110
  356. package/src/routes/(inner)/components/tables/+page.svelte +0 -216
  357. package/src/routes/(inner)/components/tabs/+page.svelte +0 -146
  358. package/src/routes/(inner)/docs/comparisons/+page.svelte +0 -130
  359. package/src/routes/(inner)/docs/contributions/+page.svelte +0 -78
  360. package/src/routes/(inner)/docs/contributions/documentation/+page.svelte +0 -217
  361. package/src/routes/(inner)/docs/contributions/requirements/+page.svelte +0 -173
  362. package/src/routes/(inner)/docs/contributions/style-guide/+page.svelte +0 -164
  363. package/src/routes/(inner)/docs/faqs/+page.svelte +0 -80
  364. package/src/routes/(inner)/docs/features/+page.svelte +0 -121
  365. package/src/routes/(inner)/docs/recommended/+page.svelte +0 -162
  366. package/src/routes/(inner)/docs/why/+page.svelte +0 -104
  367. package/src/routes/(inner)/elements/alerts/+page.svelte +0 -142
  368. package/src/routes/(inner)/elements/badges/+page.svelte +0 -155
  369. package/src/routes/(inner)/elements/breadcrumbs/+page.svelte +0 -132
  370. package/src/routes/(inner)/elements/buttons/+page.svelte +0 -304
  371. package/src/routes/(inner)/elements/cards/+page.svelte +0 -117
  372. package/src/routes/(inner)/elements/chips/+page.svelte +0 -130
  373. package/src/routes/(inner)/elements/core/+page.svelte +0 -98
  374. package/src/routes/(inner)/elements/forms/+page.svelte +0 -89
  375. package/src/routes/(inner)/elements/forms/preview/+page.svelte +0 -256
  376. package/src/routes/(inner)/elements/lists/+page.svelte +0 -197
  377. package/src/routes/(inner)/elements/logo-clouds/+page.svelte +0 -105
  378. package/src/routes/(inner)/elements/placeholders/+page.svelte +0 -70
  379. package/src/routes/(inner)/elements/tables/+page.svelte +0 -138
  380. package/src/routes/(inner)/elements/tokens/+page.svelte +0 -176
  381. package/src/routes/(inner)/elements/typography/+page.svelte +0 -100
  382. package/src/routes/(inner)/guides/install/+page.svelte +0 -84
  383. package/src/routes/(inner)/guides/quickstart/+page.svelte +0 -118
  384. package/src/routes/(inner)/guides/styling/+page.svelte +0 -361
  385. package/src/routes/(inner)/guides/tailwind/+page.svelte +0 -150
  386. package/src/routes/(inner)/guides/themes/+page.svelte +0 -144
  387. package/src/routes/(inner)/guides/themes/colors/+page.svelte +0 -87
  388. package/src/routes/(inner)/guides/themes/generator/+page.svelte +0 -58
  389. package/src/routes/(inner)/guides/themes/presets.ts +0 -69
  390. package/src/routes/(inner)/template/+page.svelte +0 -52
  391. package/src/routes/(inner)/utilities/codeblocks/+page.svelte +0 -77
  392. package/src/routes/(inner)/utilities/data-tables/+page.svelte +0 -399
  393. package/src/routes/(inner)/utilities/data-tables/+page.ts +0 -18
  394. package/src/routes/(inner)/utilities/drawers/+page.svelte +0 -193
  395. package/src/routes/(inner)/utilities/lightswitches/+page.svelte +0 -86
  396. package/src/routes/(inner)/utilities/local-storage-stores/+page.svelte +0 -67
  397. package/src/routes/(inner)/utilities/menus/+page.svelte +0 -186
  398. package/src/routes/(inner)/utilities/modals/+page.svelte +0 -391
  399. package/src/routes/(inner)/utilities/toasts/+page.svelte +0 -212
  400. package/src/routes/(inner)/utilities/tooltips/+page.svelte +0 -153
  401. package/src/routes/+error.svelte +0 -16
  402. package/src/routes/+layout.server.ts +0 -13
  403. package/src/routes/+layout.svelte +0 -100
  404. package/src/routes/+page.server.ts +0 -12
  405. package/src/routes/+page.svelte +0 -197
  406. package/src/routes/blog/+page.svelte +0 -78
  407. package/src/routes/blog/+page.ts +0 -6
  408. package/src/routes/blog/[slug]/+page.svelte +0 -112
  409. package/src/routes/blog/[slug]/+page.ts +0 -6
  410. package/src/routes/blog/blog-service.ts +0 -31
  411. package/src/routes/blog/rss/+server.ts +0 -16
  412. package/static/favicon.png +0 -0
  413. package/svelte.config.js +0 -30
  414. package/tailwind.config.cjs +0 -14
  415. package/tsconfig.json +0 -37
  416. package/vite.config.js +0 -25
@@ -1,146 +0,0 @@
1
- <script lang="ts">
2
- import { writable } from 'svelte/store';
3
-
4
- import DocsShell from '$docs/DocsShell/DocsShell.svelte';
5
- import { DocsFeature, type DocsShellSettings } from '$docs/DocsShell/types';
6
-
7
- import TabGroup from '$lib/components/Tab/TabGroup.svelte';
8
- import Tab from '$lib/components/Tab/Tab.svelte';
9
- import SvgIcon from '$lib/components/SvgIcon/SvgIcon.svelte';
10
- import CodeBlock from '$lib/utilities/CodeBlock/CodeBlock.svelte';
11
-
12
- // @ts-expect-error sveld import
13
- import sveldTabGroup from '$lib/components/Tab/TabGroup.svelte?raw&sveld';
14
- // @ts-expect-error sveld import
15
- import sveldTab from '$lib/components/Tab/Tab.svelte?raw&sveld';
16
-
17
- let storeOne = writable('a');
18
- let storeTwo = writable('a');
19
- let storeThree = writable('a');
20
-
21
- // Docs Shell
22
- const settings: DocsShellSettings = {
23
- feature: DocsFeature.Component,
24
- name: 'Tabs',
25
- description: 'Use tabs to quickly switch between different views.',
26
- imports: ['TabGroup', 'Tab'],
27
- source: 'components/Tab',
28
- aria: 'https://www.w3.org/WAI/ARIA/apg/patterns/tabpanel/',
29
- components: [
30
- { label: 'TabGroup', sveld: sveldTabGroup },
31
- { label: 'Tab', sveld: sveldTab, overrideProps: ['borderWidth', 'borderColor', 'color', 'fill', 'hover', 'rounded'] }
32
- ]
33
- };
34
- </script>
35
-
36
- <DocsShell {settings}>
37
- <!-- Slot: Sandbox -->
38
- <svelte:fragment slot="sandbox">
39
- <section class="space-y-4">
40
- <h2 class="sr-only">Examples</h2>
41
- <div class="grid grid-cols-1 md:grid-cols-2 gap-4">
42
- <div class="card p-4 space-y-4">
43
- <TabGroup selected={storeOne}>
44
- <Tab value="a">Tab A</Tab>
45
- <Tab value="b">Tab B</Tab>
46
- <Tab value="c">Tab C</Tab>
47
- </TabGroup>
48
- <div>
49
- {#if $storeOne === 'a'}Content A{/if}
50
- {#if $storeOne === 'b'}Content B{/if}
51
- {#if $storeOne === 'c'}Content C{/if}
52
- </div>
53
- </div>
54
- <div class="card p-4 space-y-4">
55
- <TabGroup
56
- selected={storeTwo}
57
- justify="justify-start md:justify-end"
58
- borderColor="border-secondary-500"
59
- color="text-secondary-500"
60
- hover="hover:bg-secondary-500/10"
61
- >
62
- <Tab value="a">Tab A</Tab>
63
- <Tab value="b">Tab B</Tab>
64
- <Tab value="c">Tab C</Tab>
65
- </TabGroup>
66
- <div>
67
- {#if $storeTwo === 'a'}Content A{/if}
68
- {#if $storeTwo === 'b'}Content B{/if}
69
- {#if $storeTwo === 'c'}Content C{/if}
70
- </div>
71
- </div>
72
- </div>
73
- <div class="card p-4 space-y-4">
74
- <TabGroup
75
- selected={storeThree}
76
- justify="justify-start md:justify-center"
77
- borderColor="border-tertiary-500"
78
- fill="fill-tertiary-500"
79
- color="text-tertiary-500"
80
- hover="hover:bg-tertiary-500/10"
81
- >
82
- <Tab value="a">
83
- <svelte:fragment slot="lead">
84
- <i class="fa-solid fa-book" />
85
- </svelte:fragment>
86
- Books
87
- </Tab>
88
- <Tab value="b">
89
- <svelte:fragment slot="lead">
90
- <i class="fa-solid fa-clapperboard" />
91
- </svelte:fragment>
92
- Movies
93
- </Tab>
94
- <Tab value="c">
95
- <svelte:fragment slot="lead">
96
- <i class="fa-solid fa-tv" />
97
- </svelte:fragment>
98
- Television
99
- </Tab>
100
- </TabGroup>
101
- <div>
102
- {#if $storeThree === 'a'}
103
- <h3>Books</h3>
104
- <p>
105
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
106
- </p>
107
- {/if}
108
- {#if $storeThree === 'b'}
109
- <h3>Movies</h3>
110
- <p>
111
- Nisl nunc mi ipsum faucibus vitae aliquet nec. Ac ut consequat semper viverra nam libero justo laoreet. Nec sagittis aliquam
112
- malesuada.
113
- </p>
114
- {/if}
115
- {#if $storeThree === 'c'}
116
- <h3>Television</h3>
117
- <p>
118
- Ut sem viverra aliquet eget sit. Porttitor lacus luctus accumsan tortor posuere ac ut consequat. Vulputate enim nulla aliquet
119
- porttitor.
120
- </p>
121
- {/if}
122
- </div>
123
- </div>
124
- </section>
125
- </svelte:fragment>
126
-
127
- <!-- Slot: Usage -->
128
- <svelte:fragment slot="usage">
129
- <section class="space-y-4">
130
- <CodeBlock language="typescript" code={`import { writable, type Writable } from 'svelte/store';`} />
131
- <CodeBlock language="typescript" code={`const storeTab: Writable<string> = writable('a');`} />
132
- <CodeBlock
133
- language="html"
134
- code={`
135
- <TabGroup selected={storeTab}>
136
- <Tab value="a">(labelA)</Tab>
137
- <Tab value="b">(labelB)</Tab>
138
- </TabGroup>
139
-
140
- <!-- Conditionally display content -->
141
- {#if $storeTab === 'a'}Content A{/if}
142
- {#if $storeTab === 'b'}Content B{/if}`}
143
- />
144
- </section>
145
- </svelte:fragment>
146
- </DocsShell>
@@ -1,130 +0,0 @@
1
- <script lang="ts">
2
- import CodeBlock from '$lib/utilities/CodeBlock/CodeBlock.svelte';
3
- import AccordionGroup from '$lib/components/Accordion/AccordionGroup.svelte';
4
- import AccordionItem from '$lib/components/Accordion/AccordionItem.svelte';
5
- </script>
6
-
7
- <div class="page-container">
8
- <!-- Header -->
9
- <header class="space-y-4">
10
- <h1>Comparisons</h1>
11
- <p>See how Skeleton compares to other UI component libraries.</p>
12
- </header>
13
-
14
- <hr />
15
-
16
- <!-- Mantine -->
17
- <section class="space-y-4">
18
- <h2>Mantine</h2>
19
- <a href="https://mantine.dev/" target="_blank" rel="noreferrer">https://mantine.dev/</a>
20
- <p>
21
- It’s no secret that Mantine has had a huge influence on the features and design of Skeleton. We love Mantine’s huge set of components,
22
- modular add-ons, and, of course, the best-in-class documentation. We’re also huge fans of the deep customization provided per
23
- component. However, Mantine is unfortunately only available for React. That said, the Skeleton team hopes to bridge the gap and
24
- provide a similar experience for Svelte developers.
25
- </p>
26
- </section>
27
-
28
- <!-- Flowbite -->
29
- <section class="space-y-4">
30
- <h2>Flowbite</h2>
31
- <a href="https://flowbite.com/" target="_blank" rel="noreferrer">https://flowbite.com/</a>
32
- <p>
33
- Flowbite provides a set of turnkey HTML/CSS components built with Tailwind’s utility class system. Unlike other libraries, Flowbite
34
- focuses on a singular and opinionated design aesthetic. Flowbite is a general purpose library, which means it can be used within any
35
- framework, but also provides framework-specific variations like <a
36
- href="https://flowbite-svelte.com/"
37
- target="_blank"
38
- rel="noreferrer">Flowbite Svelte</a
39
- >. It’s relatively simple to tailor a Flowbite component to work within an existing Tailwind design system. In fact, it’s even
40
- possible to pair Flowbite with Skeleton, allowing you to mix and match components, while taking advantage of Skeleton’s theme system.
41
- </p>
42
- <div class="card p-4 card-glass-surface">
43
- <AccordionGroup>
44
- <AccordionItem>
45
- <svelte:fragment slot="summary">
46
- <strong>View Flowbite integration mini-guide.</strong>
47
- </svelte:fragment>
48
- <svelte:fragment slot="content">
49
- <div class="space-y-4 pb-3">
50
- <p>
51
- Let's integrate a <a href="https://flowbite.com/docs/components/card/" target="_blank" rel="noreferrer">Flowbite Card</a>.
52
- Here's the default markup:
53
- </p>
54
- <CodeBlock
55
- language="html"
56
- code={`
57
- <a href="#" class="block p-6 max-w-sm bg-white rounded-lg border border-gray-200 shadow-md hover:bg-gray-100 dark:bg-gray-800 dark:border-gray-700 dark:hover:bg-gray-700">
58
- <h5 class="mb-2 text-2xl font-bold tracking-tight text-gray-900 dark:text-white">Flowbite Version</h5>
59
- <p class="font-normal text-gray-700 dark:text-gray-400">Lorem, ipsum dolor sit amet consectetur adipisicing elit.</p>
60
- </a>
61
- `}
62
- />
63
- <p>We make several small adjustments to take advantage of Skeleton's styles and theme system:</p>
64
- <ul class="list-disc list-inside">
65
- <li>Replaced all instances of the <code>bg-gray-X</code> class with <code>bg-surface-X</code>.</li>
66
- <li>Added a <code>!no-outline</code> class to prevent text underlines.</li>
67
- <li>Modified the the heading to be an H2 and dropped <code>text-2xl font-bold</code> classes.</li>
68
- <li>Bumped <code>max-w-sm</code> up to <code>max-w-lg</code> to fit our content width.</li>
69
- </ul>
70
- <CodeBlock
71
- language="html"
72
- code={`
73
- <a href="#" class="block p-6 max-w-lg bg-white rounded-lg border border-surface-200 shadow-md hover:bg-surface-100 dark:bg-surface-800 dark:border-surface-700 dark:hover:bg-surface-700 !no-underline">
74
- <h2 class="mb-2 tracking-tight text-surface-900 dark:text-white">Flowbite + Skeleton = ❤️</h2>
75
- <p class="font-normal text-surface-700 dark:text-surface-400">Lorem, ipsum dolor sit amet consectetur adipisicing elit.</p>
76
- </a>
77
- `}
78
- />
79
- <p>Here's the final result. Try toggling various themes to see how the Flowbite component adapts.</p>
80
- <a
81
- href="/docs/comparisons"
82
- class="block p-6 max-w-lg bg-white rounded-lg border border-surface-200 shadow-md hover:bg-surface-100 dark:bg-surface-800 dark:border-surface-700 dark:hover:bg-surface-700 !no-underline"
83
- >
84
- <h2 class="mb-2 tracking-tight text-surface-900 dark:text-white">Skeleton + Flowbite = ❤️</h2>
85
- <p class="font-normal text-surface-700 dark:text-surface-400">Lorem, ipsum dolor sit amet consectetur adipisicing elit.</p>
86
- </a>
87
- </div>
88
- </svelte:fragment>
89
- </AccordionItem>
90
- </AccordionGroup>
91
- </div>
92
- </section>
93
-
94
- <!-- Daisy UI -->
95
- <section class="space-y-4">
96
- <h2>Daisy UI</h2>
97
- <a href="https://daisyui.com/" target="_blank" rel="noreferrer">https://daisyui.com/</a>
98
- <p>
99
- Daisy can be compared to Skeleton due to our shared use of Tailwind CSS and highly customizable theme systems. Unfortunately, Daisy
100
- themes rely on hex color values which <a
101
- href="https://tailwindcss.com/docs/customizing-colors#using-css-variables"
102
- target="_blank"
103
- rel="noreferrer">prevents the use of the opacity modifier syntax</a
104
- >. Daisy also opts to forgo the biggest benefit of Tailwind, the deeply extensible utility class system, instead relying on
105
- <a href="https://tailwindcss.com/docs/reusing-styles#avoiding-premature-abstraction" target="_blank" rel="noreferrer">@apply</a> to generate
106
- canned style sets. Skeleton, on the other hand, treats utility classes as first class citizens, providing hooks to set and override Tailwind
107
- classes within each component. Skeleton components also accept arbitrary classes, allowing full customization from top to bottom. However,
108
- it’s worth noting that Daisy is a general purpose library available to any framework, while Skeleton focuses purely on Svelte.
109
- </p>
110
- </section>
111
-
112
- <!-- Svelte Material UI -->
113
- <section class="space-y-4">
114
- <h2>Svelte Material UI</h2>
115
- <a href="https://sveltematerialui.com/" target="_blank" rel="noreferrer">https://sveltematerialui.com/</a>
116
- <p>
117
- The founding members of Skeleton are huge fans of Material Design and recognize its influence on modern web UI, UX, and component
118
- systems in general. Our team has extensive experience with <a href="https://material.angular.io/" target="_blank" rel="noreferrer"
119
- >Angular Material</a
120
- >, which adapts the Material Design conventions for the <a href="https://angular.io/" target="_blank" rel="noreferrer">Angular</a>
121
- framework. This has actually influenced many of the design decisions for creating Skeleton, including our opinions on
122
- <a href="/elements/forms">form components</a>. It makes sense that Svelte Material UI would be popular, as it bridges the benefits of
123
- Material Design with the power of Svelte. However, Skeleton has chosen to shy away from the look and feel of Material Design, and
124
- instead create a more unique aesthetic. Additionally, Skeleton features tight integration with Tailwind to aid in building a fully
125
- realized design system, allowing you to control every aspect of your interface from the ground up. If, for some reason, you are
126
- adverse to Tailwind or you wish to lean into the Material Design style, then we would recommend Svelte Material UI. It also has the
127
- benefit of being one of the oldest and most mature UI component libraries available for Svelte today.
128
- </p>
129
- </section>
130
- </div>
@@ -1,78 +0,0 @@
1
- <!-- <script lang="ts"></script> -->
2
-
3
- <div class="page-container">
4
- <!-- Header -->
5
- <header class="space-y-4">
6
- <h1>Contributions</h1>
7
- <p>
8
- Thank you for your interest in contributing to Skeleton. We ask that you please review the sections below in full before submitting
9
- your first pull request.
10
- </p>
11
- </header>
12
-
13
- <hr />
14
-
15
- <!-- Resources -->
16
- <section class="grid grid-cols-1 md:grid-cols-2 gap-4">
17
- <!-- Article: How to Contribute -->
18
- <a class="card p-4 space-y-4" href="https://opensource.guide/how-to-contribute/" target="_blank" rel="noreferrer">
19
- <h2>How to Contribute</h2>
20
- <p>Are you new to open source? Read this helpful guide covering the basic concepts and best practices for contributing.</p>
21
- <div class="flex justify-end">
22
- <button class="btn btn-filled-secondary">Read Article</button>
23
- </div>
24
- </a>
25
- <!-- GitHub: First Contributions -->
26
- <a class="card p-4 space-y-4" href="https://github.com/firstcontributions/first-contributions" target="_blank" rel="noreferrer">
27
- <h2>First Contributions</h2>
28
- <p>Need a guided tour? Follow a written step-by-step guide explaining the process for contributing to open source.</p>
29
- <div class="flex justify-end">
30
- <button class="btn btn-filled-secondary">View Project</button>
31
- </div>
32
- </a>
33
- </section>
34
-
35
- <hr />
36
-
37
- <section class="space-y-4">
38
- <h2>Guides</h2>
39
- <!-- Basics -->
40
- <a class="card p-4 grid grid-cols-[1fr_auto] gap-4" href="/docs/contributions/requirements">
41
- <div class="space-y-4">
42
- <h2>Requirements</h2>
43
- <p>Ready to contribute to Skeleton? Read our requirements and recommended workflow process.</p>
44
- </div>
45
- <button class="btn btn-filled-secondary place-self-center">Read Guide</button>
46
- </a>
47
- <!-- Style Guide -->
48
- <a class="card p-4 grid grid-cols-[1fr_auto] gap-4" href="/docs/contributions/style-guide">
49
- <div class="space-y-4">
50
- <h2>Style Guide</h2>
51
- <p>Review recommended conventions for writing code, naming properties, and handling CSS styling.</p>
52
- </div>
53
- <button class="btn btn-filled-secondary place-self-center">Read Guide</button>
54
- </a>
55
- <!-- Docs Guide -->
56
- <a class="card p-4 grid grid-cols-[1fr_auto] gap-4" href="/docs/contributions/documentation">
57
- <div class="space-y-4">
58
- <h2>Documentation Guide</h2>
59
- <p>Good documentation makes life easier for everyone involved, check out how easy it is with this guide.</p>
60
- </div>
61
- <button class="btn btn-filled-secondary place-self-center">Read Guide</button>
62
- </a>
63
- </section>
64
-
65
- <hr />
66
-
67
- <section class="space-y-4">
68
- <h2>Videos</h2>
69
- <!-- Testing (video) -->
70
- <a class="card p-4 grid grid-cols-[1fr_auto] gap-4" href="https://youtu.be/Ru3FtSzN128" target="_blank" rel="noreferrer">
71
- <div class="space-y-4">
72
- <h2>Automated Tests</h2>
73
- <p>Watch an in-depth video covering automated testing with Vitest, provided by Skeleton contributors.</p>
74
- </div>
75
- <button class="btn btn-filled-secondary place-self-center">Watch Video</button>
76
- </a>
77
- </section>
78
- </div>
@@ -1,217 +0,0 @@
1
- <script lang="ts">
2
- import CodeBlock from '$lib/utilities/CodeBlock/CodeBlock.svelte';
3
- </script>
4
-
5
- <div class="page-container">
6
- <!-- Breadcrumbs -->
7
- <ol class="breadcrumb">
8
- <li class="crumb"><a href="/docs/contributions">Contributions</a></li>
9
- <li class="crumb-separator" aria-hidden>&rsaquo;</li>
10
- <li>Documentation</li>
11
- </ol>
12
-
13
- <!-- Header -->
14
- <header class="space-y-4">
15
- <div class="grid grid-cols-[1fr_auto] gap-4">
16
- <div class="space-y-4">
17
- <h1>Documentation</h1>
18
- <p>
19
- Below is an introduction to automated documentation features, using tools like <a
20
- href="https://github.com/carbon-design-system/sveld"
21
- target="_blank"
22
- rel="noreferrer">Sveld</a
23
- >. First we'll learn how to document component props, slots, and events. Then we'll cover how to provide this information to the
24
- documentation pages themselves.
25
- </p>
26
- </div>
27
- <div class="place-self-end grid grid-cols-1 gap-2">
28
- <a class="btn btn-filled-primary" href="https://github.com/carbon-design-system/sveld" target="_blank" rel="noreferrer"
29
- >Sveld Documentation</a
30
- >
31
- </div>
32
- </div>
33
- </header>
34
-
35
- <hr />
36
-
37
- <!-- Intro -->
38
- <section class="space-y-4">
39
- <h2>Components</h2>
40
- <p>
41
- Sveld makes use of <a href="https://tsdoc.org" target="_blank" rel="noreferrer">TSDoc tags</a> (a superset of JSDocs) to generate
42
- component documentation from the component code itself. This comes with the benefit of providing additional
43
- <a href="https://code.visualstudio.com/docs/editor/intellisense" target="_blank" rel="noreferrer">Intellisense</a>
44
- features to aid developers implementing Skeleton components in tools like VS Code. Tap <kbd>Ctrl/⌘ + i</kbd> in a component declaration
45
- to see the extended docs come through.
46
- </p>
47
- </section>
48
-
49
- <!-- TSDocs -->
50
- <section class="space-y-4">
51
- <h3>Props</h3>
52
- <p><a href="https://github.com/carbon-design-system/sveld#type" target="_blank" rel="noreferrer">Sveld Reference</a></p>
53
- <p>
54
- To document component props, simply add TSDoc description comments using the <code>/** ... */</code> format. In most use cases Sveld will
55
- automatically parse all relevant information - including the prop name, type, value, and your provided description.
56
- </p>
57
- <CodeBlock
58
- language="js"
59
- code={`
60
- /** Provide classes to set vertical item spacing. */
61
- export let space: string = 'space-y-1';
62
- `}
63
- />
64
- <p>
65
- For non-primitive or custom types, you may need to specify this information. This can be accomplished using the <code>@type</code> tag
66
- with block-style comments. Specify the type in curly brackets immediately following the tag.
67
- </p>
68
- <CodeBlock
69
- language="js"
70
- code={`
71
- /**
72
- * Bind this to your form data, represents the "files" data from the input.
73
- * @type {FileList}
74
- */
75
- export let files: FileList;
76
- `}
77
- />
78
- <p>
79
- Ensure you document Context API <code>getContext</code> values to provide Intellisense. However, we intentionally exclude these values
80
- from the Props table.
81
- </p>
82
- <CodeBlock
83
- language="js"
84
- code={`
85
- /** Provide classes to set the hover background color. */
86
- export let hover: string = getContext('hover');
87
- `}
88
- />
89
- <p>For additonal examples, look at existing components in the project.</p>
90
- </section>
91
-
92
- <!-- Slots -->
93
- <section class="space-y-4">
94
- <h3>Slots</h3>
95
- <p><a href="https://github.com/carbon-design-system/sveld#slot" target="_blank" rel="noreferrer">Sveld Reference</a></p>
96
- <p>
97
- Slot documentation is provided by placing a TSDoc comment block at the top (by convention) of your script block. Note that Sveld does
98
- not currently support descriptions for the
99
- <code>default</code> slot at this time. Instead, we recommend you opt for a Usage tab example and instructions to illustrate the use of
100
- this slot.
101
- </p>
102
- <CodeBlock
103
- language="js"
104
- code={`
105
- // Slots
106
- /**
107
- * @slot lead - Provide a leading element, such as an icon.
108
- * @slot content - Provide the alert message text.
109
- */`}
110
- />
111
- <aside class="alert">
112
- <i class="fa-solid fa-lightbulb text-2xl" />
113
- <div class="alert-message">
114
- <strong>NOTE:</strong> The leading <code>// ...</code> comment is required for Sveld to successfully parse the slot descriptions. This
115
- is not optional.
116
- </div>
117
- </aside>
118
- </section>
119
-
120
- <!-- Events -->
121
- <section class="space-y-4">
122
- <h3>Events</h3>
123
- <p><a href="https://github.com/carbon-design-system/sveld#event" target="_blank" rel="noreferrer">Sveld Reference</a></p>
124
- <p>
125
- Sveld will automatically document forwarded events. You should not attempt to document these. However, dispatched events may be
126
- documented similar to props - with a TSDocs comment applied directly above the <code>dispatch()</code> method. Provide the event response
127
- in curly brackets, followed by the event name, a dash, and then the event description.
128
- </p>
129
- <CodeBlock
130
- language="js"
131
- code={`
132
- /** @event {{ event: DragEvent }} dragover - When a file is dragged over the component. */
133
- dispatch('dragover', event);`}
134
- />
135
- </section>
136
-
137
- <hr />
138
-
139
- <!-- Documentation Pages -->
140
- <section class="space-y-4">
141
- <h2>Documentation Pages</h2>
142
- <p>
143
- Now that our components are ready, it's time to create the documentation page that displays all of the information derived by Sveld.
144
- </p>
145
- <p>
146
- We provide a boilerplate template here:<br /><code>/src/routes/(inner)/template/+page.svelte</code>.
147
- </p>
148
- <p>
149
- Copy this to the appropriate file route location and use our recommend naming convention:<br />e.g.
150
- <code>/routes/components/your-new-component/+page.svelte</code>.
151
- </p>
152
- <!-- Documentation Tables -->
153
- <h3>Documentation Tables</h3>
154
- <p>To populate each documentation table we'll need to import our Sveld documentation data. Follow the instructions below:</p>
155
- <ol class="list-decimal list-inside space-y-1">
156
- <li>
157
- Create a duplicate of your component import statement, e.g. <code>import Avatar from '$lib/components/Avatar/Avatar.svelte';</code>
158
- </li>
159
- <li>Implement a <code>// @ts-expect-error sveld import</code> comment above the new import to silence any warnings.</li>
160
- <li>Rename the import reference using the convention: <code>Avatar</code> -> <code>sveldAvatar</code>.</li>
161
- <li>Append the following URL parameters to the end of your import statement, e.g.: <code>.../Accordion.svelte?raw&sveld</code>.</li>
162
- <li>
163
- Finally, pass the import reference to the DocShell settings like so: <code>components: [&#123; sveld: sveldAvatar &#125;]</code>
164
- </li>
165
- </ol>
166
- <!-- DocShell Settings -->
167
- <h3>DocShell Settings</h3>
168
- <p>
169
- We can provide settings to our DocShell component using <code>const settings: DocsShellSettings</code>. This allows you to populate
170
- all relevant settings on the page.
171
- </p>
172
- <section class="card p-4 flex flex-col md:flex-row justify-between items-center space-y-4 md:space-y-0 md:space-x-4">
173
- <div class="space-y-2">
174
- <p>Reference all available settings from the Typescript interface defintion.</p>
175
- </div>
176
- <a
177
- class="btn btn-filled-secondary"
178
- href="https://github.com/skeletonlabs/skeleton/blob/dev/src/docs/DocsShell/types.ts#L42"
179
- target="_blank"
180
- rel="noreferrer">View Available Settings</a
181
- >
182
- </section>
183
- <p>Below are existing documentation pages we recommend you reference:</p>
184
- <ul class="list-disc list-inside space-y-1">
185
- <li><a href="/elements/buttons">Buttons</a> showcases how to document Tailwind Element classes.</li>
186
- <li><a href="/components/accordions">Accordion</a> makes use of most Component settings utilizing Sveld.</li>
187
- <li><a href="/components/paginators">Accordion</a> uses Dipatched Event documentation.</li>
188
- <li><a href="/utilities/tooltips">Tooltips</a> provides an excellent reference for Action params.</li>
189
- </ul>
190
- <!-- Examples -->
191
- <h3>Examples</h3>
192
- <p>When showcasing examples of new features we typically handle this by one of two methods:</p>
193
- <ul class="list-disc list-inside space-y-1">
194
- <li>
195
- <strong>Sandbox</strong> (e.g. <a href="/components/range-sliders">Range Sliders</a>) - which provide a dynamic and interactive
196
- example that can be adjusted live.
197
- </li>
198
- <li>
199
- <strong>Static</strong> (e.g. <a href="/components/accordions">Accordion</a>) - with multiple static examples displaying various
200
- configurations.
201
- </li>
202
- </ul>
203
- <p>Dynamic examples are preferred, but remember the overall goal is to showcase how the feature operates.</p>
204
- <!-- Usage -->
205
- <h3>Usage</h3>
206
- <p>
207
- In addition to examples, you should provide multiple use case demonstrations using <code>CodeBlock</code> snippets to help end developers
208
- understand how to make use of your new components and features.
209
- </p>
210
- <!-- Keyboard Interactions -->
211
- <h3>Keyboard Interactions</h3>
212
- <p>
213
- Finally, don't forget to document any relevant keyboard interactions for accessibility. These can easily be provided via the DocShell
214
- settings.
215
- </p>
216
- </section>
217
- </div>