@carbon/icon-helpers 10.45.0 → 10.46.0-rc.0

package/es/getAttributes.d.ts

@@ -1,18 +1,15 @@
 /**
- * Copyright IBM Corp. 2018, 2023
+ * Copyright IBM Corp. 2018, 2024
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import React from 'react';
-interface IconAttributes extends Omit<React.SVGProps<React.ReactSVGElement>, 'tabIndex'> {
-    tabindex?: string | number | undefined;
-    title?: string | undefined;
-}
-export declare const defaultAttributes: IconAttributes;
+export declare const defaultAttributes: {
+    focusable: string;
+    preserveAspectRatio: string;
+};
 /**
  * Get supplementary HTML attributes for a given <svg> element based on existing
  * attributes.
  */
-export default function getAttributes({ width, height, viewBox, ...attributes }?: IconAttributes): IconAttributes;
-export {};
+export default function getAttributes({ width, height, viewBox, ...attributes }?: Record<string, unknown>): Record<string, unknown>;

package/es/index.js

@@ -78,7 +78,7 @@ function _toPropertyKey(arg) {
 var _excluded = ["width", "height", "viewBox"],
   _excluded2 = ["tabindex"];
 /**
- * Copyright IBM Corp. 2018, 2023
+ * Copyright IBM Corp. 2018, 2024
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
@@ -130,12 +130,11 @@ function getAttributes() {
 }
 
 /**
- * Copyright IBM Corp. 2018, 2023
+ * Copyright IBM Corp. 2018, 2024
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
  */
-
 /**
  * Convert an icon descriptor to a String
  */
@@ -163,12 +162,11 @@ function formatAttributes(attrs) {
 }
 
 /**
- * Copyright IBM Corp. 2018, 2023
+ * Copyright IBM Corp. 2018, 2024
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
  */
-
 /**
  * Convert an icon descriptor to a DOM node.
  */

package/es/toSVG.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright IBM Corp. 2018, 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import IconDescriptor from './types';
+/**
+ * Convert an icon descriptor to a DOM node.
+ */
+export default function toSVG(descriptor: IconDescriptor): SVGElement;

package/es/toString.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Copyright IBM Corp. 2018, 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import IconDescriptor from './types';
+/**
+ * Convert an icon descriptor to a String
+ */
+export default function toString(descriptor: IconDescriptor): string;
+export declare function formatAttributes(attrs: Record<string, unknown>): string;

package/es/types.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright IBM Corp. 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+export default interface IconDescriptor {
+    elem?: string;
+    attrs?: Record<string, string>;
+    content?: Array<IconDescriptor>;
+}

package/lib/getAttributes.d.ts

@@ -1,18 +1,15 @@
 /**
- * Copyright IBM Corp. 2018, 2023
+ * Copyright IBM Corp. 2018, 2024
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import React from 'react';
-interface IconAttributes extends Omit<React.SVGProps<React.ReactSVGElement>, 'tabIndex'> {
-    tabindex?: string | number | undefined;
-    title?: string | undefined;
-}
-export declare const defaultAttributes: IconAttributes;
+export declare const defaultAttributes: {
+    focusable: string;
+    preserveAspectRatio: string;
+};
 /**
  * Get supplementary HTML attributes for a given <svg> element based on existing
  * attributes.
  */
-export default function getAttributes({ width, height, viewBox, ...attributes }?: IconAttributes): IconAttributes;
-export {};
+export default function getAttributes({ width, height, viewBox, ...attributes }?: Record<string, unknown>): Record<string, unknown>;

package/lib/index.js

@@ -82,7 +82,7 @@ function _toPropertyKey(arg) {
 var _excluded = ["width", "height", "viewBox"],
   _excluded2 = ["tabindex"];
 /**
- * Copyright IBM Corp. 2018, 2023
+ * Copyright IBM Corp. 2018, 2024
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
@@ -134,12 +134,11 @@ function getAttributes() {
 }
 
 /**
- * Copyright IBM Corp. 2018, 2023
+ * Copyright IBM Corp. 2018, 2024
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
  */
-
 /**
  * Convert an icon descriptor to a String
  */
@@ -167,12 +166,11 @@ function formatAttributes(attrs) {
 }
 
 /**
- * Copyright IBM Corp. 2018, 2023
+ * Copyright IBM Corp. 2018, 2024
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
  */
-
 /**
  * Convert an icon descriptor to a DOM node.
  */

package/lib/toSVG.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright IBM Corp. 2018, 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import IconDescriptor from './types';
+/**
+ * Convert an icon descriptor to a DOM node.
+ */
+export default function toSVG(descriptor: IconDescriptor): SVGElement;

package/lib/toString.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Copyright IBM Corp. 2018, 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import IconDescriptor from './types';
+/**
+ * Convert an icon descriptor to a String
+ */
+export default function toString(descriptor: IconDescriptor): string;
+export declare function formatAttributes(attrs: Record<string, unknown>): string;

package/lib/types.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright IBM Corp. 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+export default interface IconDescriptor {
+    elem?: string;
+    attrs?: Record<string, string>;
+    content?: Array<IconDescriptor>;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@carbon/icon-helpers",
   "description": "Helpers used alongside icons for digital and software products using the Carbon Design System",
-  "version": "10.45.0",
+  "version": "10.46.0-rc.0",
   "license": "Apache-2.0",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -39,5 +39,5 @@
     "typescript-config-carbon": "^0.2.0"
   },
   "sideEffects": false,
-  "gitHead": "abe693e46a9b76731f51e47104f3634b6346f845"
+  "gitHead": "79048666dc3d8f66c3d64b46de45b25ce13d9adf"
 }

package/umd/getAttributes.d.ts

@@ -1,18 +1,15 @@
 /**
- * Copyright IBM Corp. 2018, 2023
+ * Copyright IBM Corp. 2018, 2024
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import React from 'react';
-interface IconAttributes extends Omit<React.SVGProps<React.ReactSVGElement>, 'tabIndex'> {
-    tabindex?: string | number | undefined;
-    title?: string | undefined;
-}
-export declare const defaultAttributes: IconAttributes;
+export declare const defaultAttributes: {
+    focusable: string;
+    preserveAspectRatio: string;
+};
 /**
  * Get supplementary HTML attributes for a given <svg> element based on existing
  * attributes.
  */
-export default function getAttributes({ width, height, viewBox, ...attributes }?: IconAttributes): IconAttributes;
-export {};
+export default function getAttributes({ width, height, viewBox, ...attributes }?: Record<string, unknown>): Record<string, unknown>;

package/umd/index.js

@@ -84,7 +84,7 @@
   var _excluded = ["width", "height", "viewBox"],
     _excluded2 = ["tabindex"];
   /**
-   * Copyright IBM Corp. 2018, 2023
+   * Copyright IBM Corp. 2018, 2024
    *
    * This source code is licensed under the Apache-2.0 license found in the
    * LICENSE file in the root directory of this source tree.
@@ -136,12 +136,11 @@
   }
 
   /**
-   * Copyright IBM Corp. 2018, 2023
+   * Copyright IBM Corp. 2018, 2024
    *
    * This source code is licensed under the Apache-2.0 license found in the
    * LICENSE file in the root directory of this source tree.
    */
-
   /**
    * Convert an icon descriptor to a String
    */
@@ -169,12 +168,11 @@
   }
 
   /**
-   * Copyright IBM Corp. 2018, 2023
+   * Copyright IBM Corp. 2018, 2024
    *
    * This source code is licensed under the Apache-2.0 license found in the
    * LICENSE file in the root directory of this source tree.
    */
-
   /**
    * Convert an icon descriptor to a DOM node.
    */

package/umd/toSVG.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright IBM Corp. 2018, 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import IconDescriptor from './types';
+/**
+ * Convert an icon descriptor to a DOM node.
+ */
+export default function toSVG(descriptor: IconDescriptor): SVGElement;

package/umd/toString.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Copyright IBM Corp. 2018, 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import IconDescriptor from './types';
+/**
+ * Convert an icon descriptor to a String
+ */
+export default function toString(descriptor: IconDescriptor): string;
+export declare function formatAttributes(attrs: Record<string, unknown>): string;

package/umd/types.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright IBM Corp. 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+export default interface IconDescriptor {
+    elem?: string;
+    attrs?: Record<string, string>;
+    content?: Array<IconDescriptor>;
+}