@transferwise/icons 3.0.6 → 3.1.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.
- package/README.md +10 -12
- package/lib/angular/components/bill-split-icon.component.d.ts +6 -0
- package/lib/angular/components/interac-icon.component.d.ts +6 -0
- package/lib/angular/components/pix-icon.component.d.ts +6 -0
- package/lib/angular/components/spend-dirham-icon.component.d.ts +6 -0
- package/lib/angular/components/spend-dollar-icon.component.d.ts +6 -0
- package/lib/angular/components/spend-euro-icon.component.d.ts +6 -0
- package/lib/angular/components/spend-forint-icon.component.d.ts +6 -0
- package/lib/angular/components/spend-franc-icon.component.d.ts +6 -0
- package/lib/angular/components/spend-hryvnia-icon.component.d.ts +6 -0
- package/lib/angular/components/spend-koruna-icon.component.d.ts +6 -0
- package/lib/angular/components/spend-krone-icon.component.d.ts +6 -0
- package/lib/angular/components/spend-kuna-icon.component.d.ts +6 -0
- package/lib/angular/components/spend-leu-lei-icon.component.d.ts +6 -0
- package/lib/angular/components/spend-lev-icon.component.d.ts +6 -0
- package/lib/angular/components/spend-lira-icon.component.d.ts +6 -0
- package/lib/angular/components/spend-pound-icon.component.d.ts +6 -0
- package/lib/angular/components/spend-real-icon.component.d.ts +6 -0
- package/lib/angular/components/spend-ringgit-icon.component.d.ts +6 -0
- package/lib/angular/components/spend-rupee-icon.component.d.ts +6 -0
- package/lib/angular/components/spend-rupiah-icon.component.d.ts +6 -0
- package/lib/angular/components/spend-yen-icon.component.d.ts +6 -0
- package/lib/angular/components/spend-zloty-icon.component.d.ts +6 -0
- package/lib/angular/components/venmo-icon.component.d.ts +6 -0
- package/lib/angular/index.js +1 -1
- package/lib/components/bill-split.d.ts +10 -0
- package/lib/components/index.d.ts +23 -0
- package/lib/components/interac.d.ts +10 -0
- package/lib/components/pix.d.ts +10 -0
- package/lib/components/spend-dirham.d.ts +10 -0
- package/lib/components/spend-dollar.d.ts +10 -0
- package/lib/components/spend-euro.d.ts +10 -0
- package/lib/components/spend-forint.d.ts +10 -0
- package/lib/components/spend-franc.d.ts +10 -0
- package/lib/components/spend-hryvnia.d.ts +10 -0
- package/lib/components/spend-koruna.d.ts +10 -0
- package/lib/components/spend-krone.d.ts +10 -0
- package/lib/components/spend-kuna.d.ts +10 -0
- package/lib/components/spend-leu-lei.d.ts +10 -0
- package/lib/components/spend-lev.d.ts +10 -0
- package/lib/components/spend-lira.d.ts +10 -0
- package/lib/components/spend-pound.d.ts +10 -0
- package/lib/components/spend-real.d.ts +10 -0
- package/lib/components/spend-ringgit.d.ts +10 -0
- package/lib/components/spend-rupee.d.ts +10 -0
- package/lib/components/spend-rupiah.d.ts +10 -0
- package/lib/components/spend-yen.d.ts +10 -0
- package/lib/components/spend-zloty.d.ts +10 -0
- package/lib/components/venmo.d.ts +10 -0
- package/lib/index.es.js +1 -1
- package/lib/index.js +2 -2
- package/package.json +4 -4
package/README.md
CHANGED
@@ -9,9 +9,8 @@
|
|
9
9
|
|
10
10
|
Check out the [Live Demo](https://transferwise.github.io/icons/)
|
11
11
|
|
12
|
-
|
13
|
-
|
14
|
-
The icon set has mostly **`outline`** icons but some of them also have **`filled`** variants.
|
12
|
+
Each Icon is designed in two sizes: **`16`** (default) and **`24`** pixels.
|
13
|
+
The icon set are mostly **`outline`** icons but there are also some **`filled`** icons. These are all variations of an **`outline`** icon with `Fill` added as a suffix. Icons with a **`filled`** version have a blue badge in the [Live Demo](https://transferwise.github.io/icons/).
|
15
14
|
|
16
15
|
React and AngularJS icon components generated by script files (see `src/build-scripts` folder).
|
17
16
|
|
@@ -28,12 +27,12 @@ npm install @transferwise/icons
|
|
28
27
|
```
|
29
28
|
## Import and use it with
|
30
29
|
### React
|
31
|
-
[](https://codesandbox.io/s/transferwise-icons-react-
|
30
|
+
[](https://codesandbox.io/s/transferwise-icons-react-e0rt2z)
|
32
31
|
|
33
32
|
```ts
|
34
33
|
import { Bank as BankIcon } from '@transferwise/icons';
|
35
34
|
|
36
|
-
const YourComponent = () => <BankIcon size={24}
|
35
|
+
const YourComponent = () => <BankIcon size={24} data-testid="bank-icon" />;
|
37
36
|
```
|
38
37
|
|
39
38
|
will result in
|
@@ -60,7 +59,7 @@ const AchIcon = icons['Ach'];
|
|
60
59
|
|
61
60
|
Each component has `className` property as well, so you can avoid wrapping your component in extra parent elements.
|
62
61
|
```jsx
|
63
|
-
<BankIcon size={24}
|
62
|
+
<BankIcon size={24} className="bank-profile-icon" />
|
64
63
|
```
|
65
64
|
|
66
65
|
### AngularJS
|
@@ -79,11 +78,11 @@ and in template
|
|
79
78
|
|
80
79
|
<tw-icon name="bank" size="24"></tw-icon>
|
81
80
|
|
82
|
-
<tw-activity-icon size="24"
|
81
|
+
<tw-activity-icon size="24"></tw-activity-icon>
|
83
82
|
|
84
|
-
<tw-balance-icon size="16"
|
83
|
+
<tw-balance-icon size="16"></tw-balance-icon>
|
85
84
|
|
86
|
-
<tw-icon name="balance" size="16"
|
85
|
+
<tw-icon name="balance" size="16"></tw-icon>
|
87
86
|
```
|
88
87
|
|
89
88
|
## Necessary CSS
|
@@ -144,9 +143,8 @@ By default icon will be removed from accessibility tree as [`aria-hidden="true"`
|
|
144
143
|
|
145
144
|
# Contributing
|
146
145
|
|
147
|
-
Add / remove / change icon(s) in the
|
148
|
-
Follow the **naming convention**, use **kebab-case** for naming the icon
|
149
|
-
For naming the SVG files in the folder, follow this pattern: `<<variant>>_<<size>>.svg`, e.g. `fill_16.svg` or `outline_24.svg`.
|
146
|
+
Add / remove / change icon(s) in the [wise-atoms](https://github.com/transferwise/wise-atoms) project and then consume here.
|
147
|
+
Follow the **naming convention**, use **kebab-case** for naming the icon.
|
150
148
|
|
151
149
|
The build process for parsing, optimizing and generating individual icon components out of SVG files is done by script files, that you can find the in the `src/build-scripts` folder.
|
152
150
|
[Rollup.js](https://rollupjs.org/guide/en/) is used for generating the ES and UMD bundles of the library.
|