-
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 search (#648)
- Loading branch information
1 parent
ac88b13
commit 42398bd
Showing
2 changed files
with
129 additions
and
19 deletions.
There are no files selected for viewing
104 changes: 87 additions & 17 deletions
104
apps/storybook/stories/components/search/search/Search.mdx
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,35 +1,105 @@ | ||
import * as SearchStories from "./Search.stories"; | ||
import { Canvas, Controls, Meta } from "@storybook/blocks"; | ||
import { Alert, AlertIcon } from "@kvib/react/src"; | ||
import { Canvas, Controls, Meta, Story } from "@storybook/blocks"; | ||
import { Alert, AlertIcon, Text, Code, Box, Stack } from "@kvib/react/src"; | ||
import { DocsHeading, DocsAnatomy, DocsContainer, DocsStory, Feedback } from "../../../templates"; | ||
|
||
<Meta of={SearchStories} /> | ||
|
||
# Search | ||
|
||
Search lar brukerne utforske et nettsted eller en applikasjon ved å skrive nøkkelord eller setninger som leter frem det mest relevante innholdet for dem. | ||
|
||
```jsx | ||
import { Search } from "@kvib/react"; | ||
``` | ||
|
||
<Alert status="info"> | ||
<AlertIcon /> | ||
BorderRadius på Search har en bug for øyeblikket. Den bytter mellom å være rund og firkantet. Buggen ligger hos chakra | ||
\- en issue er opprettet. | ||
BorderRadius på Search for iOS har en bug. Den bytter mellom å være rund og firkantet. Buggen ligger hos chakra \- [en | ||
PR er opprettet](https://github.com/chakra-ui/chakra-ui/pull/7959). | ||
</Alert> | ||
|
||
Søkefelt komponent. | ||
<DocsContainer> | ||
|
||
## Ta i bruk | ||
**Egnet til:** | ||
|
||
```jsx | ||
import { Search } from "@kvib/react"; | ||
``` | ||
- Raskt finne relevant innhold | ||
|
||
## Props | ||
**Uegnet til:** | ||
|
||
<Canvas of={SearchStories.Search} /> | ||
<Controls of={SearchStories.Search} /> | ||
- Innhold som lett kan navigeres til uten søk | ||
|
||
<Feedback component="Search" /> | ||
|
||
</DocsContainer> | ||
|
||
## Search med Ikon knapp | ||
<DocsHeading>Alternativer</DocsHeading> | ||
<DocsContainer> | ||
|
||
<Canvas of={SearchStories.SearchIconLeft} /> | ||
<Canvas of={SearchStories.SearchIconRight} /> | ||
<DocsStory | ||
title="Utseende" | ||
description={ | ||
<Box> | ||
<Text> | ||
Search har fire varianter. <Code>outline</Code> er standardvarianten og skal brukes i de fleste tilfeller. | ||
<Code>filled</Code> kan brukes som et alternativ til outline. For mindre viktige søkefelt kan | ||
<Code>flushed</Code> og | ||
<Code>unstyled</Code> brukes. | ||
</Text> | ||
<Text> | ||
Det er mulig å velge mellom fire forskjellige størrelser: <Code>xs</Code>, <Code>sm</Code>, <Code>md</Code> og{" "} | ||
<Code>lg</Code>.<Code>md</Code> er standard. | ||
</Text> | ||
</Box> | ||
} | ||
story={<Canvas of={SearchStories.SearchVariants} />} | ||
/> | ||
|
||
## Searchknapp varianter | ||
<DocsStory | ||
title="Søkeknapp/ikon" | ||
description={ | ||
<Box> | ||
<Text> | ||
Search har muligheten til å legge inn knapp med søkeikon ved å benytte enten <Code>leftSearchIcon</Code> eller | ||
<Code>rightSearchIcon</Code>. Disse har <Code>type="submit"</Code> som gjør at de passer inn i et form. | ||
</Text> | ||
<Text> | ||
Søkeknappen kan tilpasses ved å legge verdier til <Code>buttonVariant</Code> og <Code>buttonWidth</Code>. | ||
Knappen er en <Code>IconButton</Code> og har tilsvarende varianter. | ||
</Text> | ||
</Box> | ||
} | ||
story={ | ||
<Canvas> | ||
<Stack gap="1rem"> | ||
<Story of={SearchStories.SearchIconRight} /> | ||
<Story of={SearchStories.SearchIconLeft} /> | ||
<Story of={SearchStories.SearchButtonVariant} /> | ||
</Stack> | ||
</Canvas> | ||
} | ||
/> | ||
|
||
<Canvas of={SearchStories.SearchButtonVariant} /> | ||
</DocsContainer> | ||
|
||
<DocsHeading>Retningslinjer</DocsHeading> | ||
|
||
<DocsContainer> | ||
|
||
### Bredde | ||
|
||
Søkefeltets bredde bør tilsvare lengden på søkeordene som brukes. Feltets størrelse er et viktig signal til brukeren om hva de kan skrive inn. Et søkefelt som brukes til å søke på personnumre bør ha en bredde som tilsvarer et personnummer, mens hovedsøket for et nettsted bør ha et bredere felt som lar brukerne se flere ord samtidig. | ||
|
||
Ta gjerne en kikk på søkeloggene dine for å se hvordan brukerne dine ordlegger seg når de søker på sidene dine. Unngå at teksten i søkefeltet må scrolles for å romme typiske søk. | ||
|
||
### Innsending av query | ||
|
||
Det er anbefalt å bruke `<form>` rundt Search dersom du skal bruke det valgte resultatet. Dette gjør det mulig å bruke `<button type="submit">` for å sende inn søket. | ||
Det gjøres enten med en av ikonknappene i props, eller egen knapp. | ||
`FormControl` kan hjelpe til med å gi Search kontekst. | ||
|
||
</DocsContainer> | ||
|
||
<DocsHeading>Props</DocsHeading> | ||
<Canvas of={SearchStories.Search} /> | ||
<Controls of={SearchStories.Search} /> |
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