@web-portfolio/icons-sanity 1.0.0 → 1.0.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 (6) hide show
  1. package/README.md +35 -5
  2. package/dist/index.cjs +28 -7415
  3. package/dist/index.d.cts +8 -5
  4. package/dist/index.d.ts +8 -5
  5. package/dist/index.js +28 -7399
  6. package/package.json +7 -3
package/dist/index.d.cts CHANGED
@@ -8,16 +8,19 @@ declare const iconRef: {
8
8
  } & Omit<sanity.StringDefinition, "preview">;
9
9
 
10
10
  /**
11
- * The shape of one registry entry, redeclared here rather than re-exported
11
+ * The shape of one metadata entry, redeclared here rather than re-exported
12
12
  * from icons-core. icons-core is private and unpublished, so any reference to
13
13
  * it that survives into dist/*.d.ts is a type import consumers cannot resolve.
14
- * Structurally identical to icons-core's `RegistryEntry` — and the picker
15
- * passes real registry entries to the functions below, so a drift in the
14
+ * Structurally identical to icons-core's `IconMetadata` — and the picker
15
+ * passes real metadata entries to the functions below, so a drift in the
16
16
  * fields this actually uses fails typecheck at those call sites.
17
+ *
18
+ * Rendering (viewBox/innerHTML) isn't part of this shape at all: the picker
19
+ * delegates actual icon markup to `@web-portfolio/icons`'s `<Icon>` rather
20
+ * than reading SVG data out of icons-core directly, so this package never
21
+ * needs to bundle it.
17
22
  */
18
23
  interface IconEntry {
19
- viewBox: string;
20
- innerHTML: string;
21
24
  label: string;
22
25
  tags: string[];
23
26
  category: string | null;
package/dist/index.d.ts CHANGED
@@ -8,16 +8,19 @@ declare const iconRef: {
8
8
  } & Omit<sanity.StringDefinition, "preview">;
9
9
 
10
10
  /**
11
- * The shape of one registry entry, redeclared here rather than re-exported
11
+ * The shape of one metadata entry, redeclared here rather than re-exported
12
12
  * from icons-core. icons-core is private and unpublished, so any reference to
13
13
  * it that survives into dist/*.d.ts is a type import consumers cannot resolve.
14
- * Structurally identical to icons-core's `RegistryEntry` — and the picker
15
- * passes real registry entries to the functions below, so a drift in the
14
+ * Structurally identical to icons-core's `IconMetadata` — and the picker
15
+ * passes real metadata entries to the functions below, so a drift in the
16
16
  * fields this actually uses fails typecheck at those call sites.
17
+ *
18
+ * Rendering (viewBox/innerHTML) isn't part of this shape at all: the picker
19
+ * delegates actual icon markup to `@web-portfolio/icons`'s `<Icon>` rather
20
+ * than reading SVG data out of icons-core directly, so this package never
21
+ * needs to bundle it.
17
22
  */
18
23
  interface IconEntry {
19
- viewBox: string;
20
- innerHTML: string;
21
24
  label: string;
22
25
  tags: string[];
23
26
  category: string | null;