carbon-components-svelte/docs/src/pages/components/Search.svx
Eric Liu d4dd33e28c
Update docs (#1001)
* docs(tree-view): avoid redundant copy

* docs(search): "clear" is dispatched when pressing "Escape"

* docs(search): refactor "Expandable variant" to demonstrate reactivity
2022-01-12 16:12:14 -10:00

63 lines
No EOL
1.1 KiB
Text

<script>
import Query16 from "carbon-icons-svelte/lib/Query16";
import { Search } from "carbon-components-svelte";
import Preview from "../../components/Preview.svelte";
</script>
### Default
The `Search` component size is extra-large by default. There are [large](#large-size) and [small](#small-size) size variants.
<Search />
### Default value
<Search placeholder="Search catalog..." value="Cloud functions" />
### Reactive example
<FileSource src="/framed/Search/SearchReactive" />
### on:clear
The "clear" event is dispatched when clicking the "X" button or when pressing the "Escape" key.
<Search value="Cloud functions" on:clear={() => console.log('clear')}/>
### Expandable variant
Set `expandable` to `true` to use the expandable variant.
<FileSource src="/framed/Search/SearchExpandableReactive" />
### Light variant
<Search light />
### Large size
<Search size="lg" />
### Small size
<Search size="sm" />
### Disabled state
<Search disabled />
### Custom search icon
<Search icon={Query16} />
### Skeleton
<Search skeleton />
### Skeleton (large)
<Search size="lg" skeleton />
### Skeleton (small)
<Search size="sm" skeleton />