@oslokommune/punkt-css 0.18.2

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 (77) hide show
  1. package/CHANGELOG.md +260 -0
  2. package/CONTRIBUTING.md +116 -0
  3. package/LICENSE +23 -0
  4. package/README.md +221 -0
  5. package/dist/css/components/alert.css +111 -0
  6. package/dist/css/components/alert.min.css +1 -0
  7. package/dist/css/components/backlink.css +38 -0
  8. package/dist/css/components/backlink.min.css +1 -0
  9. package/dist/css/components/badge.css +52 -0
  10. package/dist/css/components/badge.min.css +1 -0
  11. package/dist/css/components/breadcrumbs.css +116 -0
  12. package/dist/css/components/breadcrumbs.min.css +1 -0
  13. package/dist/css/components/footer.css +48 -0
  14. package/dist/css/components/footer.min.css +1 -0
  15. package/dist/css/components/header.css +123 -0
  16. package/dist/css/components/header.min.css +1 -0
  17. package/dist/css/components/icon.css +63 -0
  18. package/dist/css/components/icon.min.css +1 -0
  19. package/dist/css/components/teaserlist.css +53 -0
  20. package/dist/css/components/teaserlist.min.css +1 -0
  21. package/dist/css/pkt-base.css +9721 -0
  22. package/dist/css/pkt-base.min.css +1 -0
  23. package/dist/css/pkt-components.css +611 -0
  24. package/dist/css/pkt-components.min.css +1 -0
  25. package/dist/css/pkt-elements.css +881 -0
  26. package/dist/css/pkt-elements.min.css +1 -0
  27. package/dist/css/pkt-normalise.css +221 -0
  28. package/dist/css/pkt-normalise.min.css +1 -0
  29. package/dist/css/pkt.css +11415 -0
  30. package/dist/css/pkt.min.css +1 -0
  31. package/dist/scss/abstracts/_index.scss +3 -0
  32. package/dist/scss/abstracts/functions/_index.scss +65 -0
  33. package/dist/scss/abstracts/mixins/_breakpoints.scss +60 -0
  34. package/dist/scss/abstracts/mixins/_index.scss +2 -0
  35. package/dist/scss/abstracts/mixins/_typography.scss +45 -0
  36. package/dist/scss/abstracts/placeholders/_index.scss +19 -0
  37. package/dist/scss/abstracts/variables/_breakpoints.scss +8 -0
  38. package/dist/scss/abstracts/variables/_colors.scss +55 -0
  39. package/dist/scss/abstracts/variables/_index.scss +24 -0
  40. package/dist/scss/abstracts/variables/_spacing.scss +22 -0
  41. package/dist/scss/abstracts/variables/_typography.scss +430 -0
  42. package/dist/scss/base/_accessibility.scss +11 -0
  43. package/dist/scss/base/_colors.scss +24 -0
  44. package/dist/scss/base/_containers.scss +75 -0
  45. package/dist/scss/base/_defaults.scss +48 -0
  46. package/dist/scss/base/_grid.scss +114 -0
  47. package/dist/scss/base/_index.scss +9 -0
  48. package/dist/scss/base/_oslo-sans.scss +21 -0
  49. package/dist/scss/base/_spacing.scss +109 -0
  50. package/dist/scss/base/_typography.scss +102 -0
  51. package/dist/scss/base/_visibility.scss +28 -0
  52. package/dist/scss/components/_alert.scss +153 -0
  53. package/dist/scss/components/_backlink.scss +50 -0
  54. package/dist/scss/components/_badge.scss +59 -0
  55. package/dist/scss/components/_breadcrumbs.scss +130 -0
  56. package/dist/scss/components/_footer.scss +52 -0
  57. package/dist/scss/components/_header.scss +125 -0
  58. package/dist/scss/components/_icon.scss +83 -0
  59. package/dist/scss/components/_index.scss +8 -0
  60. package/dist/scss/components/_teaserlist.scss +56 -0
  61. package/dist/scss/elements/_button.scss +412 -0
  62. package/dist/scss/elements/_form.scss +190 -0
  63. package/dist/scss/elements/_hr.scss +8 -0
  64. package/dist/scss/elements/_image.scss +32 -0
  65. package/dist/scss/elements/_index.scss +8 -0
  66. package/dist/scss/elements/_list.scss +104 -0
  67. package/dist/scss/elements/_section.scss +98 -0
  68. package/dist/scss/elements/_select.scss +82 -0
  69. package/dist/scss/elements/_table.scss +80 -0
  70. package/dist/scss/normalise/_index.scss +241 -0
  71. package/dist/scss/pkt-base.scss +4 -0
  72. package/dist/scss/pkt-components.scss +4 -0
  73. package/dist/scss/pkt-elements.scss +4 -0
  74. package/dist/scss/pkt-normalise.scss +4 -0
  75. package/dist/scss/pkt.scss +13 -0
  76. package/index.js +1 -0
  77. package/package.json +40 -0
