Skip to content

Commit 61052b4

Browse files
committed
Oppdater README
1 parent d71e230 commit 61052b4

File tree

3 files changed

+55
-37
lines changed

3 files changed

+55
-37
lines changed

v3/README.md

+51-33
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,28 @@
11
# Dekoratør for interne arbeidsflater V3
2+
23
Dekoratøren er en navigasjonsmeny som skal kunne brukes på tvers av fagapplikasjoner i NAV.
34

45
Appen har ansvar for kommunikasjon med contextholderen (modia-contextholder og modia-eventdistribution).
5-
Dette betyr at hvis man sender inn konfigurasjonen for `enhet` eller `fnr`, så vil det bli satt opp en WebSocket-connection,
6-
og appen vil holde context i sync med hva som vises i decoratøren.
7-
Ved eventuelle endringer i andre flater vil det vises en bekreftelse-modal, og hvis saksbehandler bekrefter endringen så vil `onChange` bli kalt.
6+
Dette betyr at hvis man sender inn konfigurasjonen for `enhet` eller `fnr`, så vil det bli satt opp en WebSocket-connection,
7+
og appen vil holde context i sync med hva som vises i decoratøren.
8+
Ved eventuelle endringer i andre flater vil det vises en bekreftelse-modal, og hvis saksbehandler bekrefter endringen så vil `onChange` bli kalt.
89

910
## Ta ibruk
11+
1012
Legg til følgende i index.html
13+
1114
```html
12-
<script src="https://cdn.nav.no/personoversikt/internarbeidsflate-decorator-v3/dev/latest/dist/bundle.js"></script>
13-
<link rel="stylesheet" href="https://cdn.nav.no/personoversikt/internarbeidsflate-decorator-v3/dev/latest/dist/index.css" />
15+
<script src="https://cdn.nav.no/personoversikt/internarbeidsflate-decorator-v3/dev/latest/dist/bundle.js"></script>
16+
<link
17+
rel="stylesheet"
18+
href="https://cdn.nav.no/personoversikt/internarbeidsflate-decorator-v3/dev/latest/dist/index.css"
19+
/>
1420
```
1521

16-
1722
### React med navspa
23+
1824
Om man bruker react som frontendbibliotek kan man så ta ibruk `@navikt/navspa` (Eksemplet er med typescript, fjern `DecoratorProps` om det ikke brukes).
25+
1926
```typescript jsx
2027
import NAVSPA from '@navikt/navspa';
2128
import DecoratorProps from './decorator-props';
@@ -34,36 +41,37 @@ function App() {
3441
```
3542

3643
### Manuelt oppsett
44+
3745
Om man ikke bruker react så kan man fortsatt ta ibruk decoratoren, men man må da kalle render-funksjonen selv.
38-
Ett eksempel på hvordan dette kan gjøres kan ses i [index.html](public/index.html).
46+
Ett eksempel på hvordan dette kan gjøres kan ses i [index.html](../public/index.html).
3947

4048
## Konfigurasjon
4149

42-
Eksempler på konfigurasjoner kan ses i [index.html](public/index.html).
50+
Eksempler på konfigurasjoner kan ses i [index.html](../public/index.html).
4351

