@sb1/ffe-chips-react 100.8.3 → 100.10.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 +100 -0
- package/package.json +6 -6
package/README.md
ADDED
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
# @sb1/ffe-chips-react
|
|
2
|
+
|
|
3
|
+
## Beskrivelse
|
|
4
|
+
|
|
5
|
+
Chip-komponenter i tre varianter: `Chip` (standard), `ChipRemovable` (med fjern-knapp) og `ChipSelectable` (kan velges/avvelges).
|
|
6
|
+
|
|
7
|
+
## Installasjon
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install --save @sb1/ffe-chips-react
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Bruk
|
|
14
|
+
|
|
15
|
+
Full dokumentasjon: https://sparebank1.github.io/designsystem/
|
|
16
|
+
|
|
17
|
+
### Importere CSS
|
|
18
|
+
|
|
19
|
+
```css
|
|
20
|
+
@import '@sb1/ffe-chips/css/chip.css';
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Eksempler
|
|
24
|
+
|
|
25
|
+
### Standard Chip
|
|
26
|
+
|
|
27
|
+
```tsx
|
|
28
|
+
import { Chip } from '@sb1/ffe-chips-react';
|
|
29
|
+
import { Icon } from '@sb1/ffe-icons-react';
|
|
30
|
+
|
|
31
|
+
<Chip size="sm" onClick={() => console.log('Klikket')}>
|
|
32
|
+
Liten chip
|
|
33
|
+
</Chip>
|
|
34
|
+
|
|
35
|
+
// Som lenke
|
|
36
|
+
<Chip as="a" href="/side" size="sm">Gå til side</Chip>
|
|
37
|
+
|
|
38
|
+
// Med ikon
|
|
39
|
+
<Chip size="sm" leftIcon={<Icon size="sm" fileUrl="path/to/icon.svg" />}>
|
|
40
|
+
Med ikon
|
|
41
|
+
</Chip>
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### ChipRemovable
|
|
45
|
+
|
|
46
|
+
```tsx
|
|
47
|
+
import { useState } from 'react';
|
|
48
|
+
import { ChipRemovable } from '@sb1/ffe-chips-react';
|
|
49
|
+
|
|
50
|
+
function MyComponent() {
|
|
51
|
+
const [items, setItems] = useState(['Filter 1', 'Filter 2']);
|
|
52
|
+
|
|
53
|
+
return (
|
|
54
|
+
<div style={{ display: 'flex', gap: '8px' }}>
|
|
55
|
+
{items.map(item => (
|
|
56
|
+
<ChipRemovable
|
|
57
|
+
key={item}
|
|
58
|
+
size="sm"
|
|
59
|
+
onClick={() => setItems(items.filter(i => i !== item))}
|
|
60
|
+
>
|
|
61
|
+
{item}
|
|
62
|
+
</ChipRemovable>
|
|
63
|
+
))}
|
|
64
|
+
</div>
|
|
65
|
+
);
|
|
66
|
+
}
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### ChipSelectable
|
|
70
|
+
|
|
71
|
+
```tsx
|
|
72
|
+
import { useState } from 'react';
|
|
73
|
+
import { ChipSelectable } from '@sb1/ffe-chips-react';
|
|
74
|
+
|
|
75
|
+
function MyComponent() {
|
|
76
|
+
const [isSelected, setIsSelected] = useState(false);
|
|
77
|
+
|
|
78
|
+
return (
|
|
79
|
+
<ChipSelectable
|
|
80
|
+
size="sm"
|
|
81
|
+
isSelected={isSelected}
|
|
82
|
+
onClick={() => setIsSelected(!isSelected)}
|
|
83
|
+
>
|
|
84
|
+
{isSelected ? 'Valgt' : 'Velg meg'}
|
|
85
|
+
</ChipSelectable>
|
|
86
|
+
);
|
|
87
|
+
}
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
## TypeScript
|
|
91
|
+
|
|
92
|
+
Komponenter er generiske og støtter polymorfisme via `as`-propen. TypeScript infererer riktige props basert på elementtypen.
|
|
93
|
+
|
|
94
|
+
## Utvikling
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
npm install && npm run build && npm start
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
Lokal Storybook kjører på http://localhost:6006/
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sb1/ffe-chips-react",
|
|
3
|
-
"version": "100.
|
|
3
|
+
"version": "100.10.0",
|
|
4
4
|
"description": "React implementation of ffe-chips component",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"ffe"
|
|
@@ -28,13 +28,13 @@
|
|
|
28
28
|
"test:watch": "ffe-buildtool jest --watch"
|
|
29
29
|
},
|
|
30
30
|
"dependencies": {
|
|
31
|
-
"@sb1/ffe-chips": "^100.
|
|
32
|
-
"@sb1/ffe-core": "^100.
|
|
33
|
-
"@sb1/ffe-icons-react": "^100.
|
|
31
|
+
"@sb1/ffe-chips": "^100.10.0",
|
|
32
|
+
"@sb1/ffe-core": "^100.10.0",
|
|
33
|
+
"@sb1/ffe-icons-react": "^100.10.0",
|
|
34
34
|
"classnames": "^2.5.1"
|
|
35
35
|
},
|
|
36
36
|
"devDependencies": {
|
|
37
|
-
"@sb1/ffe-buildtool": "^100.
|
|
37
|
+
"@sb1/ffe-buildtool": "^100.10.0",
|
|
38
38
|
"react": "^18.2.0",
|
|
39
39
|
"react-dom": "^18.2.0"
|
|
40
40
|
},
|
|
@@ -44,5 +44,5 @@
|
|
|
44
44
|
"publishConfig": {
|
|
45
45
|
"access": "public"
|
|
46
46
|
},
|
|
47
|
-
"gitHead": "
|
|
47
|
+
"gitHead": "efdd3866d59d794436a97a8dd6760f4c76466a71"
|
|
48
48
|
}
|