@sb1/ffe-icons-react 12.0.5 → 12.0.7
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/package.json +2 -2
- package/src/Icon.mdx +29 -34
- package/src/Icon.stories.tsx +0 -5
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sb1/ffe-icons-react",
|
|
3
|
-
"version": "12.0.
|
|
3
|
+
"version": "12.0.7",
|
|
4
4
|
"description": "React-komponenter for ffe-icons",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "SpareBank 1",
|
|
@@ -41,5 +41,5 @@
|
|
|
41
41
|
"publishConfig": {
|
|
42
42
|
"access": "public"
|
|
43
43
|
},
|
|
44
|
-
"gitHead": "
|
|
44
|
+
"gitHead": "3eea428f0cedddf0c2fa966b867ded9ab4b0e9ef"
|
|
45
45
|
}
|
package/src/Icon.mdx
CHANGED
|
@@ -16,6 +16,31 @@ Ikonene vi bruker kommer fra ikonbiblioteket Material Symbols. [Les mer om ikone
|
|
|
16
16
|
|
|
17
17
|
<InstallImport packageName="@sb1/ffe-icons-react" dependencies={dependencies} />
|
|
18
18
|
|
|
19
|
+
## Kode
|
|
20
|
+
For å bruke et ikon i kode må du gjøre 3 ting:
|
|
21
|
+
1. Importere styling `@import '@sb1/ffe-icons/less/ffe-icons';`
|
|
22
|
+
2. Importere ikonet `import closeIcon from '@sb1/ffe-icons/icons/open/300/md/close.svg';`
|
|
23
|
+
3. Importere React-komponenten som skal holde ikonet `import { Icon } from '@sb1/ffe-icons-react';`
|
|
24
|
+
|
|
25
|
+
Sammen ser det slik ut:
|
|
26
|
+
```
|
|
27
|
+
import { Icon } from '@sb1/ffe-icons-react';
|
|
28
|
+
import closeIcon from '@sb1/ffe-icons/icons/open/300/md/close.svg'; //{open eller filled} / {vekt} / {størrelse} / {navn}
|
|
29
|
+
//@import '@sb1/ffe-icons/less/ffe-icons'; //I en css-fil
|
|
30
|
+
.....
|
|
31
|
+
<Icon fileUrl={closeIcon} size="md" ariaLabel="lukk" />
|
|
32
|
+
```
|
|
33
|
+
Det er viktig at du setter en `size`-prop som stemmer overens med SVG-størrelsen, slik at ikonet vises riktig.
|
|
34
|
+
|
|
35
|
+
For å finne navnet på ikonet ("close" fra eksempelet) kan du enten finne ikonet via [Google Symbols](https://fonts.google.com/icons) eller se på navnet som er brukt på
|
|
36
|
+
ikonet i Figma, hvis du jobber ut i fra Figma-skisser.<br/>
|
|
37
|
+
|
|
38
|
+
I `ffe-icons` finner du alle varianter av ikonene som SVG-filer.
|
|
39
|
+
`Icon`-komponenten tar inn en filbane eller [data-URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs), og setter SVG-ikonet som en mask.
|
|
40
|
+
Det gjør at ikonet kan arve color-verdien fra et parent-element. Dersom du ønsker å legge inn ikoner som data-URL må man selv konvertere
|
|
41
|
+
ikonene til et passende format, for eksempel [base64](https://developer.mozilla.org/en-US/docs/Glossary/Base64).
|
|
42
|
+
|
|
43
|
+
|
|
19
44
|
## Figma
|
|
20
45
|
|
|
21
46
|
Når du bruker komponenter fra designsystem-biblioteket i Figma ligger ikonene tilgjengelig som en del av komponentene.
|
|
@@ -29,56 +54,26 @@ Når du trenger et ikon utenfor komponentene lager du et nytt tekstelement, skri
|
|
|
29
54
|
|
|
30
55
|
<img src={velgerTextStilSrc} alt="Hvordan man velger tekststil for ikoner" />
|
|
31
56
|
|
|
32
|
-
Bruk Color Styles for å bytte farge på ikonet.
|
|
33
|
-
|
|
34
|
-
<img src={velgerColorSrc} alt="Hvordan man velger color style for ikonet" />
|
|
35
|
-
|
|
36
|
-
## SVG-implementasjon
|
|
37
|
-
|
|
38
|
-
Bruk pakkene `ffe-icons` og `ffe-icons-react`. I `ffe-icons` finner du alle varianter av ikonene som SVG-filer, i tillegg til styling-filene som brukes i React-komponenten.
|
|
39
|
-
SVG-filene er sortert på `weight`, om de er fylt eller ikke, samt størrelse. Hvilken størrelse du skal bruke kan variere fra komponent til komponent.
|
|
40
|
-
|
|
41
|
-
`Icon`-komponenten tar inn en filbane eller [data-URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs), og setter SVG-ikonet som en mask. Det gjør at ikonet kan arve color-verdien fra et parent-element.
|
|
42
|
-
|
|
43
|
-
Filbane er anbefalt metode for å importere ikoner. På denne måten kan man i tillegg til selve ikonet spesifisere variant, vekt og størrelse i URL-en ikonet hentes fra.
|
|
44
|
-
For eksempel vil et åpent hjem-ikon med vekt 300 og størrelse md kunne tas i bruk slik:
|
|
45
|
-
|
|
46
|
-
```
|
|
47
|
-
import homeIcon from '@sb1/ffe-icons/icons/open/300/md/home.svg';
|
|
48
|
-
|
|
49
|
-
return <Icon fileUrl={homeIcon} size="md" ariaLabel="hjem" />;
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
Dersom man ønsker å legge inn ikoner som data-URL må man selv konvertere ikonene til et passende format, for eksempel [base64](https://developer.mozilla.org/en-US/docs/Glossary/Base64).
|
|
53
|
-
|
|
54
57
|
## Forhåndsvisning
|
|
58
|
+
`aria-hidden` settes automatisk til true, dersom du ikke sender med en verdi i `ariaLabel`.
|
|
55
59
|
|
|
56
60
|
<Canvas of={IconStories.Standard} />
|
|
57
61
|
<Controls of={IconStories.Standard} />
|
|
58
62
|
|
|
59
|
-
`mask` fungerer på samme måte som bakgrunn. Det er derfor viktig at du setter en `size`-prop som stemmer overens med SVG-størrelsen, slik at ikonet vises riktig.
|
|
60
|
-
Setter du en verdi i `size` som ikke stemmer overens med SVG-en, vil resultatet se slik ut:
|
|
61
|
-
|
|
62
|
-
<Canvas of={IconStories.WrongSize} />
|
|
63
|
-
|
|
64
|
-
Dette er gjort med vilje for at man skal bli klar over at man bruker feil SVG, da linjetykkelsen varierer fra størrelse til størrelse.
|
|
65
|
-
|
|
66
|
-
`aria-hidden` settes automatisk til true, dersom du ikke sender med en verdi i `ariaLabel`:
|
|
67
|
-
|
|
68
|
-
<Canvas of={IconStories.NoAriaLabel} />
|
|
69
|
-
|
|
70
63
|
## Stil
|
|
71
64
|
|
|
72
65
|
Vi bruker stilen «rounded». Den harmonerer godt med resten av den visuelle identiteten til SpareBank 1.
|
|
73
66
|
|
|
74
67
|
## Størrelser
|
|
75
68
|
|
|
76
|
-
Velg mellom
|
|
69
|
+
Velg mellom størrelsene `sm`, `md`, `lg` og `xl`.
|
|
77
70
|
|
|
78
71
|
<Canvas of={IconStories.Sizes} />
|
|
79
72
|
|
|
80
73
|
## Tykkelser
|
|
81
74
|
|
|
75
|
+
Velg mellom tykkelsene 300, 400 og 500. 300 er mest vanlig.
|
|
76
|
+
|
|
82
77
|
<Canvas of={IconStories.Weights} />
|
|
83
78
|
|
|
84
79
|
## Farger
|
package/src/Icon.stories.tsx
CHANGED
|
@@ -19,11 +19,6 @@ export const Standard: Story = {
|
|
|
19
19
|
render: args => <Icon {...args} />,
|
|
20
20
|
};
|
|
21
21
|
|
|
22
|
-
export const WrongSize: Story = {
|
|
23
|
-
args: { ...Standard.args, size: 'lg' },
|
|
24
|
-
render: args => <Icon {...args} />,
|
|
25
|
-
};
|
|
26
|
-
|
|
27
22
|
export const NoAriaLabel: Story = {
|
|
28
23
|
args: { ...Standard.args, ariaLabel: undefined },
|
|
29
24
|
render: args => <Icon {...args} />,
|