diff --git a/.changeset/cold-news-fry.md b/.changeset/cold-news-fry.md deleted file mode 100644 index 01e79aa..0000000 --- a/.changeset/cold-news-fry.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@rhds/icons": patch ---- - -Corrected icon export path from `./dist/{{set}}/*` to `./{{set}}/*` diff --git a/.changeset/cyan-pillows-invite.md b/.changeset/cyan-pillows-invite.md deleted file mode 100644 index 9821fb1..0000000 --- a/.changeset/cyan-pillows-invite.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -"@rhds/icons": minor ---- -Adds JavaScript module, which exports each icon set as a map of icon names to SVG DOM nodes. - -```typescript -import * as Icons from '@rhds/icons'; - -document.body.append(Icons.social.get('rss')); -document.body.append(Icons.standard.get('api')); -``` - -**⚠️ WARNING**: The JavaScript module loads *every* available icon. Importing it -to your project may negatively impact page loading performance. - -TypeScript users may import the `IconSetName` and `IconNameFor` types to ensure -their projects use the correct string names. - -```typescript -import type { IconSetName, IconNameFor } from '@rhds/icons'; - -const iconSet: IconSetName = 'social'; -const iconName: IconNameFor<'social'> = 'email'; -``` diff --git a/CHANGELOG.md b/CHANGELOG.md index cfdb81d..4b1b22f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,35 @@ # @rhds/icons +## 1.1.0 + +### Minor Changes + +- 084c0a5: Adds JavaScript module, which exports each icon set as a map of icon names to SVG DOM nodes. + + ```typescript + import * as Icons from "@rhds/icons"; + + document.body.append(Icons.social.get("rss")); + document.body.append(Icons.standard.get("api")); + ``` + + **⚠️ WARNING**: The JavaScript module loads _every_ available icon. Importing it + to your project may negatively impact page loading performance. + + TypeScript users may import the `IconSetName` and `IconNameFor` types to ensure + their projects use the correct string names. + + ```typescript + import type { IconSetName, IconNameFor } from "@rhds/icons"; + + const iconSet: IconSetName = "social"; + const iconName: IconNameFor<"social"> = "email"; + ``` + +### Patch Changes + +- b098f96: Corrected icon export path from `./dist/{{set}}/*` to `./{{set}}/*` + ## 1.0.0 ### Major Changes diff --git a/package.json b/package.json index ac152ee..4d12e10 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@rhds/icons", - "version": "1.0.0", + "version": "1.1.0", "description": "Red Hat Icons", "main": "icons.js", "module": "icons.js",