@sb1/ffe-grid-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.
Files changed (2) hide show
  1. package/README.md +87 -19
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -1,38 +1,106 @@
1
1
  # @sb1/ffe-grid-react
2
2
 
3
- ## Install
3
+ ## Beskrivelse
4
4
 
5
- ```
5
+ Grid-system for responsive layouts (foreldet - bruk CSS Grid eller Flexbox i stedet).
6
+
7
+ - `Grid` - Ytterste container som definerer grid-gapet
8
+ - `GridRow` - Rad-container med støtte for bakgrunnsfarge, margin og padding
9
+ - `GridCol` - Kolonne-container med responsiv bredde (12-kolonners system)
10
+
11
+ ## Installasjon
12
+
13
+ ```bash
6
14
  npm install --save @sb1/ffe-grid-react
7
15
  ```
8
16
 
9
- ## Usage
17
+ ## Bruk
10
18
 
11
- Full documentation on grid usage is available at https://design.sparebank1.no/komponenter/grid/.
19
+ Full dokumentasjon: https://sparebank1.github.io/designsystem/
12
20
 
13
- ## DevTool: Grid overlay
21
+ Importer CSS:
14
22
 
15
- For å lettere inspisere hvordan innholdet legger seg i kolonner, eller for å se hvordan gridden vil kunne passe inn på en eksisterende webside eksporteres det et separat util som vil lage en full-skjerm overlay med kolonner på en eksisterende side. Fra denne modulen eksporteres bare en funksjon som lager en fixed positioned div og det er opp til applikasjonen hvordan man ønsker å bruke den.
23
+ ```css
24
+ @import url('@sb1/ffe-grid/css/ffe-grid.css');
25
+ ```
16
26
 
17
- Et eksempel er
27
+ ## Eksempler
18
28
 
19
- ```javascript
20
- import showGrid from '@sb1/ffe-grid-react/lib/show-grid';
21
- window.showGrid = showGrid;
29
+ ### Import
30
+
31
+ ```tsx
32
+ import { Grid, GridRow, GridCol } from '@sb1/ffe-grid-react';
22
33
  ```
23
34
 
24
- Funksjonen man importerer fra `ffe-grid-react/lib/show-grid` fungerer som en toggle.
35
+ ### Grunnleggende eksempel
25
36
 
26
- ## Development
37
+ ```tsx
38
+ <Grid>
39
+ <GridRow>
40
+ <GridCol sm={6}>Venstre kolonne</GridCol>
41
+ <GridCol sm={6}>Høyre kolonne</GridCol>
42
+ </GridRow>
43
+ </Grid>
44
+ ```
27
45
 
28
- To start a local development server, run the following from the designsystem root folder:
46
+ ### Responsiv layout med breakpoints
29
47
 
30
- ```bash
31
- npm install
32
- npm run build
33
- npm start
48
+ ```tsx
49
+ <Grid>
50
+ <GridRow>
51
+ <GridCol sm={12} md={6} lg={4}>
52
+ Responsiv kolonne
53
+ </GridCol>
54
+ </GridRow>
55
+ </Grid>
56
+ ```
57
+
58
+ ### Offset (forskyvning av kolonner)
59
+
60
+ ```tsx
61
+ <GridCol
62
+ sm={{ cols: 10, offset: 1 }}
63
+ md={{ cols: 8, offset: 2 }}
64
+ lg={{ cols: 6, offset: 3 }}
65
+ >
66
+ Sentert innhold
67
+ </GridCol>
34
68
  ```
35
69
 
36
- A local instance of `Storybook` with live reloading will run at http://localhost:6006/.
70
+ ### Grid med spacing
71
+
72
+ ```tsx
73
+ <Grid gap="lg">
74
+ <GridRow margin="md" padding="sm" bgColor="secondary">
75
+ <GridCol sm={6}>Kolonne 1</GridCol>
76
+ <GridCol sm={6}>Kolonne 2</GridCol>
77
+ </GridRow>
78
+ </Grid>
79
+ ```
80
+
81
+ ### Responsiv spacing på GridRow
82
+
83
+ ```tsx
84
+ <GridRow
85
+ sm={{ margin: 'sm', padding: 'xs' }}
86
+ md={{ margin: 'md', padding: 'sm' }}
87
+ lg={{ margin: 'lg', padding: 'md' }}
88
+ >
89
+ <GridCol sm={12}>Rad med responsiv spacing</GridCol>
90
+ </GridRow>
91
+ ```
92
+
93
+ ## DevTool: Grid overlay
94
+
95
+ ```javascript
96
+ import showGrid from '@sb1/ffe-grid-react/lib/show-grid';
97
+ window.showGrid = showGrid; // Toggle funksjon for grid overlay
98
+ ```
99
+
100
+ ## Utvikling
101
+
102
+ ```bash
103
+ npm install && npm run build && npm start
104
+ ```
37
105
 
38
- Example implementations using the latest versions of all components are also available at https://sparebank1.github.io/designsystem.
106
+ Lokal Storybook på http://localhost:6006/
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sb1/ffe-grid-react",
3
- "version": "100.8.3",
3
+ "version": "100.10.0",
4
4
  "license": "MIT",
5
5
  "author": "SpareBank1",
6
6
  "files": [
@@ -24,11 +24,11 @@
24
24
  "test:watch": "ffe-buildtool jest --watch"
25
25
  },
26
26
  "dependencies": {
27
- "@sb1/ffe-grid": "^100.8.3",
27
+ "@sb1/ffe-grid": "^100.10.0",
28
28
  "classnames": "^2.3.1"
29
29
  },
30
30
  "devDependencies": {
31
- "@sb1/ffe-buildtool": "^100.8.3",
31
+ "@sb1/ffe-buildtool": "^100.10.0",
32
32
  "react": "^18.2.0",
33
33
  "react-dom": "^18.2.0"
34
34
  },
@@ -38,5 +38,5 @@
38
38
  "publishConfig": {
39
39
  "access": "public"
40
40
  },
41
- "gitHead": "f33cf64a467cb430540d1320e763a4f223a8012c"
41
+ "gitHead": "efdd3866d59d794436a97a8dd6760f4c76466a71"
42
42
  }