-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Endrer docs i henhold til mal for box (#639)
- Loading branch information
1 parent
a2abe68
commit ac88b13
Showing
2 changed files
with
56 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,59 @@ | ||
import { Title, Canvas, Meta, Story, Controls } from "@storybook/blocks"; | ||
import { DocsHeading, DocsAnatomy, DocsContainer, DocsStory, Feedback } from "../../../templates"; | ||
import { Text, Code, Box } from "@kvib/react/src/"; | ||
|
||
import * as BoxStories from "./Box.stories"; | ||
|
||
<Meta of={BoxStories} /> | ||
|
||
# Box | ||
|
||
Box er grunnpillaren til alle komponentene i KVIB. | ||
|
||
<Canvas of={BoxStories.SimpleBox} /> | ||
|
||
## Ta i bruk | ||
Box er grunnpillaren til alle komponentene i Kartverkets Designsystem. Du kan tenke på den som en `<div />` som du kan style med props og design tokens. | ||
|
||
```jsx | ||
import { Box } from "@kvib/react"; | ||
``` | ||
|
||
## Props | ||
<DocsContainer> | ||
|
||
**Egnet til:** | ||
|
||
- Enkle containers | ||
- Wrapper for mer komplekse komponenter | ||
|
||
Box-komponenten aksepterer alle styling props man kan sende til en div eller et View. | ||
**Uegnet til:** | ||
|
||
I React-implementasjonen kan man også spesifisere hva slags DOM-element man ønsker rendret. | ||
- Avanserte layout-justeringer | ||
|
||
## Retningslinjer | ||
<Feedback component="Box" /> | ||
|
||
Box er en ganske spesiell komponent. Du kan tenke på den som en `<div />` som du kan style med props og design tokens. | ||
</DocsContainer> | ||
|
||
## Flere eksempler | ||
<DocsHeading>Alternativer</DocsHeading> | ||
<DocsContainer> | ||
|
||
<br /> | ||
### En Box med padding | ||
<DocsStory | ||
title="Props" | ||
description={ | ||
<Text> | ||
Box-komponenten aksepterer alle styling props man kan sende til en div eller et View. Dette omfatter en mengde props som dekker de fleste brukstilfeller. Det er også lagt til forkortelser for de vanligste propsene (f.eks. <Code>bg</Code> istedenfor <Code>backgroundColor</Code>). | ||
</Text> | ||
} | ||
story={<Canvas of={BoxStories.BoxExample} />} | ||
|
||
<Canvas of={BoxStories.BoxWithPadding} /> | ||
/> | ||
|
||
### En Box som egentlig er en lenke | ||
<DocsStory | ||
title="Override med as-prop" | ||
description={ | ||
<Text> | ||
Box har en <Code>as</Code>-prop som lar deg overstyre hvilket DOM-element som rendres. Dette kan være nyttig hvis du ønsker å bruke en annen type element enn <Code>div</Code>, men starte fra "scratch" når det kommer til styling av komponentet. | ||
Det vil si at det er mulig å dra nytte av egenskapene til en link ("a"), uten å måtte bruke stylingen til <Code>Link</Code>. | ||
I de fleste tilfeller vil det være mer hensiktsmessig å bruke en av de andre komponentene som er bygget på Box, men i komplekse situasjoner kan det være nyttig. | ||
</Text> | ||
} | ||
story={<Canvas of={BoxStories.BoxAsLink} />} | ||
|
||
<Canvas of={BoxStories.AdvancedBox} /> | ||
/> | ||
|
||
Se [Chakra sine dokumentasjonssider](https://chakra-ui.com/docs/components/box) for flere eksempler og info. | ||
</DocsContainer> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters