@carbon/icon-helpers 10.1.1 → 10.2.0

package/LICENSE

@@ -178,7 +178,7 @@
    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 "[]"
+      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
@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2018 IBM Corp.
+   Copyright 2015 IBM Corp.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/README.md

@@ -1,19 +1,19 @@
 # @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
 
-To install `@carbon/icon-helpers` in your project, you will need to
-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
@@ -21,8 +21,9 @@ yarn add @carbon/icon-helpers
 
 ## Usage
 
-`@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:
+`@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                                                                  |
 | ------------------ | --------------------------------- | ---------------------------------------------------------------------------- |
@@ -31,19 +32,18 @@ set on an `<svg>` node. These include:
 | `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:
+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:
+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');
@@ -55,9 +55,8 @@ const attributes = getAttributes({
 
 ### 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:
+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
 {
@@ -81,8 +80,8 @@ shape:
 }
 ```
 
-You can import these definitions directly from `@carbon/icons` and use
-them alongside `toSVG` or `toString` by doing:
+You can import these definitions directly from `@carbon/icons` and use them
+alongside `toSVG` or `toString` by doing:
 
 ```js
 import { IconName } from '@carbon/icons';
@@ -100,10 +99,9 @@ const iconSVG = toSVG({
 
 ## 🙌 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)
-! 👀
+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
 

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.1.1",
+  "version": "10.2.0",
   "license": "Apache-2.0",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -27,9 +27,9 @@
     "clean": "rimraf es lib umd"
   },
   "devDependencies": {
-    "@carbon/bundler": "10.1.1",
+    "@carbon/bundler": "10.2.0",
     "rimraf": "^2.6.2"
   },
   "sideEffects": false,
-  "gitHead": "0931cfcf4a7636d6e3f5aff3ab8d7d7f2d4ecb99"
+  "gitHead": "e71825a0cf44f6f41fee7d2b0dd9c57d7bda126a"
 }