@carbon/icon-helpers 10.0.0-rc.0 → 10.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/CHANGELOG.md +356 -0
  2. package/LICENSE +2 -2
  3. package/README.md +22 -24
  4. package/package.json +3 -3
package/CHANGELOG.md ADDED
@@ -0,0 +1,356 @@
1
+ # Change Log
2
+
3
+ All notable changes to this project will be documented in this file.
4
+ See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
+
6
+ ## [10.1.1](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v10.1.0...v10.1.1) (2019-04-13)
7
+
8
+ **Note:** Version bump only for package @carbon/icon-helpers
9
+
10
+
11
+
12
+
13
+
14
+ # 10.1.0 (2019-04-12)
15
+
16
+
17
+
18
+ # 10.0.0 (2019-03-29)
19
+
20
+
21
+
22
+ # 10.0.0-rc.0 (2019-03-27)
23
+
24
+
25
+
26
+ ## 0.0.1-beta.5 (2019-03-25)
27
+
28
+
29
+
30
+ ## 0.0.1-beta.4 (2019-03-22)
31
+
32
+
33
+
34
+ ## 0.0.1-beta.3 (2019-03-22)
35
+
36
+
37
+
38
+ ## 0.0.1-beta.2 (2019-03-19)
39
+
40
+
41
+
42
+ ## 0.0.1-beta.1 (2019-03-13)
43
+
44
+
45
+
46
+ ## 0.0.1-beta.0 (2019-03-07)
47
+
48
+
49
+
50
+ ## 0.0.1-alpha.32 (2019-02-12)
51
+
52
+
53
+
54
+ ## 0.0.1-alpha.31 (2019-01-28)
55
+
56
+
57
+
58
+ ## 0.0.1-alpha.30 (2019-01-22)
59
+
60
+
61
+
62
+ ## 0.0.1-alpha.29 (2019-01-14)
63
+
64
+
65
+
66
+ ## 0.0.1-alpha.28 (2019-01-11)
67
+
68
+
69
+
70
+ ## 0.0.1-alpha.27 (2019-01-10)
71
+
72
+
73
+
74
+ ## 0.0.1-alpha.26 (2018-12-13)
75
+
76
+
77
+ ### Bug Fixes
78
+
79
+ * **icon-helpers:** change style property ([#172](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/issues/172)) ([e33ba76](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/commit/e33ba76))
80
+
81
+
82
+
83
+ ## 0.0.1-alpha.25 (2018-12-11)
84
+
85
+
86
+ ### Bug Fixes
87
+
88
+ * **icons:** fix icon blurriness in Firefox Quantum ([#139](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/issues/139)) ([c826e08](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/commit/c826e08))
89
+
90
+
91
+
92
+ ## 0.0.1-alpha.24 (2018-12-07)
93
+
94
+
95
+ ### Bug Fixes
96
+
97
+ * **icon-helpers:** use attributes correctly in toSVG ([#126](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/issues/126)) ([7d2d6ea](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/commit/7d2d6ea))
98
+
99
+
100
+
101
+ ## 0.0.1-alpha.23 (2018-12-06)
102
+
103
+
104
+
105
+ ## 0.0.1-alpha.22 (2018-12-04)
106
+
107
+
108
+
109
+ ## 0.0.1-alpha.21 (2018-12-04)
110
+
111
+
112
+ ### Features
113
+
114
+ * **icons-vue:** add @carbon/icons-vue package ([#60](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/issues/60)) ([8ac5c05](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/commit/8ac5c05))
115
+
116
+
117
+
118
+ ## 0.0.1-alpha.20 (2018-11-29)
119
+
120
+
121
+
122
+ ## 0.0.1-alpha.19 (2018-11-29)
123
+
124
+
125
+
126
+ ## 0.0.1-alpha.18 (2018-11-28)
127
+
128
+
129
+ ### Bug Fixes
130
+
131
+ * **icons-react:** fix prop-type for focusable ([#90](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/issues/90)) ([9ee6e38](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/commit/9ee6e38))
132
+
133
+
134
+
135
+ ## 0.0.1-alpha.17 (2018-11-25)
136
+
137
+
138
+
139
+ ## 0.0.1-alpha.16 (2018-11-21)
140
+
141
+
142
+
143
+ ## 0.0.1-alpha.15 (2018-11-21)
144
+
145
+
146
+
147
+ ## 0.0.1-alpha.14 (2018-11-20)
148
+
149
+
150
+
151
+ ## 0.0.1-alpha.13 (2018-11-19)
152
+
153
+
154
+ ### Features
155
+
156
+ * **icon-helpers:** export formatAttributes ([#84](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/issues/84)) ([b99e88d](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/commit/b99e88d)), closes [IBM/carbon-components#1452](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/issues/1452)
157
+
158
+
159
+
160
+ ## 0.0.1-alpha.12 (2018-11-18)
161
+
162
+
163
+
164
+ ## 0.0.1-alpha.11 (2018-11-18)
165
+
166
+
167
+
168
+ ## 0.0.1-alpha.10 (2018-11-18)
169
+
170
+
171
+
172
+ ## 0.0.1-alpha.9 (2018-11-18)
173
+
174
+
175
+
176
+ ## 0.0.1-alpha.8 (2018-11-18)
177
+
178
+
179
+
180
+ ## 0.0.1-alpha.7 (2018-11-14)
181
+
182
+
183
+
184
+ ## 0.0.1-alpha.5 (2018-11-14)
185
+
186
+
187
+
188
+
189
+
190
+ # [10.0.0](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v10.0.0-rc.0...v10.0.0) (2019-03-29)
191
+
192
+
193
+
194
+ # [10.0.0-rc.0](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-beta.5...v10.0.0-rc.0) (2019-03-27)
195
+
196
+
197
+
198
+ ## [0.0.1-beta.5](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-beta.4...v0.0.1-beta.5) (2019-03-25)
199
+
200
+
201
+
202
+ ## [0.0.1-beta.4](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-beta.3...v0.0.1-beta.4) (2019-03-22)
203
+
204
+
205
+
206
+ ## [0.0.1-beta.3](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-beta.2...v0.0.1-beta.3) (2019-03-22)
207
+
208
+
209
+
210
+ ## [0.0.1-beta.2](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-beta.1...v0.0.1-beta.2) (2019-03-19)
211
+
212
+
213
+
214
+ ## [0.0.1-beta.1](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-beta.0...v0.0.1-beta.1) (2019-03-13)
215
+
216
+
217
+
218
+ ## [0.0.1-beta.0](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-alpha.32...v0.0.1-beta.0) (2019-03-07)
219
+
220
+
221
+
222
+ ## [0.0.1-alpha.32](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-alpha.31...v0.0.1-alpha.32) (2019-02-12)
223
+
224
+
225
+
226
+ ## [0.0.1-alpha.31](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-alpha.30...v0.0.1-alpha.31) (2019-01-28)
227
+
228
+
229
+
230
+ ## [0.0.1-alpha.30](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-alpha.29...v0.0.1-alpha.30) (2019-01-22)
231
+
232
+
233
+
234
+ ## [0.0.1-alpha.29](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-alpha.28...v0.0.1-alpha.29) (2019-01-14)
235
+
236
+
237
+
238
+ ## [0.0.1-alpha.28](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-alpha.27...v0.0.1-alpha.28) (2019-01-11)
239
+
240
+
241
+
242
+ ## [0.0.1-alpha.27](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-alpha.26...v0.0.1-alpha.27) (2019-01-10)
243
+
244
+
245
+
246
+ ## [0.0.1-alpha.26](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-alpha.25...v0.0.1-alpha.26) (2018-12-13)
247
+
248
+
249
+ ### Bug Fixes
250
+
251
+ * **icon-helpers:** change style property ([#172](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/issues/172)) ([e33ba76](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/commit/e33ba76))
252
+
253
+
254
+
255
+ ## [0.0.1-alpha.25](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-alpha.24...v0.0.1-alpha.25) (2018-12-11)
256
+
257
+
258
+ ### Bug Fixes
259
+
260
+ * **icons:** fix icon blurriness in Firefox Quantum ([#139](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/issues/139)) ([c826e08](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/commit/c826e08))
261
+
262
+
263
+
264
+ ## [0.0.1-alpha.24](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-alpha.23...v0.0.1-alpha.24) (2018-12-07)
265
+
266
+
267
+ ### Bug Fixes
268
+
269
+ * **icon-helpers:** use attributes correctly in toSVG ([#126](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/issues/126)) ([7d2d6ea](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/commit/7d2d6ea))
270
+
271
+
272
+
273
+ ## [0.0.1-alpha.23](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-alpha.22...v0.0.1-alpha.23) (2018-12-06)
274
+
275
+
276
+
277
+ ## [0.0.1-alpha.22](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-alpha.21...v0.0.1-alpha.22) (2018-12-04)
278
+
279
+
280
+
281
+ ## [0.0.1-alpha.21](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-alpha.20...v0.0.1-alpha.21) (2018-12-04)
282
+
283
+
284
+ ### Features
285
+
286
+ * **icons-vue:** add @carbon/icons-vue package ([#60](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/issues/60)) ([8ac5c05](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/commit/8ac5c05))
287
+
288
+
289
+
290
+ ## [0.0.1-alpha.20](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-alpha.19...v0.0.1-alpha.20) (2018-11-29)
291
+
292
+
293
+
294
+ ## [0.0.1-alpha.19](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-alpha.18...v0.0.1-alpha.19) (2018-11-29)
295
+
296
+
297
+
298
+ ## [0.0.1-alpha.18](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-alpha.17...v0.0.1-alpha.18) (2018-11-28)
299
+
300
+
301
+ ### Bug Fixes
302
+
303
+ * **icons-react:** fix prop-type for focusable ([#90](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/issues/90)) ([9ee6e38](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/commit/9ee6e38))
304
+
305
+
306
+
307
+ ## [0.0.1-alpha.17](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-alpha.16...v0.0.1-alpha.17) (2018-11-25)
308
+
309
+
310
+
311
+ ## [0.0.1-alpha.16](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-alpha.15...v0.0.1-alpha.16) (2018-11-21)
312
+
313
+
314
+
315
+ ## [0.0.1-alpha.15](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-alpha.14...v0.0.1-alpha.15) (2018-11-21)
316
+
317
+
318
+
319
+ ## [0.0.1-alpha.14](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-alpha.13...v0.0.1-alpha.14) (2018-11-20)
320
+
321
+
322
+
323
+ ## [0.0.1-alpha.13](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-alpha.12...v0.0.1-alpha.13) (2018-11-19)
324
+
325
+
326
+ ### Features
327
+
328
+ * **icon-helpers:** export formatAttributes ([#84](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/issues/84)) ([b99e88d](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/commit/b99e88d)), closes [IBM/carbon-components#1452](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/issues/1452)
329
+
330
+
331
+
332
+ ## [0.0.1-alpha.12](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-alpha.11...v0.0.1-alpha.12) (2018-11-18)
333
+
334
+
335
+
336
+ ## [0.0.1-alpha.11](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-alpha.10...v0.0.1-alpha.11) (2018-11-18)
337
+
338
+
339
+
340
+ ## [0.0.1-alpha.10](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-alpha.9...v0.0.1-alpha.10) (2018-11-18)
341
+
342
+
343
+
344
+ ## [0.0.1-alpha.9](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-alpha.8...v0.0.1-alpha.9) (2018-11-18)
345
+
346
+
347
+
348
+ ## [0.0.1-alpha.8](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-alpha.7...v0.0.1-alpha.8) (2018-11-18)
349
+
350
+
351
+
352
+ ## [0.0.1-alpha.7](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-alpha.5...v0.0.1-alpha.7) (2018-11-14)
353
+
354
+
355
+
356
+ ## [0.0.1-alpha.5](https://github.com/IBM/carbon-elements/tree/master/packages/icon-helpers/compare/v0.0.1-alpha.4...v0.0.1-alpha.5) (2018-11-14)
package/LICENSE CHANGED
@@ -178,7 +178,7 @@
178
178
  APPENDIX: How to apply the Apache License to your work.
179
179
 
180
180
  To apply the Apache License to your work, attach the following
181
- boilerplate notice, with the fields enclosed by brackets "[]"
181
+ boilerplate notice, with the fields enclosed by brackets "{}"
182
182
  replaced with your own identifying information. (Don't include
183
183
  the brackets!) The text should be enclosed in the appropriate
184
184
  comment syntax for the file format. We also recommend that a
@@ -186,7 +186,7 @@
186
186
  same "printed page" as the copyright notice for easier
187
187
  identification within third-party archives.
188
188
 
189
- Copyright 2018 IBM Corp.
189
+ Copyright 2015 IBM Corp.
190
190
 
191
191
  Licensed under the Apache License, Version 2.0 (the "License");
192
192
  you may not use this file except in compliance with the License.
package/README.md CHANGED
@@ -1,19 +1,19 @@
1
1
  # @carbon/icon-helpers
2
2
 
3
- > Helpers used alongside icons for digital and software products using
4
- > the Carbon Design System
3
+ > Helpers used alongside icons for digital and software products using the
4
+ > Carbon Design System
5
5
 
6
6
  ## Getting started
7
7
 
8
- To install `@carbon/icon-helpers` in your project, you will need to
9
- run the following command using [npm](https://www.npmjs.com/):
8
+ To install `@carbon/icon-helpers` in your project, you will need to run the
9
+ following command using [npm](https://www.npmjs.com/):
10
10
 
11
11
  ```bash
12
12
  npm install -S @carbon/icon-helpers
13
13
  ```
14
14
 
15
- If you prefer [Yarn](https://yarnpkg.com/en/), use the following
16
- command instead:
15
+ If you prefer [Yarn](https://yarnpkg.com/en/), use the following command
16
+ instead:
17
17
 
18
18
  ```bash
19
19
  yarn add @carbon/icon-helpers
@@ -21,8 +21,9 @@ yarn add @carbon/icon-helpers
21
21
 
22
22
  ## Usage
23
23
 
24
- `@carbon/icon-helpers` provides a couple of helpers for rendering `<svg>` nodes in a document, or to help get the correct attributes to
25
- set on an `<svg>` node. These include:
24
+ `@carbon/icon-helpers` provides a couple of helpers for rendering `<svg>` nodes
25
+ in a document, or to help get the correct attributes to set on an `<svg>` node.
26
+ These include:
26
27
 
27
28
  | Name | Type | Description |
28
29
  | ------------------ | --------------------------------- | ---------------------------------------------------------------------------- |
@@ -31,19 +32,18 @@ set on an `<svg>` node. These include:
31
32
  | `toString` | `(descriptor: Object) => String` | Format the given icon descriptor into a string. Useful for templates |
32
33
  | `toSVG` | `(descriptor: Object) => DOMNode` | Format the given icon descriptor into a DOM node |
33
34
 
34
- For most of the methods, `attributes` corresponds with whatever the
35
- name and value would be if you were writing the HTML for the `<svg>`.
36
- For example, if we wanted to set `width` and `height` we would do the
37
- following:
35
+ For most of the methods, `attributes` corresponds with whatever the name and
36
+ value would be if you were writing the HTML for the `<svg>`. For example, if we
37
+ wanted to set `width` and `height` we would do the following:
38
38
 
39
39
  ```js
40
40
  const { getAttributes } = require('@carbon/icon-helpers');
41
41
  const attributes = getAttributes({ width: 20, height: 20 });
42
42
  ```
43
43
 
44
- In order for the icon to be considered focusable, you will need to
45
- provide either `aria-label`, `aria-labelledby`, or `title` in the
46
- given `attributes` in addition to `tabindex`. For example:
44
+ In order for the icon to be considered focusable, you will need to provide
45
+ either `aria-label`, `aria-labelledby`, or `title` in the given `attributes` in
46
+ addition to `tabindex`. For example:
47
47
 
48
48
  ```js
49
49
  const { getAttributes } = require('@carbon/icon-helpers');
@@ -55,9 +55,8 @@ const attributes = getAttributes({
55
55
 
56
56
  ### Icon descriptors
57
57
 
58
- An icon descriptor is the term we use to describe icon objects
59
- exported by `@carbon/icons`. By default, they will have the following
60
- shape:
58
+ An icon descriptor is the term we use to describe icon objects exported by
59
+ `@carbon/icons`. By default, they will have the following shape:
61
60
 
62
61
  ```js
63
62
  {
@@ -81,8 +80,8 @@ shape:
81
80
  }
82
81
  ```
83
82
 
84
- You can import these definitions directly from `@carbon/icons` and use
85
- them alongside `toSVG` or `toString` by doing:
83
+ You can import these definitions directly from `@carbon/icons` and use them
84
+ alongside `toSVG` or `toString` by doing:
86
85
 
87
86
  ```js
88
87
  import { IconName } from '@carbon/icons';
@@ -100,10 +99,9 @@ const iconSVG = toSVG({
100
99
 
101
100
  ## 🙌 Contributing
102
101
 
103
- We're always looking for contributors to help us fix bugs, build new
104
- features, or help us improve the project documentation. If you're
105
- interested, definitely check out our [Contributing Guide](/.github/CONTRIBUTING.md)
106
- ! 👀
102
+ We're always looking for contributors to help us fix bugs, build new features,
103
+ or help us improve the project documentation. If you're interested, definitely
104
+ check out our [Contributing Guide](/.github/CONTRIBUTING.md) ! 👀
107
105
 
108
106
  ## 📝 License
109
107
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@carbon/icon-helpers",
3
3
  "description": "Helpers used alongside icons for digital and software products using the Carbon Design System",
4
- "version": "10.0.0-rc.0",
4
+ "version": "10.2.0",
5
5
  "license": "Apache-2.0",
6
6
  "main": "lib/index.js",
7
7
  "module": "es/index.js",
@@ -27,9 +27,9 @@
27
27
  "clean": "rimraf es lib umd"
28
28
  },
29
29
  "devDependencies": {
30
- "@carbon/bundler": "10.0.0-rc.0",
30
+ "@carbon/bundler": "10.2.0",
31
31
  "rimraf": "^2.6.2"
32
32
  },
33
33
  "sideEffects": false,
34
- "gitHead": "1d45594d448a22447b2b2685445362438b7c8944"
34
+ "gitHead": "e71825a0cf44f6f41fee7d2b0dd9c57d7bda126a"
35
35
  }