docs(icons): External Lucide icons like from lab on lucide.dev (#2194)

* Add section title * Add external libs list in sidebar * Make external lib work * Adds external lib to detail view * fix lint issues * Update to https
2026-11-12 13:38:32 +00:00 · 2024-06-25 09:56:55 +02:00
parent f980863f6c
commit e11fa135a0
31 changed files with 835 additions and 64 deletions
@@ -0,0 +1,161 @@
+import { bundledLanguages, type ThemeRegistration } from 'shikiji';
+import { getHighlighter } from 'shikiji';
+
+type CodeExampleType = {
+  title: string;
+  language: string;
+  code: string;
+}[];
+
+const getIconCodes = (): CodeExampleType => {
+  return [
+    {
+      language: 'js',
+      title: 'Vanilla',
+      code: `\
+import { createIcons, icons } from 'lucide';
+import { $Name } from '@lucide/lab';
+
+createIcons({
+  icons: {
+    $Name
+  }
+});
+
+document.body.append('<i data-lucide="$Name"></i>');\
+  `,
+    },
+    {
+      language: 'tsx',
+      title: 'React',
+      code: `import { Icon } from 'lucide-react';
+import { $Name } from '@lucide/lab';
+
+const App = () => {
+  return (
+    <Icon iconNode={$Name} />
+  );
+};
+
+export default App;
+`,
+    },
+    {
+      language: 'vue',
+      title: 'Vue',
+      code: `<script setup>
+import { Icon } from 'lucide-vue-next';
+import { $Name } from '@lucide/lab';
+</script>
+
+<template>
+  <Icon :iconNode="burger" />
+</template>
+`,
+    },
+    {
+      language: 'svelte',
+      title: 'Svelte',
+      code: `<script>
+import { Icon } from 'lucide-svelte';
+import { $Name } from '@lucide/lab';
+</script>
+
+<Icon iconNode={burger} />
+`,
+    },
+    {
+      language: 'tsx',
+      title: 'Preact',
+      code: `import { Icon } from 'lucide-preact';
+import { $Name } from '@lucide/lab';
+
+const App = () => {
+  return (
+    <Icon iconNode={$Name} />
+  );
+};
+
+export default App;
+`,
+    },
+    {
+      language: 'tsx',
+      title: 'Solid',
+      code: `import { Icon } from 'lucide-solid';
+import { $Name } from '@lucide/lab';
+
+const App = () => {
+  return (
+    <Icon iconNode={$Name} />
+  );
+};
+
+export default App;
+`,
+    },
+    {
+      language: 'tsx',
+      title: 'Angular',
+      code: `// app.module.ts
+import { LucideAngularModule, $PascalCase } from 'lucide-angular';
+import { $Name } from '@lucide/lab';
+
+@NgModule({
+  imports: [
+    LucideAngularModule.pick({ $Name })
+  ],
+})
+
+// app.component.html
+<lucide-icon name="$Name"></lucide-icon>
+`,
+    },
+  ];
+};
+
+export type ThemeOptions =
+  | ThemeRegistration
+  | { light: ThemeRegistration; dark: ThemeRegistration };
+
+const highLightCode = async (code: string, lang: string, active?: boolean) => {
+  const highlighter = await getHighlighter({
+    themes: ['github-light', 'github-dark'],
+    langs: Object.keys(bundledLanguages),
+  });
+
+  const highlightedCode = highlighter
+    .codeToHtml(code, {
+      lang,
+      themes: {
+        light: 'github-light',
+        dark: 'github-dark',
+      },
+      defaultColor: false,
+    })
+    .replace('shiki-themes', 'shiki-themes vp-code');
+
+  return `<div class="language-${lang} ${active ? 'active' : ''}">
+  <button title="Copy Code" class="copy"></button>
+  <span class="lang">${lang}</span>
+  ${highlightedCode}
+  </div>`;
+};
+
+export default async function createCodeExamples() {
+  const codes = getIconCodes();
+
+  const codeExamplePromises = codes.map(async ({ title, language, code }, index) => {
+    const isFirst = index === 0;
+
+    const codeString = await highLightCode(code, language, isFirst);
+
+    return {
+      title,
+      language: language,
+      code: codeString,
+    };
+  });
+
+  return Promise.all(codeExamplePromises);
+}