gdsi 0.0.1 → 0.1.0

package/README.md

@@ -1,4 +1,15 @@
 # Geist Design System Icons
+Geist design system icons maintained by the community.
+
+> [!IMPORTANT]
+> This project is purely out of personal love for `Geist Design System` and does not involve any commercial nature. If you are offended, please contact me and I will deal with it as soon as possible.
+
+## Feature
+- Complete tree-shaking support
+- Cross-framework support. (vue/react/vanilla)
+- Auto import component
+- Auto import component dts type(`coming`)
+- More...
 
 ## Install
 ```sh
@@ -9,7 +20,38 @@ npm i gdsi
 
 ## Usage
 
-### Vanilla(native)
+### Auto Import
+use `unplugin-vue-components` to auto import icons.
+> `react` please use `unplugin-auto-import` to auto import icons.
+
+```ts
+import IconResolver from 'gdsi/resolver'
+import vueComponent from 'unplugin-vue-components/vite'
+import { defineConfig } from 'vite'
+
+export default defineConfig({
+  plugins: [
+    vueComponent({
+      resolvers: [
+        IconResolver({
+          type: 'vue', // 'vue' | 'react' | 'vanilla'
+          prefix: 'Gsd', // default 'Gsd'
+        })
+      ],
+    }),
+  ],
+})
+```
+
+```vue
+<template>
+  <div>
+    <AccessibilityIcon />
+  </div>
+</template>
+```
+
+### Vanilla(nativeJS)
 
 ```ts
 import { AccessibilityIcon } from 'gdsi'
@@ -34,7 +76,7 @@ import { AccessibilityIcon } from 'gdsi/vue'
 ```
 
 ### React
-```ts
+```tsx
 import { AccessibilityIcon } from 'gdsi/react'
 
 export default function App() {
@@ -45,3 +87,25 @@ export default function App() {
   )
 }
 ```
+
+### Raw SVG
+
+```ts
+import svgIconRaw from 'gdsi/svg/accessibility.svg?raw'
+
+console.log(svgIconRaw)
+```
+
+### Full
+Note that this method may lead to a large build volume, because it can't do tree-shaking.
+
+```ts
+import fullIcons from 'gdsi/icons'
+
+console.log(fullIcons)
+```
+
+## TODO
+- [ ] auto import component dts type
+- [ ] React auto import component dts type
+- [ ] React component attributes type

package/dist/icons.d.ts

@@ -0,0 +1,2 @@
+import { default as cachedIcons } from '../scripts/_cached.json';
+export default cachedIcons;