Skip to content

Commit 4425fbe

Browse files
committed
Legg til migrasjonsguide
1 parent 867b500 commit 4425fbe

File tree

2 files changed

+74
-0
lines changed

2 files changed

+74
-0
lines changed

Migrating-v3.md

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Migrasjonsguide fra v2.1 til v3
2+
3+
Selv om v3 er en fullstendig omskriving av appen, oppfører den seg stort sett likt, og har de samme
4+
funksjonene. Hovedsakelig er det kun å endre hvor dekoratøren importeres fra, og overføre den gamle
5+
konfigurasjonen til å passe v3.
6+
7+
1. Importering av dekoratøren.
8+
9+
Dekoratøren lever nå på NAV sin CDN, og lasting av scripts må endres.
10+
11+
```diff
12+
# index.html
13+
14+
-<link rel="stylesheet" href="https://internarbeidsflatedecorator.intern.dev.nav.no/v2.1/static/css/main.css" />
15+
-<script src="https://internarbeidsflate.intern.dev.nav.no/v2.1/static/js/head.v2.min.js"></script>
16+
17+
+<link rel="stylesheet" href="https://cdn.nav.no/personoversikt/internarbeidsflate-decorator-v3/dev/latest/dist/index.css" />
18+
+<script src="https://cdn.nav.no/personoversikt/internarbeidsflate-decorator-v3/dev/latest/dist/bundle.js" />
19+
```
20+
21+
> Dekoratøren publisers på forskjellige paths i dev og prod. Bruk CDN urlen over for dev, og bytt ut
22+
> med `prod` i prod
23+
24+
Endre deretter importering av appen med NAVSpa:
25+
26+
```diff
27+
-const InternflateDecorator = NAVSPA.importer<DecoratorProps>('internarbeidsflatefs');
28+
+const InternflateDecorator = NAVSPA.importer<DecoratorPropsV3>('internarbeidsflate-decorator-v3');
29+
```
30+
31+
2. Konfigurasjon
32+
33+
Konfigurasjonen er mye lik, men med noen få endringer.
34+
35+
`fnr` og `enhet` propene er ikke lenger separert, og props objektet er flatet ut.
36+
37+
```diff
38+
const decoratorConfig: DecoratorProps = {
39+
-fnr: {
40+
...
41+
-},
42+
-enhet: {
43+
...
44+
-}
45+
}
46+
```
47+
48+
> For detaljerte typer, se README.md
49+
> Det anbefales å kopiere typene der inn i appen om du bruker Typescript
50+
51+
| v2.1 | v3 | Kommentar |
52+
| ----------------------------- | ------------------------- | ---------------------------------------------------------- |
53+
| `fnr.value` | `fnr` | |
54+
| `fnr.display: FnrDisplay` | `showSearchArea: boolean` | |
55+
| `fnr.onChange` | `onFnrChanged` | |
56+
| `enhet.value` | `enhet` | |
57+
| `enhet.display: EnhetDisplay` | `showEnheter: boolean` | |
58+
| `enhet.onChange` | `onEnhetChanged` | |
59+
| `markup` | `markup` | Ingen endringer |
60+
| `hotkeys` | `hotkeys` | Ingen endringer |
61+
| `useProxy: boolean \| string` | `proxy: string` | Legger ikke lenger på `/modiacontextholder` på proxy URLen |
62+
63+
**Nye props**
64+
65+
| v3 | Kommentar |
66+
| ------------------------- | -------------------------------------------------------------- |
67+
| `showHotkeys: boolean` | Vis knapp som åpner modal med liste om registrete hotkeys. |
68+
| `environment` | Hvilket miljø appen kjører i |
69+
| `urlFormat` | Hvilket URL format som brukes (ansatt eller intern) |
70+
| `fetchActiveUserOnMount` | Om bruker fra context skal hentes dersom `fnr` er `undefined` |
71+
| `fetchActiveEnhetOnMount` | Om enhet fra context skal hentes dersom `enhet` er `undefined` |
72+
| `enableHotkeys` | Skru på hotkeys (NB: ikke på by default) |

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
> [!NOTE]
44
> v2.1 kjører fortsatt i prod. Du kan finne denne i [v2.1 branchen](https://github.com/navikt/internarbeidsflatedecorator/tree/v2.1)
55
6+
\*\*[Migrasjonsguid for V3](./Migrating-v3.md)
7+
68
Dekoratøren er en navigasjonsmeny som skal kunne brukes på tvers av fagapplikasjoner i NAV.
79

810
Appen har ansvar for kommunikasjon med contextholderen (modia-contextholder og modia-eventdistribution).

0 commit comments

Comments
 (0)