4452
```typescript jsx
4553
export interface DecoratorProps {
46-
useProxy?: boolean | string; // Manuell overstyring av urlene til BFFs. Gjør alle kall til relativt path hvis true, og bruker verdien som domene om satt til en string. Default: false
47-
accessToken?: string; // Manuell innsending av JWT, settes som Authorization-header. Om null sendes cookies vha credentials: 'include'
48-
enhet?: string | undefined; // Konfigurasjon av enhet-kontekst
49-
accessToken?: string | undefined; // Manuell innsending av JWT, settes som Authorization-header. Om null sendes cookies vha credentials: 'include'
50-
fnr?: string | undefined; // Konfigurasjon av fødselsnummer-kontekst
51-
userKey?: string | undefined; // Om man ikke ønsker å bruke fnr i urler, kan andre apper kalle contextholder for å generere en midlertidig kode. Hvis App A skal navigere til App B som har dekoratøren, må App A først sende en post request til /fnr-code/generate med {fnr: string} i bodyen, dette returnerer {fnr: string, code: string} til App A. App A kan så navigere til App B og sende med denne koden. App B kan så sende den koden inn til dekoratøren i userKey propen og så henter dekoratøren fnr for den koden fra contextholderen.
52-
enableHotkeys?: boolean | undefined; // Aktivere hurtigtaster
53-
fetchActiveEnhetOnMount?: boolean | undefined; // Om enhet er undefined fra container appen, og denne er satt til true, henter den sist aktiv enhet og bruker denne.
54-
fetchActiveUserOnMount?: boolean | undefined; // Om fnr er undefined fra container appen, og denne er satt til true for at den skal hente siste aktiv fnr.
55-
onBeforeRequest?: (headers: HeadersInit) => HeadersInit | undefined; // Her kan headeren til alle nettverkskall bli modifisert før de blir kalt
56-
onEnhetChanged: (enhet?: string | null) => void; // Kalles når enheten endres
57-
onFnrChanged: (fnr?: string | null) => void; // Kalles når fnr enheten endres
58-
appName: string; // Navn på applikasjonen
59-
hotkeys?: Hotkey[]; // Konfigurasjon av hurtigtaster
60-
markup?: Markup; // Egen HTML
61-
showEnheter: boolean; // Vis enheter
62-
showSearchArea: boolean; // Vis søkefelt
63-
showHotkeys: boolean; // Vis hurtigtaster
64-
environment: Environment; // Miljø som skal brukes.
65-
urlFormat: UrlFormat; // URL format
66-
proxy?: string | undefined; // Manuell overstyring av urlene til BFFs. Gjør alle kall til relativt path hvis true, og bruker verdien som domene om satt til en string. Default: false
54+
useProxy?: boolean | string; // Manuell overstyring av urlene til BFFs. Gjør alle kall til relativt path hvis true, og bruker verdien som domene om satt til en string. Default: false
55+
accessToken?: string; // Manuell innsending av JWT, settes som Authorization-header. Om null sendes cookies vha credentials: 'include'
56+
enhet?: string | undefined; // Konfigurasjon av enhet-kontekst
57+
accessToken?: string | undefined; // Manuell innsending av JWT, settes som Authorization-header. Om null sendes cookies vha credentials: 'include'
58+
fnr?: string | undefined; // Konfigurasjon av fødselsnummer-kontekst
59+
userKey?: string | undefined; // Om man ikke ønsker å bruke fnr i urler, kan andre apper kalle contextholder for å generere en midlertidig kode. Hvis App A skal navigere til App B som har dekoratøren, må App A først sende en post request til /fnr-code/generate med {fnr: string} i bodyen, dette returnerer {fnr: string, code: string} til App A. App A kan så navigere til App B og sende med denne koden. App B kan så sende den koden inn til dekoratøren i userKey propen og så henter dekoratøren fnr for den koden fra contextholderen.
60+
enableHotkeys?: boolean | undefined; // Aktivere hurtigtaster
61+
fetchActiveEnhetOnMount?: boolean | undefined; // Om enhet er undefined fra container appen, og denne er satt til true, henter den sist aktiv enhet og bruker denne.
62+
fetchActiveUserOnMount?: boolean | undefined; // Om fnr er undefined fra container appen, og denne er satt til true for at den skal hente siste aktiv fnr.
63+
onBeforeRequest?: (headers: HeadersInit) => HeadersInit | undefined; // Her kan headeren til alle nettverkskall bli modifisert før de blir kalt
64+
onEnhetChanged: (enhet?: string | null) => void; // Kalles når enheten endres
65+
onFnrChanged: (fnr?: string | null) => void; // Kalles når fnr enheten endres
66+
appName: string; // Navn på applikasjonen
67+
hotkeys?: Hotkey[]; // Konfigurasjon av hurtigtaster
68+
markup?: Markup; // Egen HTML
69+
showEnheter: boolean; // Vis enheter
70+
showSearchArea: boolean; // Vis søkefelt
71+
showHotkeys: boolean; // Vis hurtigtaster
72+
environment: Environment; // Miljø som skal brukes.
73+
urlFormat: UrlFormat; // URL format
74+
proxy?: string | undefined; // Manuell overstyring av urlene til BFFs. Gjør alle kall til relativt path hvis true, og bruker verdien som domene om satt til en string. Default: false
6775
}
6876

6977
// export interface TogglesConfig {
@@ -72,15 +80,25 @@ export interface DecoratorProps {
7280
// }
7381

7482
export interface Markup {
75-
etterSokefelt?: string; // Gir muligheten for sende inn egen html som blir en del av dekoratøren
83+
etterSokefelt?: string; // Gir muligheten for sende inn egen html som blir en del av dekoratøren
7684
}
7785

78-
export type Environment = 'q0' | 'q1' | 'q2' | 'q3' | 'q4' | 'prod' | 'local' | 'mock'; // Miljø. Foreløpig er kun q0 og q1 støttet.
79-
80-
export type UrlFormat = 'LOCAL' | 'ADEO' | 'NAV_NO'; // UrlFormat. Brukes om proxy ikke er satt.
86+
// Miljø. Foreløpig er kun q0 og q1 støttet.
87+
export type Environment =
88+
| 'q0'
89+
| 'q1'
90+
| 'q2'
91+
| 'q3'
92+
| 'q4'
93+
| 'prod'
94+
| 'local'
95+
| 'mock';
8196

97+
export type UrlFormat = 'LOCAL' | 'ADEO' | 'NAV_NO'; // UrlFormat. Brukes om proxy ikke er satt.
8298
```
99+
83100
# Henvendelser
101+
84102
Spørsmål knyttet til koden eller prosjektet kan rettes mot:
85103

86104
[Team Personoversikt](https://github.com/navikt/info-team-personoversikt)

v3/bun.lockb

20.5 KB
Binary file not shown.

v3/packages/internarbeidsflate-decorator-v3/src/components/Links/generateLinks.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,12 @@ export const generateLinks = ({
5353
title: 'Personoversikt',
5454
links: [
5555
buildLinkWithTitle(links.modiaUrl, 'Oversikt'),
56-
buildLinkWithTitle(links.modiaUrl, 'Saksoversikt', '/saker'),
57-
buildLinkWithTitle(links.modiaUrl, 'Meldinger', '/meldinger'),
58-
buildLinkWithTitle(links.modiaUrl, 'Varslinger', '/varsler'),
59-
buildLinkWithTitle(links.modiaUrl, 'Utbetalinger', '/utbetaling'),
6056
buildLinkWithTitle(links.modiaUrl, 'Oppfølging', '/oppfolging'),
57+
buildLinkWithTitle(links.modiaUrl, 'Kommunikasjon', '/meldinger'),
58+
buildLinkWithTitle(links.modiaUrl, 'Utbetalinger', '/utbetaling'),
59+
buildLinkWithTitle(links.modiaUrl, 'Saksoversikt', '/saker'),
6160
buildLinkWithTitle(links.modiaUrl, 'Ytelser', '/ytelser'),
61+
buildLinkWithTitle(links.modiaUrl, 'Varslinger', '/varsler'),
6262
],
6363
};
6464
const arbeidsrettet: LinkSection = {

0 commit comments

Comments
 (0)