@carbon/icon-helpers 0.0.1-alpha.9 → 0.0.1-beta.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2018 IBM Corp.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,22 +1,110 @@
-# `@carbon/icon-helpers`
+# @carbon/icon-helpers
 
-> Helpers used alongside icons for digital and software products using the Carbon Design System.
+> Helpers used alongside icons for digital and software products using
+> the Carbon Design System
 
-## Getting Started
+## Getting started
 
-Run the following command using [npm](https://www.npmjs.com/):
+To install `@carbon/icon-helpers` in your project, you will need to
+run the following command using [npm](https://www.npmjs.com/):
 
 ```bash
 npm install -S @carbon/icon-helpers
 ```
 
-If you prefer [Yarn](https://yarnpkg.com/en/), use the following command
-instead:
+If you prefer [Yarn](https://yarnpkg.com/en/), use the following
+command instead:
 
 ```bash
 yarn add @carbon/icon-helpers
 ```
 
-## 🤲 Contributing
+## Usage
 
-To learn more about how to contribute, look [here](/.github/CONTRIBUTING.md)!
+`@carbon/icon-helpers` provides a couple of helpers for rendering `<svg>` nodes in a document, or to help get the correct attributes to
+set on an `<svg>` node. These include:
+
+| Name               | Type                              | Description                                                                  |
+| ------------------ | --------------------------------- | ---------------------------------------------------------------------------- |
+| `getAttributes`    | `(attributes: Object) => Object`  | Get the attributes for an `<svg>` node                                       |
+| `formatAttributes` | `(attributes: Object) => String`  | Format the attributes into a string that can be applied to a node in the DOM |
+| `toString`         | `(descriptor: Object) => String`  | Format the given icon descriptor into a string. Useful for templates         |
+| `toSVG`            | `(descriptor: Object) => DOMNode` | Format the given icon descriptor into a DOM node                             |
+
+For most of the methods, `attributes` corresponds with whatever the
+name and value would be if you were writing the HTML for the `<svg>`.
+For example, if we wanted to set `width` and `height` we would do the
+following:
+
+```js
+const { getAttributes } = require('@carbon/icon-helpers');
+const attributes = getAttributes({ width: 20, height: 20 });
+```
+
+In order for the icon to be considered focusable, you will need to
+provide either `aria-label`, `aria-labelledby`, or `title` in the
+given `attributes` in addition to `tabindex`. For example:
+
+```js
+const { getAttributes } = require('@carbon/icon-helpers');
+const attributes = getAttributes({
+  'aria-label': 'My icon label',
+  tabindex: '0',
+});
+```
+
+### Icon descriptors
+
+An icon descriptor is the term we use to describe icon objects
+exported by `@carbon/icons`. By default, they will have the following
+shape:
+
+```js
+{
+  elem: 'svg',
+  attrs: {
+    xmlns: 'http://www.w3.org/2000/svg',
+    viewBox: '0 0 16 16',
+    width: 16,
+    height: 16,
+  },
+  content: [
+    {
+      elem: 'path',
+      attrs: {
+        d: '...',
+      },
+    },
+  ],
+  name: 'IconName',
+  size: 16,
+}
+```
+
+You can import these definitions directly from `@carbon/icons` and use
+them alongside `toSVG` or `toString` by doing:
+
+```js
+import { IconName } from '@carbon/icons';
+import { toString, toSVG } from '@carbon/icon-helpers';
+
+const iconString = toString(IconName);
+const iconSVG = toSVG({
+  ...IconName,
+  attrs: {
+    ...IconName.attrs,
+    myCustomAttribute: 'myCustomAttributeValue',
+  },
+});
+```
+
+## 🙌 Contributing
+
+We're always looking for contributors to help us fix bugs, build new
+features, or help us improve the project documentation. If you're
+interested, definitely check out our [Contributing Guide](/.github/CONTRIBUTING.md)
+! 👀
+
+## 📝 License
+
+Licensed under the [Apache 2.0 License](/LICENSE).

package/es/index.js

@@ -68,12 +68,22 @@ function _objectWithoutProperties(source, excluded) {
   return target;
 }
 
+/**
+ * Copyright IBM Corp. 2018, 2018
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
 var defaultAttributes = {
   // Reference:
   // https://github.com/IBM/carbon-components-react/issues/1392
   // https://github.com/PolymerElements/iron-iconset-svg/pull/47
-  focusable: false,
-  preserveAspectRatio: 'xMidYMid meet'
+  // `focusable` is a string attribute which is why we do not use a boolean here
+  focusable: 'false',
+  preserveAspectRatio: 'xMidYMid meet',
+  // Reference:
+  // https://github.com/ckeditor/ckeditor5/issues/668#issuecomment-344844027
+  style: 'will-change: transform;'
 };
 /**
  * Get supplementary HTML attributes for a given <svg> element based on existing
@@ -88,7 +98,10 @@ function getAttributes() {
       viewBox = _ref$viewBox === void 0 ? "0 0 ".concat(width, " ").concat(height) : _ref$viewBox,
       attributes = _objectWithoutProperties(_ref, ["width", "height", "viewBox"]);
 
-  var iconAttributes = _objectSpread({}, defaultAttributes, attributes, {
+  var tabindex = attributes.tabindex,
+      rest = _objectWithoutProperties(attributes, ["tabindex"]);
+
+  var iconAttributes = _objectSpread({}, defaultAttributes, rest, {
     width: width,
     height: height,
     viewBox: viewBox
@@ -96,9 +109,14 @@ function getAttributes() {
   // correctly set `aria-labelledby`.
 
 
-  if (attributes['aria-label'] || attributes['aria-labelledby'] || attributes.title) {
-    iconAttributes.role = 'img';
-    iconAttributes.focusable = true;
+  if (iconAttributes['aria-label'] || iconAttributes['aria-labelledby'] || iconAttributes.title) {
+    iconAttributes.role = 'img'; // Reference:
+    // https://allyjs.io/tutorials/focusing-in-svg.html
+
+    if (tabindex !== undefined && tabindex !== null) {
+      iconAttributes.focusable = 'true';
+      iconAttributes.tabindex = tabindex;
+    }
   } else {
     iconAttributes['aria-hidden'] = true;
   }
@@ -106,6 +124,12 @@ function getAttributes() {
   return iconAttributes;
 }
 
+/**
+ * Copyright IBM Corp. 2018, 2018
+ *
+ * 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
  */
@@ -137,6 +161,12 @@ function formatAttributes(attrs) {
   }, '');
 }
 
+/**
+ * Copyright IBM Corp. 2018, 2018
+ *
+ * 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.
  */
@@ -149,7 +179,8 @@ function toSVG(descriptor) {
       _descriptor$content = descriptor.content,
       content = _descriptor$content === void 0 ? [] : _descriptor$content;
   var node = document.createElementNS('http://www.w3.org/2000/svg', elem);
-  Object.keys(elem !== 'svg' ? attrs : getAttributes(attrs)).forEach(function (key) {
+  var attributes = elem !== 'svg' ? attrs : getAttributes(attrs);
+  Object.keys(attributes).forEach(function (key) {
     node.setAttribute(key, attrs[key]);
   });
 
@@ -160,4 +191,11 @@ function toSVG(descriptor) {
   return node;
 }
 
-export { getAttributes, toString, toSVG };
+/**
+ * Copyright IBM Corp. 2018, 2018
+ *
+ * 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 { defaultAttributes, getAttributes, formatAttributes, toString, toSVG };

package/lib/index.js

@@ -72,12 +72,22 @@ function _objectWithoutProperties(source, excluded) {
   return target;
 }
 
+/**
+ * Copyright IBM Corp. 2018, 2018
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
 var defaultAttributes = {
   // Reference:
   // https://github.com/IBM/carbon-components-react/issues/1392
   // https://github.com/PolymerElements/iron-iconset-svg/pull/47
-  focusable: false,
-  preserveAspectRatio: 'xMidYMid meet'
+  // `focusable` is a string attribute which is why we do not use a boolean here
+  focusable: 'false',
+  preserveAspectRatio: 'xMidYMid meet',
+  // Reference:
+  // https://github.com/ckeditor/ckeditor5/issues/668#issuecomment-344844027
+  style: 'will-change: transform;'
 };
 /**
  * Get supplementary HTML attributes for a given <svg> element based on existing
@@ -92,7 +102,10 @@ function getAttributes() {
       viewBox = _ref$viewBox === void 0 ? "0 0 ".concat(width, " ").concat(height) : _ref$viewBox,
       attributes = _objectWithoutProperties(_ref, ["width", "height", "viewBox"]);
 
-  var iconAttributes = _objectSpread({}, defaultAttributes, attributes, {
+  var tabindex = attributes.tabindex,
+      rest = _objectWithoutProperties(attributes, ["tabindex"]);
+
+  var iconAttributes = _objectSpread({}, defaultAttributes, rest, {
     width: width,
     height: height,
     viewBox: viewBox
@@ -100,9 +113,14 @@ function getAttributes() {
   // correctly set `aria-labelledby`.
 
 
-  if (attributes['aria-label'] || attributes['aria-labelledby'] || attributes.title) {
-    iconAttributes.role = 'img';
-    iconAttributes.focusable = true;
+  if (iconAttributes['aria-label'] || iconAttributes['aria-labelledby'] || iconAttributes.title) {
+    iconAttributes.role = 'img'; // Reference:
+    // https://allyjs.io/tutorials/focusing-in-svg.html
+
+    if (tabindex !== undefined && tabindex !== null) {
+      iconAttributes.focusable = 'true';
+      iconAttributes.tabindex = tabindex;
+    }
   } else {
     iconAttributes['aria-hidden'] = true;
   }
@@ -110,6 +128,12 @@ function getAttributes() {
   return iconAttributes;
 }
 
+/**
+ * Copyright IBM Corp. 2018, 2018
+ *
+ * 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
  */
@@ -141,6 +165,12 @@ function formatAttributes(attrs) {
   }, '');
 }
 
+/**
+ * Copyright IBM Corp. 2018, 2018
+ *
+ * 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.
  */
@@ -153,7 +183,8 @@ function toSVG(descriptor) {
       _descriptor$content = descriptor.content,
       content = _descriptor$content === void 0 ? [] : _descriptor$content;
   var node = document.createElementNS('http://www.w3.org/2000/svg', elem);
-  Object.keys(elem !== 'svg' ? attrs : getAttributes(attrs)).forEach(function (key) {
+  var attributes = elem !== 'svg' ? attrs : getAttributes(attrs);
+  Object.keys(attributes).forEach(function (key) {
     node.setAttribute(key, attrs[key]);
   });
 
@@ -164,6 +195,15 @@ function toSVG(descriptor) {
   return node;
 }
 
+/**
+ * Copyright IBM Corp. 2018, 2018
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+exports.defaultAttributes = defaultAttributes;
 exports.getAttributes = getAttributes;
+exports.formatAttributes = formatAttributes;
 exports.toString = toString;
 exports.toSVG = toSVG;

package/package.json

@@ -1,11 +1,24 @@
 {
   "name": "@carbon/icon-helpers",
-  "version": "0.0.1-alpha.9",
+  "description": "Helpers used alongside icons for digital and software products using the Carbon Design System",
+  "version": "0.0.1-beta.0",
+  "license": "Apache-2.0",
   "main": "lib/index.js",
   "module": "es/index.js",
-  "license": "Apache-2.0",
   "repository": "https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers",
   "bugs": "https://github.com/IBM/carbon-elements/issues",
+  "files": [
+    "es",
+    "lib",
+    "umd"
+  ],
+  "keywords": [
+    "ibm",
+    "elements",
+    "carbon",
+    "carbon-elements",
+    "carbon-design-system"
+  ],
   "publishConfig": {
     "access": "public"
   },
@@ -14,7 +27,9 @@
     "clean": "rimraf es lib umd"
   },
   "devDependencies": {
-    "@carbon/bundler": "0.0.1-alpha.9",
+    "@carbon/bundler": "0.0.1-beta.0",
     "rimraf": "^2.6.2"
-  }
+  },
+  "sideEffects": false,
+  "gitHead": "0e128739939b4d581420c598dbc795e4160a0352"
 }

package/umd/index.js

@@ -74,12 +74,22 @@
     return target;
   }
 
+  /**
+   * Copyright IBM Corp. 2018, 2018
+   *
+   * This source code is licensed under the Apache-2.0 license found in the
+   * LICENSE file in the root directory of this source tree.
+   */
   var defaultAttributes = {
     // Reference:
     // https://github.com/IBM/carbon-components-react/issues/1392
     // https://github.com/PolymerElements/iron-iconset-svg/pull/47
-    focusable: false,
-    preserveAspectRatio: 'xMidYMid meet'
+    // `focusable` is a string attribute which is why we do not use a boolean here
+    focusable: 'false',
+    preserveAspectRatio: 'xMidYMid meet',
+    // Reference:
+    // https://github.com/ckeditor/ckeditor5/issues/668#issuecomment-344844027
+    style: 'will-change: transform;'
   };
   /**
    * Get supplementary HTML attributes for a given <svg> element based on existing
@@ -94,7 +104,10 @@
         viewBox = _ref$viewBox === void 0 ? "0 0 ".concat(width, " ").concat(height) : _ref$viewBox,
         attributes = _objectWithoutProperties(_ref, ["width", "height", "viewBox"]);
 
-    var iconAttributes = _objectSpread({}, defaultAttributes, attributes, {
+    var tabindex = attributes.tabindex,
+        rest = _objectWithoutProperties(attributes, ["tabindex"]);
+
+    var iconAttributes = _objectSpread({}, defaultAttributes, rest, {
       width: width,
       height: height,
       viewBox: viewBox
@@ -102,9 +115,14 @@
     // correctly set `aria-labelledby`.
 
 
-    if (attributes['aria-label'] || attributes['aria-labelledby'] || attributes.title) {
-      iconAttributes.role = 'img';
-      iconAttributes.focusable = true;
+    if (iconAttributes['aria-label'] || iconAttributes['aria-labelledby'] || iconAttributes.title) {
+      iconAttributes.role = 'img'; // Reference:
+      // https://allyjs.io/tutorials/focusing-in-svg.html
+
+      if (tabindex !== undefined && tabindex !== null) {
+        iconAttributes.focusable = 'true';
+        iconAttributes.tabindex = tabindex;
+      }
     } else {
       iconAttributes['aria-hidden'] = true;
     }
@@ -112,6 +130,12 @@
     return iconAttributes;
   }
 
+  /**
+   * Copyright IBM Corp. 2018, 2018
+   *
+   * 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
    */
@@ -143,6 +167,12 @@
     }, '');
   }
 
+  /**
+   * Copyright IBM Corp. 2018, 2018
+   *
+   * 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.
    */
@@ -155,7 +185,8 @@
         _descriptor$content = descriptor.content,
         content = _descriptor$content === void 0 ? [] : _descriptor$content;
     var node = document.createElementNS('http://www.w3.org/2000/svg', elem);
-    Object.keys(elem !== 'svg' ? attrs : getAttributes(attrs)).forEach(function (key) {
+    var attributes = elem !== 'svg' ? attrs : getAttributes(attrs);
+    Object.keys(attributes).forEach(function (key) {
       node.setAttribute(key, attrs[key]);
     });
 
@@ -166,7 +197,16 @@
     return node;
   }
 
+  /**
+   * Copyright IBM Corp. 2018, 2018
+   *
+   * This source code is licensed under the Apache-2.0 license found in the
+   * LICENSE file in the root directory of this source tree.
+   */
+
+  exports.defaultAttributes = defaultAttributes;
   exports.getAttributes = getAttributes;
+  exports.formatAttributes = formatAttributes;
   exports.toString = toString;
   exports.toSVG = toSVG;
 

package/src/__tests__/getAttributes-test.js

@@ -1,32 +0,0 @@
-/**
- * @jest-environment jsdom
- */
-
-'use strict';
-
-describe('getAttributes', () => {
-  let getAttributes;
-
-  beforeEach(() => {
-    getAttributes = require('../getAttributes').default;
-  });
-
-  it('should default `aria-hidden="true"` and `focusable="false"` for SVGs', () => {
-    const attrs = getAttributes();
-    expect(attrs['aria-hidden']).toBe(true);
-    expect(attrs.focusable).toBe(false);
-    expect(attrs.role).not.toBeDefined();
-  });
-
-  test.each(['aria-label', 'aria-labelledby', 'title'])(
-    'should set role and remove aria-hidden if `%s` is set',
-    attr => {
-      const attrs = getAttributes({
-        [attr]: 'attribute',
-      });
-      expect(attrs.role).toBe('img');
-      expect(attrs.focusable).toBe(true);
-      expect(attrs['aria-hidden']).not.toBeDefined();
-    }
-  );
-});

package/src/__tests__/toSVG-test.js

@@ -1,48 +0,0 @@
-/**
- * @jest-environment jsdom
- */
-
-'use strict';
-
-const defaultDescriptor = {
-  name: 'default',
-  size: '32',
-  attrs: {
-    xmlns: 'http://www.w3.org/2000/svg',
-    viewBox: '0 0 32 32',
-    width: '32',
-    height: '32',
-  },
-  content: [
-    {
-      elem: 'path',
-      attrs: {
-        d:
-          'M12 11.03v4h-2v-4H8v6h4v4h2v-10h-2zm12.19 0H22l-3 4.39v-4.39h-2v10h2V18.3l.91-1.33L22 21.03h2.19l-2.99-5.62 2.99-4.38z',
-      },
-    },
-    {
-      elem: 'path',
-      attrs: {
-        d:
-          'M28 26H4a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h24a2 2 0 0 1 2 2v16a2 2 0 0 1-2 2zM4 8v16h24V8z',
-      },
-    },
-  ],
-};
-
-describe('toSVG', () => {
-  let toSVG;
-
-  beforeEach(() => {
-    toSVG = require('../toSVG').default;
-  });
-
-  it('should convert a given descriptor to a valid DOM node', () => {
-    expect(() => {
-      const node = toSVG(defaultDescriptor);
-      document.body.appendChild(node);
-      node.parentNode.removeChild(node);
-    }).not.toThrow();
-  });
-});

package/src/__tests__/toString-test.js

@@ -1,47 +0,0 @@
-/**
- * @jest-environment jsdom
- */
-
-'use strict';
-
-const defaultDescriptor = {
-  name: 'default',
-  size: '32',
-  attrs: {
-    xmlns: 'http://www.w3.org/2000/svg',
-    viewBox: '0 0 32 32',
-    width: '32',
-    height: '32',
-  },
-  content: [
-    {
-      elem: 'path',
-      attrs: {
-        d:
-          'M12 11.03v4h-2v-4H8v6h4v4h2v-10h-2zm12.19 0H22l-3 4.39v-4.39h-2v10h2V18.3l.91-1.33L22 21.03h2.19l-2.99-5.62 2.99-4.38z',
-      },
-    },
-    {
-      elem: 'path',
-      attrs: {
-        d:
-          'M28 26H4a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h24a2 2 0 0 1 2 2v16a2 2 0 0 1-2 2zM4 8v16h24V8z',
-      },
-    },
-  ],
-};
-
-describe('toString', () => {
-  let toString;
-
-  beforeEach(() => {
-    toString = require('../toString').default;
-  });
-
-  it('should convert a given descriptor to a string', () => {
-    expect(() => {
-      toString(defaultDescriptor);
-    }).not.toThrow();
-    expect(typeof toString(defaultDescriptor)).toBe('string');
-  });
-});

package/src/getAttributes.js

@@ -1,41 +0,0 @@
-const defaultAttributes = {
-  // Reference:
-  // https://github.com/IBM/carbon-components-react/issues/1392
-  // https://github.com/PolymerElements/iron-iconset-svg/pull/47
-  focusable: false,
-  preserveAspectRatio: 'xMidYMid meet',
-};
-
-/**
- * Get supplementary HTML attributes for a given <svg> element based on existing
- * attributes.
- */
-export default function getAttributes({
-  width,
-  height,
-  viewBox = `0 0 ${width} ${height}`,
-  ...attributes
-} = {}) {
-  const iconAttributes = {
-    ...defaultAttributes,
-    ...attributes,
-    width,
-    height,
-    viewBox,
-  };
-
-  // TODO: attributes.title assumes that the consumer will implement <title> and
-  // correctly set `aria-labelledby`.
-  if (
-    attributes['aria-label'] ||
-    attributes['aria-labelledby'] ||
-    attributes.title
-  ) {
-    iconAttributes.role = 'img';
-    iconAttributes.focusable = true;
-  } else {
-    iconAttributes['aria-hidden'] = true;
-  }
-
-  return iconAttributes;
-}

package/src/index.js

@@ -1,5 +0,0 @@
-import getAttributes from './getAttributes';
-import toString from './toString';
-import toSVG from './toSVG';
-
-export { getAttributes, toString, toSVG };

package/src/toSVG.js

@@ -1,19 +0,0 @@
-import getAttributes from './getAttributes';
-
-/**
- * Convert an icon descriptor to a DOM node.
- */
-export default function toSVG(descriptor) {
-  const { elem = 'svg', attrs = {}, content = [] } = descriptor;
-  const node = document.createElementNS('http://www.w3.org/2000/svg', elem);
-
-  Object.keys(elem !== 'svg' ? attrs : getAttributes(attrs)).forEach(key => {
-    node.setAttribute(key, attrs[key]);
-  });
-
-  for (let i = 0; i < content.length; i++) {
-    node.appendChild(toSVG(content[i]));
-  }
-
-  return node;
-}

package/src/toString.js

@@ -1,25 +0,0 @@
-import getAttributes from './getAttributes';
-
-/**
- * Convert an icon descriptor to a String
- */
-export default function toString(descriptor) {
-  const { elem = 'svg', attrs = {}, content = [] } = descriptor;
-  const children = content.map(toString).join('');
-  if (elem !== 'svg') {
-    return `<${elem} ${formatAttributes(attrs)}>${children}</${elem}>`;
-  }
-  return `<${elem} ${formatAttributes(
-    getAttributes(attrs)
-  )}>${children}</${elem}>`;
-}
-
-export function formatAttributes(attrs) {
-  return Object.keys(attrs).reduce((acc, key, index) => {
-    const attribute = `${key}="${attrs[key]}"`;
-    if (index === 0) {
-      return attribute;
-    }
-    return acc + ' ' + attribute;
-  }, '');
-}