perhaps get the ts stuff to pass

KTibow · Dec 13, 2024 · 3873bfb · 3873bfb
1 parent 777679f
commit 3873bfb
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 45 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -1,13 +1,7 @@
 .DS_Store
 node_modules
+pnpm-lock.yaml
 /build
 /.svelte-kit
 /package
-.env
-.env.*
-!.env.example
-
-# Ignore files for PNPM, NPM and YARN
-pnpm-lock.yaml
-package-lock.json
-yarn.lock
+/src/routes/docs/guide
diff --git a/scripts/generate-guide.ts b/scripts/generate-guide.ts
@@ -214,6 +214,17 @@ const componentDocs = {
 };
 
 // Extracts all component data
+type Component = {
+  name: string;
+  displayName: string;
+  props: string[];
+  slots: string[];
+  specs: any;
+  variantProps: Record<string, string[]>;
+  example: string | undefined;
+  tip: string | undefined;
+};
+
 async function extractComponentData() {
   const componentFiles = await glob("src/lib/**/*.svelte", {
     ignore: ["**/+*.svelte", "**/forms/_picker/**"],
@@ -232,7 +243,7 @@ async function extractComponentData() {
     }
   }
 
-  const componentData = [];
+  const componentData: Component[] = [];
 
   for (const file of componentFiles) {
     const content = readFileSync(file, "utf-8");
@@ -452,7 +463,7 @@ for (const [category, items] of Object.entries(components)) {
 
     if (example) {
       sveltePage += `\n      <h4>Examples</h4>
-      <Snippet code={\`${example}\`} lang="xml" />`;
+      <Snippet code={\`${example.replaceAll("`", "\\`").replaceAll("<", `\${"<"}`)}\`} lang="xml" />`;
     }
 
     if (tip) {

diff --git a/src/lib/nav/NavDrawerButton.svelte b/src/lib/nav/NavDrawerButton.svelte
@@ -56,7 +56,7 @@
     -webkit-print-color-adjust: exact;
   }
   @media screen and (forced-colors: active) {
-    .destination.selected {
+    .destination:disabled {
       background-color: selecteditem;
     }
   }

diff --git a/src/routes/docs/Snippet.svelte b/src/routes/docs/Snippet.svelte
@@ -3,13 +3,12 @@
   import Icon from "$lib/misc/_icon.svelte";
   import iconCopy from "@ktibow/iconset-material-symbols/content-copy-outline";
   import Highlight from "svelte-highlight";
-  import type { LanguageType } from "svelte-highlight/languages";
   import javascript from "svelte-highlight/languages/javascript";
   import css from "svelte-highlight/languages/css";
   import xml from "svelte-highlight/languages/xml";
 
   export let code: string;
-  export let name: string | undefined;
+  export let name: string | undefined = undefined;
   export let lang: string;
 
   let snackbar: (data: SnackbarIn) => void;

diff --git a/src/routes/docs/guide/+page.svelte b/src/routes/docs/guide/+page.svelte
@@ -37,9 +37,9 @@
         <li>default</li>
       </ul>
       <h4>Examples</h4>
-      <Snippet code={`<Button type="filled" on:click={() => alert("Hello world!")}>
+      <Snippet code={`${"<"}Button type="filled" on:click={() => alert("Hello world!")}>
   Click me
-</Button>`} lang="xml" />
+${"<"}/Button>`} lang="xml" />
     </div>
     <div class="section">
       <h3>ButtonLink</h3>
@@ -68,12 +68,12 @@
         <li>default</li>
       </ul>
       <h4>Examples</h4>
-      <Snippet code={`<SegmentedButtonContainer>
-  <input type="radio" name="group" id="tab-a" checked />
-  <SegmentedButtonItem input="tab-a">Tab A</SegmentedButtonItem>
-  <input type="radio" name="group" id="tab-b" />
-  <SegmentedButtonItem input="tab-b">Tab B</SegmentedButtonItem>
-</SegmentedButtonContainer>`} lang="xml" />
+      <Snippet code={`${"<"}SegmentedButtonContainer>
+  ${"<"}input type="radio" name="group" id="tab-a" checked />
+  ${"<"}SegmentedButtonItem input="tab-a">Tab A${"<"}/SegmentedButtonItem>
+  ${"<"}input type="radio" name="group" id="tab-b" />
+  ${"<"}SegmentedButtonItem input="tab-b">Tab B${"<"}/SegmentedButtonItem>
+${"<"}/SegmentedButtonContainer>`} lang="xml" />
     </div>
     <div class="section">
       <h3>SegmentedButtonItem</h3>
@@ -102,7 +102,7 @@
         <li>text: string | undefined</li>
       </ul>
       <h4>Examples</h4>
-      <Snippet code={`<FAB
+      <Snippet code={`${"<"}FAB
   color="primary"
   size="normal"
   icon={iconEdit}
@@ -140,8 +140,8 @@
         <li>default</li>
       </ul>
       <h4>Examples</h4>
-      <Snippet code={`<Card type="elevated">Hello</Card>
-<CardClickable type="elevated">Click me</CardClickable>`} lang="xml" />
+      <Snippet code={`${"<"}Card type="elevated">Hello${"<"}/Card>
+${"<"}CardClickable type="elevated">Click me${"<"}/CardClickable>`} lang="xml" />
     </div>
     <div class="section">
       <h3>CardClickable</h3>
@@ -174,13 +174,13 @@
         <li>buttons</li>
       </ul>
       <h4>Examples</h4>
-      <Snippet code={`<Dialog icon={iconTrash} headline="Delete?" bind:open>
+      <Snippet code={`${"<"}Dialog icon={iconTrash} headline="Delete?" bind:open>
   Delete these items?
-  <svelte:fragment slot="buttons">
-    <Button type="text" on:click={() => (open = false)}>Cancel</Button>
-    <Button type="tonal" on:click={() => (open = false)}>Delete</Button>
-  </svelte:fragment>
-</Dialog>`} lang="xml" />
+  ${"<"}svelte:fragment slot="buttons">
+    ${"<"}Button type="text" on:click={() => (open = false)}>Cancel${"<"}/Button>
+    ${"<"}Button type="tonal" on:click={() => (open = false)}>Delete${"<"}/Button>
+  ${"<"}/svelte:fragment>
+${"<"}/Dialog>`} lang="xml" />
     </div>
     <div class="section">
       <h3>Snackbar</h3>
@@ -190,15 +190,15 @@
         <li>extraOptions: ComponentProps&lt;SnackbarItem&gt;</li>
       </ul>
       <h4>Examples</h4>
-      <Snippet code={`<script>
+      <Snippet code={`${"<"}script>
 let snackbar: (data: SnackbarIn) => void;
-</script>
-<Button on:click={() => snackbar({
+${"<"}/script>
+${"<"}Button on:click={() => snackbar({
   message: "Hello",
   actions: { Undo: () => {} },
   closable: true
-})}>Show</Button>
-<Snackbar bind:show={snackbar} />`} lang="xml" />
+})}>Show${"<"}/Button>
+${"<"}Snackbar bind:show={snackbar} />`} lang="xml" />
       <h4>Tips</h4>
       <p>Set the CSS variable `--m3-util-bottom-offset` to a size to move all snackbars upwards.</p>
     </div>
@@ -291,10 +291,10 @@ let snackbar: (data: SnackbarIn) => void;
         <li>default</li>
       </ul>
       <h4>Examples</h4>
-      <Snippet code={`<Menu>
-  <MenuItem icon={iconUndo}>Undo</MenuItem>
-  <MenuItem icon={iconRedo} disabled>Redo</MenuItem>
-</Menu>`} lang="xml" />
+      <Snippet code={`${"<"}Menu>
+  ${"<"}MenuItem icon={iconUndo}>Undo${"<"}/MenuItem>
+  ${"<"}MenuItem icon={iconRedo} disabled>Redo${"<"}/MenuItem>
+${"<"}/Menu>`} lang="xml" />
     </div>
     <div class="section">
       <h3>MenuItem</h3>
@@ -399,7 +399,7 @@ let snackbar: (data: SnackbarIn) => void;
         <li>disabled: boolean</li>
       </ul>
       <h4>Examples</h4>
-      <Snippet code={`<Switch bind:checked />`} lang="xml" />
+      <Snippet code={`${"<"}Switch bind:checked />`} lang="xml" />
     </div>
     <div class="section">
       <h3>Slider</h3>
@@ -416,8 +416,8 @@ let snackbar: (data: SnackbarIn) => void;
         <li>format: (n: number)</li>
       </ul>
       <h4>Examples</h4>
-      <Snippet code={`<Slider step="any" bind:value />
-<SliderTicks step={1} max={6} bind:value />`} lang="xml" />
+      <Snippet code={`${"<"}Slider step="any" bind:value />
+${"<"}SliderTicks step={1} max={6} bind:value />`} lang="xml" />
     </div>
     <div class="category">
       <h2 class="m3-font-headline-medium">Textfields</h2>
@@ -444,7 +444,7 @@ let snackbar: (data: SnackbarIn) => void;
         <li>value: string</li>
       </ul>
       <h4>Examples</h4>
-      <Snippet code={`<TextField
+      <Snippet code={`${"<"}TextField
   name="Field"
   leadingIcon={iconEdit}
   error={false}
@@ -604,7 +604,7 @@ let snackbar: (data: SnackbarIn) => void;
         <li>items: &#123;</li>
       </ul>
       <h4>Examples</h4>
-      <Snippet code={`<Tabs bind:tab secondary={false} items={[
+      <Snippet code={`${"<"}Tabs bind:tab secondary={false} items={[
   { name: "Tab 1", value: "tab1" },
   { name: "Tab 2", value: "tab2" }
 ]} />`} lang="xml" />
@@ -679,7 +679,7 @@ let snackbar: (data: SnackbarIn) => void;
         <li>extraOptions: HTMLInputAttributes</li>
       </ul>
       <h4>Examples</h4>
-      <Snippet code={`<DateField name="Date" bind:date />`} lang="xml" />
+      <Snippet code={`${"<"}DateField name="Date" bind:date />`} lang="xml" />
       <h4>Tips</h4>
       <p>This component is like DatePickerDocked but it has a field and it's easier to use</p>
     </div>