@girumtech/gs-design-system-react 0.1.8 → 0.1.9

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 (2) hide show
  1. package/README.md +5 -1
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -134,13 +134,17 @@ const spark: readonly IconPath[] = [
134
134
  export function Icons() {
135
135
  return (
136
136
  <>
137
- <NamedIcon name="heart" size={28} color="#A81D1D" label="Favorite" />
137
+ <NamedIcon name="Heart" size={28} color="#A81D1D" label="Favorite" />
138
138
  <Icon paths={spark} size={32} color="#10106B" label="Spark" />
139
139
  </>
140
140
  )
141
141
  }
142
142
  ```
143
143
 
144
+ ### Built-in icon names
145
+
146
+ `NamedIcon`'s `name` prop is a PascalCase `IconName`: `ArrowRight`, `Check`, `Heart`, `Plus`, `Menu`, `User`, `ChevronRight`, `ChevronLeft`, `Logout`, `Close`, `Layers`, `Box`, `Edit`, `Eye`, `EyeOff`, `Moon`, `Sun`, `Coin`. Need something outside that set? Pass your own `paths` to `Icon` rather than keeping a one-off icon set in the consuming app.
147
+
144
148
  Decorative icons may omit `label`; meaningful icons should provide one.
145
149
 
146
150
  ## Exports
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girumtech/gs-design-system-react",
3
- "version": "0.1.8",
3
+ "version": "0.1.9",
4
4
  "description": "React web entry point for GsDesignSystem",
5
5
  "type": "module",
6
6
  "sideEffects": false,
@@ -23,7 +23,7 @@
23
23
  "typecheck": "tsc -p tsconfig.json"
24
24
  },
25
25
  "dependencies": {
26
- "@girumtech/gs-design-system-core": "0.1.8"
26
+ "@girumtech/gs-design-system-core": "0.1.9"
27
27
  },
28
28
  "peerDependencies": {
29
29
  "react": ">=19",