@sb1/ffe-messages-react 100.8.3 → 100.9.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 +97 -12
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -1,25 +1,110 @@
|
|
|
1
|
-
# @sb1/ffe-
|
|
1
|
+
# @sb1/ffe-messages-react
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## Beskrivelse
|
|
4
4
|
|
|
5
|
+
React-komponenter for meldinger som kommuniserer status, tips og varsler til brukeren.
|
|
6
|
+
|
|
7
|
+
### Komponentoversikt
|
|
8
|
+
|
|
9
|
+
| Komponent | Bruksområde |
|
|
10
|
+
| ----------------- | ----------------------------------------------------------------------------------------- |
|
|
11
|
+
| `SystemMessage` | Globale statusmeldinger øverst på siden. Har alltid lukkeknapp. |
|
|
12
|
+
| `ContextMessage` | Kontekstuell inline-melding i skjemaer eller seksjoner. Valgfri overskrift og lukkeknapp. |
|
|
13
|
+
| `MessageBox` | Innrammet meldingsområde for varig informasjon. Ingen lukkeknapp. |
|
|
14
|
+
| `MessageHeader` | Overskriftkomponent for bruk i meldinger. |
|
|
15
|
+
| `MessageList` | Liste-container for flere meldingspunkter. |
|
|
16
|
+
| `MessageListItem` | Enkelt listepunkt i en `MessageList`. |
|
|
17
|
+
|
|
18
|
+
### Type-verdier
|
|
19
|
+
|
|
20
|
+
**MessageType** (påkrevd): `'info'` | `'success'` | `'tips'` | `'warning'` | `'error'`
|
|
21
|
+
|
|
22
|
+
**Locale** (valgfri, standard `'nb'`): `'nb'` | `'nn'` | `'en'`
|
|
23
|
+
|
|
24
|
+
## Eksempler
|
|
25
|
+
|
|
26
|
+
### SystemMessage
|
|
27
|
+
|
|
28
|
+
```tsx
|
|
29
|
+
import { SystemMessage } from '@sb1/ffe-messages-react';
|
|
30
|
+
|
|
31
|
+
<SystemMessage type="success" onClose={() => console.log('Lukket')}>
|
|
32
|
+
Kontoen ble oppdatert.
|
|
33
|
+
</SystemMessage>;
|
|
5
34
|
```
|
|
6
|
-
|
|
35
|
+
|
|
36
|
+
### ContextMessage
|
|
37
|
+
|
|
38
|
+
```tsx
|
|
39
|
+
import {
|
|
40
|
+
ContextMessage,
|
|
41
|
+
MessageList,
|
|
42
|
+
MessageListItem,
|
|
43
|
+
} from '@sb1/ffe-messages-react';
|
|
44
|
+
|
|
45
|
+
<ContextMessage
|
|
46
|
+
type="error"
|
|
47
|
+
header="Feil i skjema"
|
|
48
|
+
closeButton={true}
|
|
49
|
+
compact={true}
|
|
50
|
+
onClose={() => console.log('Lukket')}
|
|
51
|
+
>
|
|
52
|
+
<MessageList>
|
|
53
|
+
<MessageListItem>Personnummer mangler</MessageListItem>
|
|
54
|
+
<MessageListItem>Adresse er ugyldig</MessageListItem>
|
|
55
|
+
</MessageList>
|
|
56
|
+
</ContextMessage>;
|
|
7
57
|
```
|
|
8
58
|
|
|
9
|
-
|
|
59
|
+
### MessageBox
|
|
60
|
+
|
|
61
|
+
```tsx
|
|
62
|
+
import { MessageBox, MessageHeader } from '@sb1/ffe-messages-react';
|
|
10
63
|
|
|
11
|
-
|
|
64
|
+
<MessageBox type="info" header={<MessageHeader as="h3">Viktig</MessageHeader>}>
|
|
65
|
+
Husk å lagre endringer før du går videre.
|
|
66
|
+
</MessageBox>;
|
|
67
|
+
```
|
|
12
68
|
|
|
13
|
-
|
|
69
|
+
### MessageHeader
|
|
14
70
|
|
|
15
|
-
|
|
71
|
+
```tsx
|
|
72
|
+
import { MessageHeader } from '@sb1/ffe-messages-react';
|
|
73
|
+
|
|
74
|
+
<MessageHeader as="h3">Overskrift</MessageHeader>;
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### MessageList og MessageListItem
|
|
78
|
+
|
|
79
|
+
```tsx
|
|
80
|
+
import { MessageList, MessageListItem } from '@sb1/ffe-messages-react';
|
|
81
|
+
|
|
82
|
+
<MessageList>
|
|
83
|
+
<MessageListItem>E-postadresse er ugyldig</MessageListItem>
|
|
84
|
+
<MessageListItem>Telefonnummer må ha 8 siffer</MessageListItem>
|
|
85
|
+
</MessageList>;
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## Installasjon
|
|
16
89
|
|
|
17
90
|
```bash
|
|
18
|
-
npm install
|
|
19
|
-
npm run build
|
|
20
|
-
npm start
|
|
91
|
+
npm install --save @sb1/ffe-messages-react
|
|
21
92
|
```
|
|
22
93
|
|
|
23
|
-
|
|
94
|
+
Krever CSS fra `@sb1/ffe-messages`:
|
|
95
|
+
|
|
96
|
+
```css
|
|
97
|
+
@import '@sb1/ffe-messages/css/messages.css';
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## Bruk
|
|
101
|
+
|
|
102
|
+
Dokumentasjon: https://sparebank1.github.io/designsystem/
|
|
103
|
+
|
|
104
|
+
## Utvikling
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
npm install && npm run build && npm start
|
|
108
|
+
```
|
|
24
109
|
|
|
25
|
-
|
|
110
|
+
Storybook kjører på http://localhost:6006/.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sb1/ffe-messages-react",
|
|
3
|
-
"version": "100.
|
|
3
|
+
"version": "100.9.0",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"author": "SpareBank 1",
|
|
6
6
|
"files": [
|
|
@@ -24,12 +24,12 @@
|
|
|
24
24
|
"test:watch": "ffe-buildtool jest --watch"
|
|
25
25
|
},
|
|
26
26
|
"dependencies": {
|
|
27
|
-
"@sb1/ffe-icons-react": "^100.
|
|
28
|
-
"@sb1/ffe-messages": "^100.
|
|
27
|
+
"@sb1/ffe-icons-react": "^100.9.0",
|
|
28
|
+
"@sb1/ffe-messages": "^100.9.0",
|
|
29
29
|
"classnames": "^2.3.1"
|
|
30
30
|
},
|
|
31
31
|
"devDependencies": {
|
|
32
|
-
"@sb1/ffe-buildtool": "^100.
|
|
32
|
+
"@sb1/ffe-buildtool": "^100.9.0",
|
|
33
33
|
"eslint": "^9.22.0",
|
|
34
34
|
"react": "^18.2.0",
|
|
35
35
|
"react-dom": "^18.2.0"
|
|
@@ -40,5 +40,5 @@
|
|
|
40
40
|
"publishConfig": {
|
|
41
41
|
"access": "public"
|
|
42
42
|
},
|
|
43
|
-
"gitHead": "
|
|
43
|
+
"gitHead": "41f20cf10bec5ebe53036c282690983d2114fb45"
|
|
44
44
|
}
|