@2hoch1/pixel-icon-library-react 2.0.0 → 2.0.1

package/README.md

@@ -124,11 +124,14 @@ function Icon({ name, ...props }) {
 
 ### [2.0.0]
 
-Removed the `variant` concept; icons now resolve purely by name. The `variant` prop on `PixelIcon` and `DynamicPixelIcon` is gone, along with the `IconVariant`, `RegularIconName`, and `SolidIconName` type exports. Pass the full icon name instead: solid icons end in `-solid` (`heart-solid`), brand and category icons use their plain name (`github`, `business`).
+Removed the `variant` concept; icons now resolve purely by name, along with the `IconVariant`, `RegularIconName`, and `SolidIconName` type exports. The `variant` prop on `PixelIcon` and `DynamicPixelIcon` is deprecated. Pass the full icon name instead: solid icons end in `-solid` (`heart-solid`), brand and category icons use their plain name (`github`, `business`).
 
 ```diff
 - <PixelIcon name="heart" variant="solid" />
 + <PixelIcon name="heart-solid" />
+
+- <DynamicPixelIcon name="heart" variant="solid" />
++ <DynamicPixelIcon name="heart-solid" />
 ```
 
 ## Credits

package/dist/index.cjs

@@ -587,16 +587,30 @@ var jsxRuntime = require('react/jsx-runtime');
 function resolveIconName(name) {
   return chunkYUI4KOHQ_cjs.dynamicIconImports_default[name] ? name : void 0;
 }
+
+// src/utils/warnOnce.ts
+var warned = /* @__PURE__ */ new Set();
+function warnOnce(message) {
+  if (typeof process !== "undefined" && process.env?.["NODE_ENV"] === "production") return;
+  if (warned.has(message)) return;
+  warned.add(message);
+  console.warn(message);
+}
 var DEFAULT_SIZE = 24;
+var VARIANT_DEPRECATION_MESSAGE = '[pixel-icon-library-react] The `variant` prop was removed in v2.0.0 and is ignored. Icons resolve by name only: use the full name (solid icons end in `-solid`), e.g. <PixelIcon name="heart-solid" /> instead of <PixelIcon name="heart" variant="solid" />.';
 function PixelIcon({
   name,
   size = DEFAULT_SIZE,
   title,
   fallback = null,
+  variant,
   ...rest
 }) {
   const [IconComponent, setIconComponent] = react.useState();
   const resolvedName = react.useMemo(() => resolveIconName(name), [name]);
+  react.useEffect(() => {
+    if (variant !== void 0) warnOnce(VARIANT_DEPRECATION_MESSAGE);
+  }, [variant]);
   react.useEffect(() => {
     let cancelled = false;
     if (!resolvedName) {
@@ -633,15 +647,20 @@ function PixelIcon({
 }
 var lazyCache = /* @__PURE__ */ new Map();
 var DEFAULT_SIZE2 = 24;
+var VARIANT_DEPRECATION_MESSAGE2 = '[pixel-icon-library-react] The `variant` prop was removed in v2.0.0 and is ignored. Icons resolve by name only: use the full name (solid icons end in `-solid`), e.g. <DynamicPixelIcon name="heart-solid" /> instead of <DynamicPixelIcon name="heart" variant="solid" />.';
 var DynamicPixelIcon = ({
   name,
   size = DEFAULT_SIZE2,
   title,
   fallback = null,
+  variant,
   ...props
 }) => {
   const dimension = typeof size === "number" ? `${size}px` : size ?? `${DEFAULT_SIZE2}px`;
   const resolvedName = react.useMemo(() => resolveIconName(name), [name]);
+  react.useEffect(() => {
+    if (variant !== void 0) warnOnce(VARIANT_DEPRECATION_MESSAGE2);
+  }, [variant]);
   const LazyIcon = react.useMemo(() => {
     if (!resolvedName) return void 0;
     if (lazyCache.has(resolvedName)) return lazyCache.get(resolvedName);

package/dist/index.d.cts

@@ -586,6 +586,12 @@ type PixelIconProps = SVGProps<SVGSVGElement> & {
     size?: number | string;
     title?: string;
     fallback?: ReactNode;
+    /**
+     * @deprecated Removed in v2.0.0 and ignored. Icons now resolve purely by name:
+     * pass the full name instead, e.g. `name="heart-solid"` rather than
+     * `name="heart" variant="solid"`.
+     */
+    variant?: 'regular' | 'solid';
 };
 /**
  * Resolves and renders a pixel icon by dynamically importing its module at runtime.
@@ -599,13 +605,19 @@ type PixelIconProps = SVGProps<SVGSVGElement> & {
  * @param props.title - Accessible label rendered as an SVG `<title>` element.
  * @param props.fallback - React node shown while the icon is loading. Defaults to null.
  */
-declare function PixelIcon({ name, size, title, fallback, ...rest }: PixelIconProps): string | number | boolean | react_jsx_runtime.JSX.Element | Iterable<ReactNode> | null;
+declare function PixelIcon({ name, size, title, fallback, variant, ...rest }: PixelIconProps): string | number | boolean | react_jsx_runtime.JSX.Element | Iterable<ReactNode> | null;
 
 interface DynamicPixelIconProps extends Omit<SVGProps<SVGSVGElement>, 'ref'> {
     name: IconName;
     size?: number | string;
     title?: string;
     fallback?: ReactNode;
+    /**
+     * @deprecated Removed in v2.0.0 and ignored. Icons now resolve purely by name:
+     * pass the full name instead, e.g. `name="heart-solid"` rather than
+     * `name="heart" variant="solid"`.
+     */
+    variant?: 'regular' | 'solid';
 }
 /**
  * Lazy-loads icon components on demand using `React.lazy` and `Suspense` for
@@ -619,7 +631,7 @@ interface DynamicPixelIconProps extends Omit<SVGProps<SVGSVGElement>, 'ref'> {
  * @param props.title - Accessible label rendered as an SVG `<title>` element.
  * @param props.fallback - React node shown while the icon chunk is loading. Defaults to null.
  */
-declare const DynamicPixelIcon: ({ name, size, title, fallback, ...props }: DynamicPixelIconProps) => string | number | boolean | react_jsx_runtime.JSX.Element | Iterable<ReactNode> | null;
+declare const DynamicPixelIcon: ({ name, size, title, fallback, variant, ...props }: DynamicPixelIconProps) => string | number | boolean | react_jsx_runtime.JSX.Element | Iterable<ReactNode> | null;
 
 /**
  * Minimal SVG element names supported by the icon set.

package/dist/index.d.ts

@@ -586,6 +586,12 @@ type PixelIconProps = SVGProps<SVGSVGElement> & {
     size?: number | string;
     title?: string;
     fallback?: ReactNode;
+    /**
+     * @deprecated Removed in v2.0.0 and ignored. Icons now resolve purely by name:
+     * pass the full name instead, e.g. `name="heart-solid"` rather than
+     * `name="heart" variant="solid"`.
+     */
+    variant?: 'regular' | 'solid';
 };
 /**
  * Resolves and renders a pixel icon by dynamically importing its module at runtime.
@@ -599,13 +605,19 @@ type PixelIconProps = SVGProps<SVGSVGElement> & {
  * @param props.title - Accessible label rendered as an SVG `<title>` element.
  * @param props.fallback - React node shown while the icon is loading. Defaults to null.
  */
-declare function PixelIcon({ name, size, title, fallback, ...rest }: PixelIconProps): string | number | boolean | react_jsx_runtime.JSX.Element | Iterable<ReactNode> | null;
+declare function PixelIcon({ name, size, title, fallback, variant, ...rest }: PixelIconProps): string | number | boolean | react_jsx_runtime.JSX.Element | Iterable<ReactNode> | null;
 
 interface DynamicPixelIconProps extends Omit<SVGProps<SVGSVGElement>, 'ref'> {
     name: IconName;
     size?: number | string;
     title?: string;
     fallback?: ReactNode;
+    /**
+     * @deprecated Removed in v2.0.0 and ignored. Icons now resolve purely by name:
+     * pass the full name instead, e.g. `name="heart-solid"` rather than
+     * `name="heart" variant="solid"`.
+     */
+    variant?: 'regular' | 'solid';
 }
 /**
  * Lazy-loads icon components on demand using `React.lazy` and `Suspense` for
@@ -619,7 +631,7 @@ interface DynamicPixelIconProps extends Omit<SVGProps<SVGSVGElement>, 'ref'> {
  * @param props.title - Accessible label rendered as an SVG `<title>` element.
  * @param props.fallback - React node shown while the icon chunk is loading. Defaults to null.
  */
-declare const DynamicPixelIcon: ({ name, size, title, fallback, ...props }: DynamicPixelIconProps) => string | number | boolean | react_jsx_runtime.JSX.Element | Iterable<ReactNode> | null;
+declare const DynamicPixelIcon: ({ name, size, title, fallback, variant, ...props }: DynamicPixelIconProps) => string | number | boolean | react_jsx_runtime.JSX.Element | Iterable<ReactNode> | null;
 
 /**
  * Minimal SVG element names supported by the icon set.

package/dist/index.js

@@ -586,16 +586,30 @@ import { jsx } from 'react/jsx-runtime';
 function resolveIconName(name) {
   return dynamicIconImports_default[name] ? name : void 0;
 }
+
+// src/utils/warnOnce.ts
+var warned = /* @__PURE__ */ new Set();
+function warnOnce(message) {
+  if (typeof process !== "undefined" && process.env?.["NODE_ENV"] === "production") return;
+  if (warned.has(message)) return;
+  warned.add(message);
+  console.warn(message);
+}
 var DEFAULT_SIZE = 24;
+var VARIANT_DEPRECATION_MESSAGE = '[pixel-icon-library-react] The `variant` prop was removed in v2.0.0 and is ignored. Icons resolve by name only: use the full name (solid icons end in `-solid`), e.g. <PixelIcon name="heart-solid" /> instead of <PixelIcon name="heart" variant="solid" />.';
 function PixelIcon({
   name,
   size = DEFAULT_SIZE,
   title,
   fallback = null,
+  variant,
   ...rest
 }) {
   const [IconComponent, setIconComponent] = useState();
   const resolvedName = useMemo(() => resolveIconName(name), [name]);
+  useEffect(() => {
+    if (variant !== void 0) warnOnce(VARIANT_DEPRECATION_MESSAGE);
+  }, [variant]);
   useEffect(() => {
     let cancelled = false;
     if (!resolvedName) {
@@ -632,15 +646,20 @@ function PixelIcon({
 }
 var lazyCache = /* @__PURE__ */ new Map();
 var DEFAULT_SIZE2 = 24;
+var VARIANT_DEPRECATION_MESSAGE2 = '[pixel-icon-library-react] The `variant` prop was removed in v2.0.0 and is ignored. Icons resolve by name only: use the full name (solid icons end in `-solid`), e.g. <DynamicPixelIcon name="heart-solid" /> instead of <DynamicPixelIcon name="heart" variant="solid" />.';
 var DynamicPixelIcon = ({
   name,
   size = DEFAULT_SIZE2,
   title,
   fallback = null,
+  variant,
   ...props
 }) => {
   const dimension = typeof size === "number" ? `${size}px` : size ?? `${DEFAULT_SIZE2}px`;
   const resolvedName = useMemo(() => resolveIconName(name), [name]);
+  useEffect(() => {
+    if (variant !== void 0) warnOnce(VARIANT_DEPRECATION_MESSAGE2);
+  }, [variant]);
   const LazyIcon = useMemo(() => {
     if (!resolvedName) return void 0;
     if (lazyCache.has(resolvedName)) return lazyCache.get(resolvedName);

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package",
   "name": "@2hoch1/pixel-icon-library-react",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "React wrapper for the HackerNoon Pixel Icon Library.",
   "license": "MIT",
   "type": "module",