@feathericons/core 0.0.0-stage → 0.2.0

package/README.md

@@ -1,3 +1,32 @@
-# Temporary Holding Version
+# @feathericons/core
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Icon catalog for [Feather](../..).
+
+## Install
+
+```sh
+pnpm add @feathericons/core
+```
+
+The published package is ESM in `dist/index.js` with types in `dist/index.d.ts`.
+
+## Usage
+
+```ts
+import { ICON_AXES, getVariant, icons } from '@feathericons/core'
+
+ICON_AXES
+// {
+//   weight: ['thin', 'extralight', 'light', 'regular', 'medium', 'semibold', 'bold'],
+//   roundness: ['none', 'small', 'medium', 'large'],
+// }
+
+icons
+// [{ name, keywords, variants: [{ axes, grid, bounds, contents }, ...] }, ...]
+
+getVariant(icons[0], { weight: 'bold', roundness: 'large' })
+// { axes, grid, bounds, contents }
+
+getVariant(icons[0], { weight: 'bold' })
+// Axes you leave out use ICON_AXIS_DEFAULTS
+```

package/dist/axes.d.ts

@@ -0,0 +1,8 @@
+export declare const ICON_AXES: {
+    readonly weight: readonly ["thin", "extralight", "light", "regular", "medium", "semibold", "bold"];
+    readonly roundness: readonly ["none", "small", "medium", "large"];
+};
+export declare const ICON_AXIS_DEFAULTS: {
+    readonly weight: "regular";
+    readonly roundness: "medium";
+};

package/dist/axes.js

@@ -0,0 +1,8 @@
+export const ICON_AXES = {
+    "weight": ["thin", "extralight", "light", "regular", "medium", "semibold", "bold"],
+    "roundness": ["none", "small", "medium", "large"]
+};
+export const ICON_AXIS_DEFAULTS = {
+    "weight": "regular",
+    "roundness": "medium"
+};

package/dist/entries.d.ts

@@ -0,0 +1,4 @@
+import type { IconAxes } from './types.js';
+export declare function iconExportName(kebab: string): string;
+export declare function entryPointId(axes: IconAxes): string;
+export declare function entryPointIds(): readonly string[];

package/dist/entries.js

@@ -0,0 +1,28 @@
+import { ICON_AXES } from './axes.js';
+export function iconExportName(kebab) {
+    return `${kebab
+        .split('-')
+        .map((part) => part.charAt(0).toUpperCase() + part.slice(1))
+        .join('')}Icon`;
+}
+export function entryPointId(axes) {
+    return Object.keys(ICON_AXES)
+        .map((key) => `${key}-${axes[key]}`)
+        .join('_');
+}
+export function entryPointIds() {
+    const keys = Object.keys(ICON_AXES);
+    const ids = [];
+    const walk = (depth, parts) => {
+        if (depth === keys.length) {
+            ids.push(parts.join('_'));
+            return;
+        }
+        const key = keys[depth];
+        for (const value of ICON_AXES[key]) {
+            walk(depth + 1, [...parts, `${key}-${value}`]);
+        }
+    };
+    walk(0, []);
+    return ids;
+}

package/dist/generated.d.ts

@@ -0,0 +1,2 @@
+import type { Icon } from './types.js';
+export declare const icons: readonly Icon[];