@justeattakeaway/pie-icons 4.9.2 → 4.9.3
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 +11 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -24,7 +24,8 @@ You can either use the pie-icons package using native JS, or hook into the compi
|
|
|
24
24
|
|
|
25
25
|
#### 1. Install
|
|
26
26
|
|
|
27
|
-
>
|
|
27
|
+
> [!NOTE]
|
|
28
|
+
> If you intend to use `pie-icons` with a CDN, you can skip this installation step.
|
|
28
29
|
|
|
29
30
|
Install with [npm](https://docs.npmjs.com/getting-started/what-is-npm) or Yarn.
|
|
30
31
|
|
|
@@ -44,7 +45,8 @@ Include `pie-icons.js` or `pie-icons.min.js` with a `<script>` tag:
|
|
|
44
45
|
<script src="path/to/dist/pie-icons.js"></script>
|
|
45
46
|
```
|
|
46
47
|
|
|
47
|
-
>
|
|
48
|
+
> [!NOTE]
|
|
49
|
+
> `pie-icons.js` and `pie-icons.min.js` are located in the `dist` directory of the npm package.
|
|
48
50
|
|
|
49
51
|
Or load the script from a CDN provider:
|
|
50
52
|
|
|
@@ -150,7 +152,8 @@ pieicons.icons.x.toString()
|
|
|
150
152
|
// '<line ... /><line ... />'
|
|
151
153
|
```
|
|
152
154
|
|
|
153
|
-
>
|
|
155
|
+
> [!NOTE]
|
|
156
|
+
> `x` in the above example can be replaced with any valid icon name. Icons with multi-word names (e.g. `arrow-right`) **cannot** be accessed using dot notation (e.g. `pieicons.icons.x`). Instead, use bracket notation (e.g. `pieicons.icons['arrow-right']`).
|
|
154
157
|
|
|
155
158
|
[View Source](https://github.com/justeat/pie-icons/blob/master/src/icons.js)
|
|
156
159
|
|
|
@@ -167,7 +170,8 @@ Returns an SVG string.
|
|
|
167
170
|
| `attrs` (optional) | Object | Key-value pairs in the `attrs` object will be mapped to HTML attributes on the `<svg>` tag (e.g. `{ foo: 'bar' }` maps to `foo="bar"`). All default attributes on the `<svg>` tag can be overridden with the `attrs` object. |
|
|
168
171
|
| `platform` (optional) | String | Defaults to 'default'. Can be changed to allow for specific attrs to be included/excluded. Current valid options are `"reactNative"` |
|
|
169
172
|
|
|
170
|
-
>
|
|
173
|
+
> [!NOTE]
|
|
174
|
+
> You might find these SVG attributes helpful for manipulating icons:
|
|
171
175
|
> * [`color`](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/color)
|
|
172
176
|
> * [`width`](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/width)
|
|
173
177
|
> * [`height`](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/height)
|
|
@@ -204,7 +208,8 @@ Replaces all elements that have a `data-pie-icons` attribute with SVG markup cor
|
|
|
204
208
|
|
|
205
209
|
#### Usage
|
|
206
210
|
|
|
207
|
-
>
|
|
211
|
+
> [!NOTE]
|
|
212
|
+
> `pieicons.replace()` only works in a browser environment.
|
|
208
213
|
|
|
209
214
|
Simple usage:
|
|
210
215
|
```html
|
|
@@ -252,4 +257,4 @@ All attributes on the placeholder element (i.e. `<i>`) will be copied to the `<s
|
|
|
252
257
|
|
|
253
258
|
## Credits
|
|
254
259
|
|
|
255
|
-
The `@justeattakeaway/pie-icons` project owes a great deal to the [Feather SVG Icon Library](https://github.com/feathericons/feather). This project started as a fork of that project for developers at Just Eat to build out icons, while giving us a great platform for the initial build and API that Feather had already built.
|
|
260
|
+
The `@justeattakeaway/pie-icons` project owes a great deal to the [Feather SVG Icon Library](https://github.com/feathericons/feather). This project started as a fork of that project for developers at Just Eat Takeaway.com to build out icons, while giving us a great platform for the initial build and API that Feather had already built.
|