@primer/octovisuals-react 0.3.1-rc.f67fd03 → 0.3.1
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.
- package/README.md +4 -5
- package/dist/types.d.ts +0 -4
- package/dist/types.d.ts.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -40,11 +40,10 @@ true to the design.
|
|
|
40
40
|
|
|
41
41
|
All icons accept the following props, plus any valid SVG element props:
|
|
42
42
|
|
|
43
|
-
| Prop | Type
|
|
44
|
-
| ------------ |
|
|
45
|
-
| `size` | `number`
|
|
46
|
-
| `aria-label` | `string`
|
|
47
|
-
| `animate` | `boolean` | `false` | Plays a stroke-draw reveal animation on mount |
|
|
43
|
+
| Prop | Type | Default | Description |
|
|
44
|
+
| ------------ | -------- | ------- | -------------------------------------------------- |
|
|
45
|
+
| `size` | `number` | `96` | Width and height of the icon in pixels |
|
|
46
|
+
| `aria-label` | `string` | — | Accessible label. When set, icon gets `role="img"` |
|
|
48
47
|
|
|
49
48
|
When no `aria-label` is provided, icons render with `aria-hidden="true"`.
|
|
50
49
|
|
package/dist/types.d.ts
CHANGED
|
@@ -10,10 +10,6 @@ export type OctovisualProps = Omit<SVGProps<SVGSVGElement>, "children" | "danger
|
|
|
10
10
|
* When omitted, the icon is decorative and gets `aria-hidden="true"`.
|
|
11
11
|
*/
|
|
12
12
|
"aria-label"?: string;
|
|
13
|
-
/**
|
|
14
|
-
* Use animate to play an initial reveal animation.
|
|
15
|
-
* Defaults to false.
|
|
16
|
-
*/
|
|
17
13
|
animate?: boolean;
|
|
18
14
|
};
|
|
19
15
|
//# sourceMappingURL=types.d.ts.map
|
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,OAAO,CAAA;AAEnC,MAAM,MAAM,eAAe,GAAG,IAAI,CAChC,QAAQ,CAAC,aAAa,CAAC,EACvB,UAAU,GAAG,yBAAyB,CACvC,GAAG;IACF;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,OAAO,CAAA;AAEnC,MAAM,MAAM,eAAe,GAAG,IAAI,CAChC,QAAQ,CAAC,aAAa,CAAC,EACvB,UAAU,GAAG,yBAAyB,CACvC,GAAG;IACF;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA"}
|