@sb1/ffe-icons-react 11.0.7 → 11.0.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.
@@ -0,0 +1 @@
1
+ {"root":["../src/Icon.tsx","../src/index.tsx"],"version":"5.6.2"}
@@ -0,0 +1 @@
1
+ {"root":["../src/Icon.tsx","../src/index.tsx"],"version":"5.6.2"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sb1/ffe-icons-react",
3
- "version": "11.0.7",
3
+ "version": "11.0.9",
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": "0d513edf288646f9be670fd3c642961d01823899"
44
+ "gitHead": "671f9cd4a5c589643d12589a4454f40994eabb28"
45
45
  }
package/src/Icon.mdx ADDED
@@ -0,0 +1,107 @@
1
+ import { Canvas, Meta, Controls } from '@storybook/blocks';
2
+ import * as IconStories from './Icon.stories.tsx';
3
+ import bytteIkonSrc from './img/bytte-ikon.png'
4
+ import velgerTextStilSrc from './img/velger-tekststil.png'
5
+ import velgerColorSrc from './img/velger-color.png'
6
+
7
+ <Meta of={IconStories} />
8
+
9
+ # Icon
10
+
11
+ Ikoner skal gjøre det enkelt for kunden å navigere i de digitale flatene våre. Ikonene representerer funksjoner, verktøy eller handlinger og visualiserer funksjonalitet.
12
+
13
+ Ikonene vi bruker kommer fra ikonbiblioteket Material Symbols. [Les mer om ikonene](https://design.sparebank1.no/profil/ikoner/) under profil.
14
+
15
+
16
+ ## Figma
17
+
18
+ Når du bruker komponenter fra designsystem-biblioteket i Figma ligger ikonene tilgjengelig som en del av komponentene.
19
+
20
+ For å bytte ikon klikker du deg bare inn på ikonet og skriver navnet på ikonet du vil ha. Du får oversikt over alle ikonene og navnene med plugin «Material Symbols»
21
+ i Figma eller på [https://fonts.google.com/icons?icon.style=Rounded](https://fonts.google.com/icons?icon.style=Rounded).
22
+
23
+ <img src={bytteIkonSrc} alt="Hvordan man bytter ikon i Figma" />
24
+
25
+ Når du trenger et ikon utenfor komponentene lager du et nytt tekstelement, skriver navnet på ikonet, og velger en av tekststilene for ikoner under Text Styles.
26
+
27
+ <img src={velgerTextStilSrc} alt="Hvordan man velger tekststil for ikoner" />
28
+
29
+ Bruk Color Styles for å bytte farge på ikonet.
30
+
31
+ <img src={velgerColorSrc} alt="Hvordan man velger color style for ikonet" />
32
+
33
+ ## SVG-implementasjon
34
+
35
+ 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.
36
+ 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.
37
+
38
+ `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.
39
+
40
+ 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.
41
+ For eksempel vil et åpent hjem-ikon med vekt 300 og størrelse md kunne tas i bruk slik:
42
+
43
+ ```
44
+ import homeIcon from '@sb1/ffe-icons/icons/open/300/md/home.svg';
45
+
46
+ return <Icon fileUrl={homeIcon} size="md" ariaLabel="hjem" />;
47
+ ```
48
+
49
+ 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).
50
+
51
+
52
+ <Canvas of={IconStories.Standard} />
53
+ <Controls of={IconStories.Standard} />
54
+
55
+ `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.
56
+ Setter du en verdi i `size` som ikke stemmer overens med SVG-en, vil resultatet se slik ut:
57
+
58
+ <Canvas of={IconStories.WrongSize} />
59
+
60
+ 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.
61
+
62
+ `aria-hidden` settes automatisk til true, dersom du ikke sender med en verdi i `ariaLabel`:
63
+
64
+ <Canvas of={IconStories.NoAriaLabel} />
65
+
66
+ ## Stil
67
+
68
+ Vi bruker stilen «rounded». Den harmonerer godt med resten av den visuelle identiteten til SpareBank 1.
69
+
70
+ ## Størrelser
71
+
72
+ Velg mellom tykkelsene 300, 400 og 500.
73
+
74
+ <Canvas of={IconStories.Sizes} />
75
+
76
+ ## Tykkelser
77
+
78
+ <Canvas of={IconStories.Weights} />
79
+
80
+ ## Farger
81
+
82
+ Disse fargene brukes som standard:
83
+
84
+ * Light mode: Vann, Fjell, Hvit
85
+ * Dark mode: Vann 70%, Vann 30%, Svart
86
+
87
+ Du kan også velge fra de andre fargene i SpareBank 1-paletten.
88
+
89
+ ## Universell utforming
90
+
91
+ Løsningene våre blir brukt med ulike typer hjelpeteknologi. For at ikonene skal fungere godt med hjelpeteknologi som for
92
+ eksempel skjermlesere er det viktig at de enten har tektsbeskrivelse, eller er tilstrekkelig skjult for hjelpeteknolgi i
93
+ de tilfellene hvor det gir den beste brukeropplevelsen.
94
+
95
+ Når ikonet skal presenteres av hjelpeteknologi legger du inn en beskrivende `aria-label` gjennom `ariaLabel`-propertyen.
96
+
97
+ Ikonene har ARIA `role="graphics-symbol img"`, som gjør at de presenteres som grafikksymboler. `"img"` gjør at ikonene leses
98
+ opp som bilder i tilfeller hvor `"graphics-symbol"` ikke støttes.
99
+
100
+ Når ikonet skal skjules for hjelpeteknologi lar du være å sende med ariaLabel eller setter den til `{null}`·
101
+ Ikonet får da `aria-hidden="true"` og vil ikke presenteres av hjelpeteknologi.
102
+
103
+ Eksempel på tilfelle hvor ikonet skjules: Ikonet ligger i en knapp. Knappeteksten eller aria-labelet til knappen er så
104
+ beskrivende for hva knappen gjør at aria-label på ikonet blir overflødig og bidrar til unødvendig støy med skjermlesere
105
+ og annen hjelpeteknologi.
106
+
107
+ <Canvas of={IconStories.UniversellUtforming} />
@@ -0,0 +1,70 @@
1
+ import React from 'react';
2
+ import { Icon } from './Icon';
3
+ import type { StoryObj, Meta } from '@storybook/react';
4
+ import house300Md from '@sb1/ffe-icons/icons/open/300/md/house.svg';
5
+ import house400Md from '@sb1/ffe-icons/icons/open/400/md/house.svg';
6
+ import house500Md from '@sb1/ffe-icons/icons/open/500/md/house.svg';
7
+ import starSm from '@sb1/ffe-icons/icons/open/300/sm/star.svg';
8
+ import starMd from '@sb1/ffe-icons/icons/open/300/md/star.svg';
9
+ import starLg from '@sb1/ffe-icons/icons/open/300/lg/star.svg';
10
+ import starXl from '@sb1/ffe-icons/icons/open/300/xl/star.svg';
11
+
12
+ const meta: Meta<typeof Icon> = {
13
+ title: 'components/icons/Icon',
14
+ component: Icon,
15
+ };
16
+ export default meta;
17
+
18
+ type Story = StoryObj<typeof Icon>;
19
+
20
+ export const Standard: Story = {
21
+ args: {
22
+ size: 'md',
23
+ ariaLabel: 'hjem',
24
+ fileUrl: house300Md,
25
+ },
26
+ render: args => <Icon {...args} />,
27
+ };
28
+
29
+ export const WrongSize: Story = {
30
+ args: { ...Standard.args, size: 'lg' },
31
+ render: args => <Icon {...args} />,
32
+ };
33
+
34
+ export const NoAriaLabel: Story = {
35
+ args: { ...Standard.args, ariaLabel: undefined },
36
+ render: args => <Icon {...args} />,
37
+ };
38
+
39
+ export const Sizes: Story = {
40
+ args: { ...Standard.args, ariaLabel: undefined },
41
+ render: args => (
42
+ <>
43
+ <Icon fileUrl={starSm} size="sm" ariaLabel="sm stjerne" />
44
+ <Icon fileUrl={starMd} size="md" ariaLabel="md stjerne" />
45
+ <Icon fileUrl={starLg} size="lg" ariaLabel="lg stjerne" />
46
+ <Icon fileUrl={starXl} size="xl" ariaLabel="xl stjerne" />
47
+ </>
48
+ ),
49
+ };
50
+
51
+ export const Weights: Story = {
52
+ args: { ...Standard.args, ariaLabel: undefined },
53
+ render: args => (
54
+ <>
55
+ <Icon fileUrl={house300Md} size="md" ariaLabel="hus" />
56
+ <Icon fileUrl={house400Md} size="md" ariaLabel="hus" />
57
+ <Icon fileUrl={house500Md} size="md" ariaLabel="hus" />
58
+ </>
59
+ ),
60
+ };
61
+
62
+ export const UniversellUtforming: Story = {
63
+ args: { ...Standard.args, ariaLabel: undefined },
64
+ render: args => (
65
+ <>
66
+ <Icon fileUrl={house300Md} size="md" ariaLabel="hus" />
67
+ <Icon fileUrl={house300Md} size="md" />
68
+ </>
69
+ ),
70
+ };
Binary file
Binary file
Binary file
@@ -0,0 +1 @@
1
+ {"root":["../src/Icon.tsx","../src/index.tsx"],"version":"5.6.2"}