package/CHANGELOG.md ADDED
@@ -0,0 +1,260 @@
1
+ # Changelog
2
+
3
+ Alle nevneverdige endringer av prosjektet dokumenteres her.
4
+
5
+ ## [0.18.1] - 2022-10-31
6
+ `rettet` Bug i knapp. Text-align center og ikke la ikoner krympe [#466](https://github.com/oslokommune/oslo-designsystem/issues/466)
7
+
8
+ ## [0.18.0] - 2022-10-10
9
+ `rettet` Stiler i designsystemets CSS overstyrer default liste-stiler for mye [#435](https://github.com/oslokommune/oslo-designsystem/issues/435)
10
+
11
+ ## [0.17.1] - 2022-08-25
12
+ `rettet` Flex-start alignment på enkel alert
13
+
14
+ ## [0.17.0] - 2022-08-25
15
+ - `rettet` Underline på linker
16
+ - `rettet` Breakpoint i header
17
+ - `forbedret` Breaking changes på alert - fjernet liten alert, forenklet strukturen og fjernet tile som klasse
18
+ [#388](https://github.com/oslokommune/oslo-designsystem/issues/388)
19
+
20
+ ## [0.16.0] - 2022-08-18
21
+ `forbedret` Oppdater header [#390](https://github.com/oslokommune/oslo-designsystem/issues/390)
22
+
23
+ ## [0.15.0] - 2022-08-17
24
+ `forbedret` Oppdater footer [#389](https://github.com/oslokommune/oslo-designsystem/issues/389)
25
+ Linkene har fått ikon, ny klasse: `ods-footer__link-icon`
26
+
27
+ ## [0.14.4] - 2022-08-12
28
+ `rettet` Feil link-font-color på dark mode.
29
+
30
+ ## [0.14.3] - 2022-08-09
31
+
32
+ - `rettet` Lenker stylet som ods-btn har feil default text-decoration [#393](https://github.com/oslokommune/oslo-designsystem/issues/393)
33
+
34
+ ## [0.14.2] - 2022-08-09
35
+
36
+ - `rettet` Legg til p i alert uten tile [#391](https://github.com/oslokommune/oslo-designsystem/issues/391)
37
+
38
+ ## [0.14.1] - 2022-07-07
39
+
40
+ - `rettet` Feil casing på font-family i CSS-rammeverket [#383](https://github.com/oslokommune/oslo-designsystem/issues/383)
41
+
42
+ ## [0.14.0] - 2022-06-10
43
+
44
+ - `nytt` Legg til scss for ny komponent BackLink [#377](https://github.com/oslokommune/oslo-designsystem/issues/377)
45
+
46
+ ## [0.13.5] - 2022-06-10
47
+
48
+ - `forbedret` Legg til en penere versjon av svg-ikonet qr-code
49
+
50
+ ## [0.13.4] - 2022-06-10
51
+
52
+ - `nytt` Legg til svg-ikonet qr-code
53
+
54
+ ## [0.13.3] - 2022-06-03
55
+
56
+ - `rettet` Fjern overflow-x på ods-container som skapte reale scrolling-problemer [#374](https://github.com/oslokommune/oslo-designsystem/issues/374)
57
+
58
+ ## [0.13.2] - 2022-06-03
59
+
60
+ - `rettet` Rettet feil i svg-ikonet car.svg
61
+
62
+ ## [0.13.1] - 2022-06-03
63
+
64
+ - `nytt` Legg til svg-ikonene car og drinking-area-refreshments
65
+
66
+ ## [0.13.0] - 2022-06-01
67
+
68
+ - `forbedret` Oppdater footer i hht nytt design [#360](https://github.com/oslokommune/oslo-designsystem/issues/360)
69
+
70
+ ## [0.12.1] - 2022-05-28
71
+
72
+ - `rettet` Rett feil i CSS for header-komponent
73
+
74
+ ## [0.12.0] - 2022-05-28
75
+
76
+ - `forbedret` Oppdater header i hht nytt design [#361](https://github.com/oslokommune/oslo-designsystem/issues/361)
77
+
78
+ ## [0.11.1] - 2022-05-06
79
+
80
+ - `nytt` Legg til svg-ikonene fire-safety, react, vue, wine-bottle [#332](https://github.com/oslokommune/oslo-designsystem/issues/332)
81
+
82
+ ## [0.11.0] - 2022-04-25
83
+
84
+ - `forbedret` Oppdater alert-komponent med ny struktur og variant (tiles) [#313](https://github.com/oslokommune/oslo-designsystem/issues/313)
85
+
86
+ ## [0.10.0] - 2022-03-27
87
+
88
+ - `forbedret` Forbedre kom i gang-dokumentasjonen [#112](https://github.com/oslokommune/oslo-designsystem/issues/112)
89
+ - `endret` Endre stien for bruk av ressursene ved å legge på en dist-folder. Dette er gjort for å holde folderstrukturen konsisent under utvikling og produksjon.
90
+
91
+ ### Eksempel
92
+
93
+ ```sh
94
+ # Før
95
+ @oslokommune/oslo-designsystem
96
+ ├── css/
97
+ ├── fonts/
98
+ ├── icons/
99
+ ├── logos/
100
+ └── scss/
101
+
102
+ # Nå
103
+ @oslokommune/oslo-designsystem
104
+ ├── dist/
105
+ | ├── css/
106
+ | ├── fonts/
107
+ | ├── icons/
108
+ | ├── logos/
109
+ | └── scss/
110
+ ```
111
+
112
+ ```scss
113
+ /* Før */
114
+ @use '@oslokommune/oslo-designsystem/scss/ods';
115
+
116
+ /* Nå */
117
+ @use '@oslokommune/oslo-designsystem/dist/scss/ods';
118
+ ```
119
+
120
+ ## [0.7.0] - 2022-03-14
121
+
122
+ - `forbedret` Lagt til alert-stil
123
+
124
+ ## [0.6.4] - 2022-03-10
125
+
126
+ - `forbedret` Oppdatert lock og unlocked ikoner
127
+
128
+ ## [0.6.3] - 2022-03-09
129
+
130
+ - `forbedret` Legg til container-stiler i Scss [#237](https://github.com/oslokommune/oslo-designsystem/issues/237)
131
+
132
+ ## [0.6.2] - 2022-03-01
133
+
134
+ - `nytt` Nye logoer - Mennesker og helse
135
+
136
+ ## [0.6.1] - 2022-03-01
137
+
138
+ - `nytt` Ny logo - law-paragraph
139
+
140
+ ## [0.6.0] - 2022-02-25
141
+
142
+ - `oslo-designsystem-vue` har fått Header, Footer og
143
+ Breadcrumbs-komponenter, og stilene til disse er nå
144
+ optimalisert og flyttet hit til css-rammeverket
145
+ for gjenbruk.
146
+ - `forbedret` Lag breadcrumbs-komponent i Vue [#208](https://github.com/oslokommune/oslo-designsystem/issues/208)
147
+ - `forbedret` Lag header-komponent i Vue [#209](https://github.com/oslokommune/oslo-designsystem/issues/209)
148
+ - `forbedret` Lag footer-komponent i Vue [#210](https://github.com/oslokommune/oslo-designsystem/issues/210)
149
+
150
+ ## [0.5.0] - 2022-02-23
151
+
152
+ - `forbedret` Informasjon om Universell utforming lagt til på nettstedet.
153
+
154
+ ## [0.4.3] - 2022-01-17
155
+
156
+ - `forbedret` Forbedre stilsetting av lenker og dokumentasjonen av disse. I tillegg legges svgo konfig-filen til, som sikrer konsistent SVG-kode [#199](https://github.com/oslokommune/oslo-designsystem/issues/199)
157
+
158
+ ## [0.4.2] - 2022-01-16
159
+
160
+ - `forbedret` Tilgjengeliggjør individuelle css-filer til hver komponent [#197](https://github.com/oslokommune/oslo-designsystem/issues/197)
161
+
162
+ ## [0.4.1] - 2022-01-06
163
+
164
+ - `forbedret` Forbedre dokumentasjonen rundt ressurser og hva som finnes på CDN [#196](https://github.com/oslokommune/oslo-designsystem/issues/196)
165
+
166
+ ## [0.4.0] - 2022-01-03
167
+
168
+ - `feilet` Kun et lite versjonshopp.
169
+
170
+ ## [0.3.0] - 2022-01-03
171
+
172
+ - `forbedret` Ressursene har fått etterlengtet oppmerksomhet, og
173
+ dokumentasjonen inneholder nå oversikt over alle ressurser som er
174
+ tilgjengelig. SVG-ikonene har fått egen side som viser alle
175
+ tilgjengelige, og informasjon om ulike måter å bruke disse på
176
+ [#189](https://github.com/oslokommune/oslo-designsystem/issues/189).
177
+
178
+ ## [0.2.3] - 2021-12-06
179
+
180
+ - `forbedret` Legg til ny farge "blue-5" og juster farge-dokumentasjonen bittelitt [#192](https://github.com/oslokommune/oslo-designsystem/issues/192)
181
+
182
+ ## [0.2.2] - 2021-12-06
183
+
184
+ - `forbedret` Forbedring av UU på nettstedet og en total gjennomgang av button elementet med nye muligheter [#188](https://github.com/oslokommune/oslo-designsystem/issues/188)
185
+
186
+ ## [0.2.1] - 2021-11-02
187
+
188
+ - `rettet` Rett feil i merge og i dokumentasjonen etter gårsdagens 0.2.0 release.
189
+
190
+ ## [0.2.0] - 2021-11-01
191
+
192
+ - `forbedret` Forbedre Sass organisering, som gjør at alt er på
193
+ stell når vi nå går videre til produksjon av elementer. Denne
194
+ reorganiseringen medfører at noen moduler flytter på seg, men ved
195
+ hjelp av beskrivelsen under burde det være fikset på 5-10
196
+ minutter [#176](https://github.com/oslokommune/oslo-designsystem/issues/176).
197
+ - `rettet` Forbedre kontrast på inline kode [#166](https://github.com/oslokommune/oslo-designsystem/issues/166)
198
+ - `rettet` Endre systemfarge. Dette er kun en endring av fargekode [#171](https://github.com/oslokommune/oslo-designsystem/issues/171)
199
+ - `rettet` En rekke forbedringer og noen bugfixer på nettsiden.
200
+
201
+ ### Eksempel
202
+
203
+ Denne endringen påvirker kun de som har tatt i bruk Sass-moduler. Om du kun har tatt i bruk CSS så har ingen endring skjedd.
204
+
205
+ Oppgaven endrer navn på folderen `/config` --> `/abstracts` og oppretter `/variables`, `/functions`, og `/mixins` som undermapper for å samle alle globale Sass variabler og verktøy. Prinsippet er at ingenting i disse folderne skal generere en eneste linje CSS når den er kompilert på egen hånd. Disse er bare Sass hjelpeverktøy.
206
+
207
+ Evt referanser til gamle settings-filen, f.eks `/config/settings` må derfor rettes til `/abstracts/variables`. Samme med referanser til breakpoints: `/base/breakpoints` er nå `/abstracts/mixins/breakpoints`.
208
+
209
+ Resultatet er mer ryddig oppsett med klart skille av oppgaver, og med det hindrer duplisering av kode som ble funnet i tidligere versjoner.
210
+
211
+ ### Full Changelog
212
+
213
+ https://github.com/oslokommune/oslo-designsystem/compare/ods-design-0.1.5...ods-design-0.2.0
214
+
215
+ ## [0.1.5] - 2021-10-28
216
+
217
+ - `rettet` Referanser til fonter feiler når sass loades fra annen
218
+ sass-fil [#177](https://github.com/oslokommune/oslo-designsystem/issues/177). Å ta i bruk designsystemets Sass-filer har medført flere problemer til nå, bl.a at referansen til fontene ble feil. Denne releasen muliggjør konfigurering av denne, se på [For utviklere](https://designsystem.oslo.kommune.no/0.1.5/kom-i-gang/for-utviklere/index). Anbefalt måte å ta i bruk designsystemet er å gjøre det fra din main.scss fil, og fra denne releasen er det forhåpentligvis lettere å bruke Sass variables, functions og mixins.
219
+ - `endret` Filene ods-all.css og ods-all.scss har skiftet navn til ods.[css|scss]. Dette er gjort for å bedre default namespacing, som kommer fra filnavnet.
220
+
221
+ **Full Changelog**: https://github.com/oslokommune/oslo-designsystem/compare/ods-design-0.1.4...ods-design-0.1.5
222
+
223
+ ## [0.1.4] - 2021-10-27
224
+
225
+ - `rettet` Fiks feil hex-koder i dokumentasjonen by @ceciliehrr [#179](https://github.com/oslokommune/oslo-designsystem/issues/179)
226
+ - `ny bidragsyter` @ceciliehrr lagde sin første PR i https://github.com/oslokommune/oslo-designsystem/pull/180
227
+
228
+ **Full Changelog**: https://github.com/oslokommune/oslo-designsystem/compare/ods-design-0.1.3...ods-design-0.1.4
229
+
230
+ ## [0.1.3] - 2021-10-16
231
+
232
+ - `rettet` Ikke send med nuxtjs og andre dependencies til brukere [#168](https://github.com/oslokommune/oslo-designsystem/issues/168)
233
+
234
+ ## [0.1.2] - 2021-10-14
235
+
236
+ - `rettet` Trigge henting av versjoner på undersider [#164](https://github.com/oslokommune/oslo-designsystem/issues/164)
237
+
238
+ ## [0.1.1] - 2021-10-14
239
+
240
+ - `forbedret` Nettside - Innholdsforbedringer på forsiden
241
+ - `forbedret` Nettside - Innholdsforbedringer på Bidra-siden
242
+
243
+ ## [0.1.0] - 2021-10-14
244
+
245
+ - `endret` Etter en grundig gjennomgang av design tokens og
246
+ typografi-oppsett inneholder denne releasen en rekke fundamentale
247
+ endringer fra tidligere versjoner. Dette krever at oppgradering
248
+ krever litt søk og erstatt. En [oppgraderingsguide](https://github.com/oslokommune/oslo-designsystem/wiki/Oppgraderingsguide-til-v0.1.0)er laget for å avhjelpe disse endringene.
249
+ - `endret` Grunnleggende systemer - farger [#81](https://github.com/oslokommune/oslo-designsystem/issues/81)
250
+ - `endret` Grunnleggende systemer - spacing [#96](https://github.com/oslokommune/oslo-designsystem/issues/96)
251
+ - `endret` Grunnleggende systemer - breakpoints [#95](https://github.com/oslokommune/oslo-designsystem/issues/95)
252
+ - `endret` Grunnleggende systemer - grids & layout [#78](https://github.com/oslokommune/oslo-designsystem/issues/78)
253
+ - `endret` Grunnleggende systemer - tekst [#94](https://github.com/oslokommune/oslo-designsystem/issues/94)
254
+ - `forbedret` Lage CDN for assets [#146](https://github.com/oslokommune/oslo-designsystem/issues/146)
255
+ - `forbedret` Nettside - Forebedre design og layout [#118](https://github.com/oslokommune/oslo-designsystem/issues/118)
256
+ - `forbedret` Nettside - Lenke til alle versjoner [#93](https://github.com/oslokommune/oslo-designsystem/issues/93)
257
+ - `forbedret` En rekke forbedringer er gjort på CI/CD og AWS
258
+ oppsett rundt caching, versjonering, forbedret developer
259
+ experience, mm.
260
+ - `forbedret` Forbedringer i dokumentasjonen
@@ -0,0 +1,116 @@
1
+ ## Guide til hvordan du kan bidra ⭐
2
+
3
+ Vi er veldig happy med at du vurderer å bidra! Om du er usikker på noe som helst,
4
+ ta kontakt. Eller bare send inn den buggen eller PRen uansett. Verste som skjer
5
+ er at vi høflig ber deg endre på noe. **Vi setter pris på alle hyggelige bidrag!**
6
+
7
+ Vi oppfordrer deg til å starte med å lese vår
8
+ [overordnede guide for å bidra](https://designsystem.oslo.kommune.no/latest/bidra/index).
9
+
10
+ Happy coding!
11
+
12
+ ## Forutsetninger
13
+
14
+ - Node 16.5 er installert
15
+ - Kunnskap om [Sass (SCSS)](https://sass-lang.com/) og [CSS](https://developer.mozilla.org/en-US/docs/Web/CSS).
16
+ - Forståelse av [BEM-navnekonvensjoner](http://getbem.com/) som designsystemet følger.
17
+ - Skal du jobbe med [SVG](https://developer.mozilla.org/en-US/docs/Web/SVG) er det nyttig å kunne litt om det.
18
+ - Noen skal ha designet komponenten i [Figma](https://www.figma.com/file/Eej5jm3jIUjeMfzLE0aOTB/Oslo-Designsystem) (Krever innlogging og tilgang).
19
+
20
+ ## Bli kjent med koden
21
+
22
+ ```sh
23
+ src # oslologo og diverse favicons
24
+ └── scss/ # css-rammeverket med dets moduler
25
+ ```
26
+
27
+ ### Litt mer detaljer om SCSS-folderen
28
+
29
+ Skal du jobbe med CSS-rammeverket er dette stedet å starte.
30
+
31
+ ```sh
32
+ scss
33
+ ├── abstracts/ # Variabler, funksjoner, mixins: Sass-verktøy som ikke generer CSS.
34
+ | ├── functions/ # Kodeblokker som returnerer enkeltverdier av en eller annen Sass data type.
35
+ | ├── mixins/ # Kodeblokker som genererer Sass kode som igjen kompilerer til CSS-stiler.
36
+ | ├── placeholders/ # Lik class selectors som ikke genereres uten at de er tatt i bruk (extended).
37
+ | └── variables/ # Variabler eller design tokens som de kalles er fundamentet til rammeverket.
38
+ ├── base/ # Grunnleggende moduler som farger, grid, fonter, tekststiler, mm.
39
+ ├── components/ # Både enkle og mer komplekse komponenter. Grunnlag for komponent-bibliotekene.
40
+ ├── elements/ # HTML-elementer som er stylet, som knapper, lister og tabeller.
41
+ └── normalise/ # En ganske liten normalisering for å ha en felles baseline.
42
+ ```
43
+
44
+ Abstracts består av konfigurasjonen og hjelpeverktøyene til CSS-rammeverket. Ingenting under denne
45
+ folderen skal generere en eneste linje CSS når den er kompilert på egen hånd.
46
+
47
+ Folderen `/variables` er en samling Sass-variabler skrevet på formen
48
+ [Sass maps](https://sass-lang.com/documentation/modules/map). Dette
49
+ gir en fin måte å kategorisere variablene og gir mulighet for nested
50
+ maps.
51
+
52
+ Eksempel:
53
+
54
+ ```scss
55
+ /* abstracts/variables/_breakpoints.scss */
56
+
57
+ $breakpoints: (
58
+ 'mobile': 0,
59
+ 'phablet': 36rem /* ~576px */,
60
+ 'tablet': 48rem /* ~768px */,
61
+ 'tablet-big': 64rem /* ~1024px */,
62
+ 'laptop': 80rem /* ~1280px */,
63
+ 'desktop': 100rem /* ~1600px */,
64
+ ) !default;
65
+ ```
66
+ ## Nyttige script
67
+
68
+ Enn så lenge må du bevege deg til `packages/css` og kjøre script fra der.
69
+
70
+ ```sh
71
+ npm install # Installer avhengigheter
72
+ npm run watch # Bygger koden til ./dist/ hver gang filer under ./src/ oppdateres
73
+ npm run build # Bygger koden til ./dist/
74
+ ```
75
+
76
+
77
+ ### 4. Testing
78
+
79
+ Test css-komponentene i Vite-appen, kjør:
80
+
81
+ ```sh
82
+ npm install
83
+ npm run dev
84
+ ```
85
+
86
+ Vi bruker cli til å legge til svg'er i test-appen.
87
+ Legg inn ønsket ikon i `dev/punkt.config.json`, kjør `punkt svg sprite` så vil den være tilgjengelig globalt ved å bruke komponenten `pkt-icon`.
88
+
89
+ ```html
90
+ <pkt-icon
91
+ name="oslologo"
92
+ viewBox="0 0 60 31"
93
+ ></pkt-icon>
94
+ ```
95
+
96
+ Legg til ny komponent ved å lage en html-fil i components-mappen.
97
+ Legg til komponenten i navigasjonen i `main.js` og legg til en `option` i `select` som du finner i `index.html`
98
+
99
+ ### 5. GitHub Message
100
+ Når du er klar for en PR skriv din GitHub-message med issue-nummer og [asset], [docs] eller [repo]:
101
+
102
+ ```
103
+ [#NNN][docs] Oppdater dokumentasjonen
104
+ [#NNN][assets] Legg til nytt ikon
105
+ ```
106
+
107
+ ## Publisering og versjonering
108
+
109
+ Vi tar oss av publisering av pakken og versjonering.
110
+
111
+ Oslo Designsystem bruker [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html) for versjonering av pakkene.
112
+
113
+ Mens vi er i en beta-fase, versjonering vil følge dette mønsteret: **v0.Y.Z**, hvor
114
+
115
+ - **Y**: Major (breaking changes)
116
+ - **Z**: Minor eller patch
package/LICENSE ADDED
@@ -0,0 +1,23 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2021-present Oslo kommune, Team Min side
4
+ <team-minside@oslo.kommune.no>
5
+
6
+ Permission is hereby granted, free of charge, to any person obtaining
7
+ a copy of this software and associated documentation files (the
8
+ "Software"), to deal in the Software without restriction, including
9
+ without limitation the rights to use, copy, modify, merge, publish,
10
+ distribute, sublicense, and/or sell copies of the Software, and to
11
+ permit persons to whom the Software is furnished to do so, subject to
12
+ the following conditions:
13
+
14
+ The above copyright notice and this permission notice shall be
15
+ included in all copies or substantial portions of the Software.
16
+
17
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
18
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
20
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
21
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
22
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
23
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,221 @@
1
+ ## Bruk av @oslokommune/oslo-designsystem
2
+
3
+ <a href="https://www.npmjs.com/package/@oslokommune/oslo-designsystem" target="_blank"><img src="https://img.shields.io/npm/v/@oslokommune/oslo-designsystem?logo=sass&label=ressurser&style=for-the-badge&color=bf4080" alt="Ressurs versjon" /></a>
4
+
5
+
6
+ Denne pakken inneholder CSS-rammeverket som gjenspeiler skissene i Figma. Det er ikke automatikk mellom Figma og denne koden, så kode vil som regel henge litt etter hva som oppdateres i Figma.
7
+
8
+ ## Innhold
9
+
10
+ ```sh
11
+ @oslokommune/oslo-designsystem
12
+ ├── dist/ # Distribusjonsversjonen av pakken (lagt til i 0.10.0)
13
+ | ├── css/ # generert css
14
+ | | ├── components/ # hver komponent separat
15
+ | | | ├── alert.css # komponent alert
16
+ | | | └── ...
17
+ | | ├── pkt.css # alle moduler
18
+ | | ├── pkt.min.css # alle moduler minimert
19
+ | | ├── pkt-base.css # base modul
20
+ | | ├── pkt-base.min.css # base modul minimert
21
+ | | ├── pkt-components.css # komponent modul med alle komponenter
22
+ | | ├── pkt-components.min.css # komponent modul minimert
23
+ | | ├── pkt-elements.css # element modul
24
+ | | ├── pkt-elements.min.css # element modul minimert
25
+ | | ├── pkt-normalise.css # normalisering modul
26
+ | | └── pkt-normalise.min.css # normalisering modul minimert
27
+ | └── scss/ # css-rammeverket med dets moduler
28
+ ├── CHANGELOG.md # alle nevneverdige endringer
29
+ ├── index.js # peker på komplett rammeverk
30
+ ├── LICENSE # MIT lisens
31
+ ├── package.json # all info om prosjektet
32
+ └── README.md # kom i gang-informasjon
33
+ ```
34
+
35
+ ## 🚀 Kom i gang
36
+
37
+ Eksempelet under viser installasjon i en applikasjon med `Vue 3` + `Vite`.
38
+
39
+ ### 1. Installer designsystemet
40
+
41
+ ```sh
42
+ npm add -D sass # Viktig å bruke denne og ikke node-sass
43
+ npm add @oslokommune/oslo-designsystem
44
+ ```
45
+
46
+ ### 2. Opprett en scss-fil
47
+
48
+ ```sh
49
+ touch ./src/main.scss # her eller i en egen css-folder
50
+ ```
51
+
52
+ ### 3. Importer scss-filen
53
+
54
+ ```js
55
+ // src/main.js
56
+ import "./main.scss";
57
+ ```
58
+
59
+ ### 4. Importer Punkt
60
+
61
+ ```scss
62
+ /* src/main.scss
63
+
64
+ Overstyr stien til fontene (rammeverkspesifikt) */
65
+ @use "@oslokommune/oslo-designsystem/dist/scss/abstracts/variables" with (
66
+ $font-path: "@oslokommune/oslo-designsystem/dist"
67
+ );
68
+
69
+ /* Bruk designsystemet */
70
+ @use "@oslokommune/oslo-designsystem/dist/scss/ods";
71
+ ```
72
+
73
+ ### 5. Fjern lokal css
74
+
75
+ ```scss
76
+ /* src/App.vue
77
+
78
+ Fjern app-spesifikk fontoppsett */
79
+ font-family: Avenir, Helvetica, Arial, sans-serif;
80
+ ```
81
+
82
+ ### 6. Legg på klasse på sidetittel
83
+
84
+ ```scss
85
+ /* src/main.scss
86
+
87
+ Legg til responsiv header */
88
+ @use "sass:map";
89
+ @use "@oslokommune/oslo-designsystem/dist/scss/abstracts/variables";
90
+ /* Legg merke til at breakpoints hentes inn uten namespace: */
91
+ @use "@oslokommune/oslo-designsystem/dist/scss/abstracts/mixins/breakpoints" as *;
92
+ @use "@oslokommune/oslo-designsystem/dist/scss/abstracts/mixins/typography";
93
+
94
+ .h1 {
95
+ @include typography.get-text("pkt-txt-28");
96
+ margin-bottom: map.get(variables.$spacing, "size-30");
97
+
98
+ @include bp("tablet-up") {
99
+ @include typography.get-text("pkt-txt-36");
100
+ }
101
+ }
102
+ ```
103
+
104
+ ```html
105
+ <!-- src/components/HelloWorld.vue
106
+
107
+ Legg til den nye klassen -->
108
+ <h1 class="h1">{{ msg }}</h1>
109
+ ```
110
+
111
+ ### 7. Legg til OsloLogo
112
+
113
+ ```html
114
+ <!-- src/App.vue
115
+
116
+ Legg til logo -->
117
+ <img
118
+ class="oslologo"
119
+ alt="Oslo kommune logo"
120
+ src="@oslokommune/oslo-designsystem/dist/logos/oslo-kommune.svg"
121
+ />
122
+
123
+ <style lang="scss">
124
+ /* Legg til moduler */
125
+ @use "sass:map";
126
+ @use "@oslokommune/oslo-designsystem/dist/scss/abstracts/variables";
127
+
128
+ /* Legg til klassen for logoen */
129
+ .oslologo {
130
+ margin-bottom: map.get(variables.$spacing, "size-30");
131
+ height: 12rem;
132
+ }
133
+ </style>
134
+ ```
135
+
136
+ ## CSS-rammeverket
137
+
138
+ ### Nøkkelegenskaper
139
+
140
+ - Modulært - import modulene du selv ønsker.
141
+ - Må bruke css-klasser - ingen overstyring utenom å bruke OsloSans.
142
+ - Komponentbibliotekene bruker samme css.
143
+ - Sass abstracts gir ekstra nytteverdi for deg som bruker.
144
+
145
+ ### Oppbygging
146
+
147
+ | Kategori | Beskrivelse |
148
+ |:-----------|:-----------------------------------------------------------------------------------------|
149
+ | Abstracts | Variabler, funksjoner, mixins: Alle Sass-verktøy som brukes på tvers av rammeverket |
150
+ | Normalise | En ganske liten normalisering for å ha en felles baseline |
151
+ | Base | Grunnleggende moduler som farger, grid, fonter, tekststiler, mm. |
152
+ | Elements | HTML-elementer som er stylet, som knapper, lister og tabeller. |
153
+ | Components | Komponenter som kombinerer elementer og komponenter for å lage mer komplekse komponenter |
154
+
155
+ #### Noen ord om abstracts
156
+
157
+ Abstracts består av `/variables`, `/functions`, og `/mixins` og samler
158
+ alle globale Sass variabler og verktøy på tvers av rammeverket. Disse
159
+ er et fundament for resten av rammeverket.
160
+
161
+ Ingenting under denne folderen skal generere en eneste linje CSS når
162
+ den er kompilert på egen hånd. Disse er bare Sass hjelpeverktøy.
163
+
164
+ Folderen `/variables` er en samling Sass-variabler skrevet på formen
165
+ [Sass maps](https://sass-lang.com/documentation/modules/map). Dette
166
+ gir en fin måte å kategorisere variablene og gir mulighet for nested
167
+ maps.
168
+
169
+ ```scss
170
+ /* abstracts/variables/_breakpoints.scss */
171
+
172
+ $breakpoints: (
173
+ 'mobile': 0,
174
+ 'phablet': 36rem /* ~576px */,
175
+ 'tablet': 48rem /* ~768px */,
176
+ 'tablet-big': 64rem /* ~1024px */,
177
+ 'laptop': 80rem /* ~1280px */,
178
+ 'desktop': 100rem /* ~1600px */,
179
+ ) !default;
180
+ ```
181
+
182
+ For prekompilerte `.css` er hver kategori pakket i en fil, mens for
183
+ `.scss` kan hver modul brukes hver for seg.
184
+
185
+ ## CDN
186
+
187
+ De statiske ressursene vil finnes i en versjonert folder under
188
+ https://assets.ods.oslo.systems/, slik at du kan ha full tillit til at de
189
+ kommer til å være stabile og tilgjengelige i lang tid. Her finnes de ferdig
190
+ genererte css-filene oppdelt i moduler eller komplett. I tillegg finnes
191
+ generert css for hver enkelt komponent under `css/components`.
192
+
193
+ | Filnavn | Url |
194
+ |:------------------|:--------------------------------------------------------------------|
195
+ | Komplett | https://assets.ods.oslo.systems/latest/css/ods.css |
196
+ | | https://assets.ods.oslo.systems/latest/css/ods.min.css |
197
+ | Normalisering | https://assets.ods.oslo.systems/latest/css/ods-normalise.css |
198
+ | | https://assets.ods.oslo.systems/latest/css/ods-normalise.min.css |
199
+ | Modul Base | https://assets.ods.oslo.systems/latest/css/ods-base.css |
200
+ | | https://assets.ods.oslo.systems/latest/css/ods-base.min.css |
201
+ | Modul Elementer | https://assets.ods.oslo.systems/latest/css/ods-elements.css |
202
+ | | https://assets.ods.oslo.systems/latest/css/ods-elements.min.css |
203
+ | Modul Komponenter | https://assets.ods.oslo.systems/latest/css/ods-components.css |
204
+ | | https://assets.ods.oslo.systems/latest/css/ods-components.min.css |
205
+ | Alert komponent | https://assets.ods.oslo.systems/latest/css/components/alert.css |
206
+ | | https://assets.ods.oslo.systems/latest/css/components/alert.min.css |
207
+
208
+
209
+ Versjoner følger eksakt de samme versjonene som NPM-pakkene, slik at du har
210
+ oversikt over dem i GitHub repositoriet. I tillegg kan du bruke `/latest`
211
+ for å alltid peke mot nyeste versjon, med all gleder og sorger det kan føre
212
+ med seg.
213
+
214
+ **NB!** Alt som kommer fra _versjonerte_ endepunkter på CDN blir cachet i
215
+ 1 år vha. http-headeren `cache-control` sitt `max-age`-attributt.
216
+
217
+ ## 👮 Lisens
218
+
219
+ `Punkt` er distribuert under [MIT-lisens](https://github.com/oslokommune/oslo-designsystem/blob/main/packages/ods-design/LICENSE) for åpen kildekode.
220
+
221
+ ![NPM License](https://img.shields.io/npm/l/@oslokommune/oslo-designsystem?style=for-the-badge)