mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-15 10:21:05 +00:00
b7bf9ea1f0* chore: add license badge to README * perf(docs): ignore node_modules in markdown preprocessor * docs: remove tabs for install commands on homepage * docs(button-set): improve copy * docs(button): improve usage for icon-only, link buttons * docs: various copy improvements
89 lines
No EOL
2.1 KiB
Text
89 lines
No EOL
2.1 KiB
Text
---
|
|
description: High-level description
|
|
---
|
|
|
|
<script>
|
|
import { Button } from "carbon-components-svelte";
|
|
import Add16 from "carbon-icons-svelte/lib/Add16";
|
|
import Preview from "../../components/Preview.svelte";
|
|
</script>
|
|
|
|
### Primary button
|
|
|
|
<Button>Primary button</Button>
|
|
|
|
### Secondary button
|
|
|
|
<Button kind="secondary">Secondary button</Button>
|
|
|
|
### Tertiary button
|
|
|
|
<Button kind="tertiary">Tertiary button</Button>
|
|
|
|
### Ghost button
|
|
|
|
<Button kind="ghost">Ghost button</Button>
|
|
|
|
### Danger button
|
|
|
|
<Button kind="danger">Danger button</Button>
|
|
|
|
### Danger tertiary button
|
|
|
|
<Button kind="danger-tertiary">Danger tertiary button</Button>
|
|
|
|
### Danger ghost button
|
|
|
|
<Button kind="danger-ghost">Danger ghost button</Button>
|
|
|
|
### Button with icon
|
|
|
|
<Button icon={Add16}>With icon</Button>
|
|
|
|
### Icon-only button
|
|
|
|
Set `hasIconOnly` to `true` to use the icon-only button variant.
|
|
|
|
**Note:** you must provide an `iconDescription` for the button tooltip.
|
|
|
|
The tooltip position and alignment can be controlled by the `tooltipPosition`, `tooltipAlignment` props, respectively.
|
|
|
|
<Button hasIconOnly tooltipPosition="bottom" tooltipAlignment="center" iconDescription="Tooltip text" icon={Add16} />
|
|
|
|
### Link button
|
|
|
|
If an `href` value is specified, the component will render an [anchor element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a) with a "button" role.
|
|
|
|
<Button href="#">Link button</Button>
|
|
|
|
### Custom element
|
|
|
|
<Button as let:props>
|
|
<p {...props}>Custom element</p>
|
|
</Button>
|
|
|
|
### Field button
|
|
|
|
<Button size="field">Primary</Button>
|
|
<Button size="field" kind="secondary">Secondary</Button>
|
|
<Button size="field" kind="tertiary">Tertiary</Button>
|
|
<Button size="field" kind="ghost">Ghost</Button>
|
|
<Button size="field" kind="danger">Danger</Button>
|
|
|
|
### Small button
|
|
|
|
<Button size="small">Primary</Button>
|
|
<Button size="small" kind="secondary">Secondary</Button>
|
|
<Button size="small" kind="tertiary">Tertiary</Button>
|
|
<Button size="small" kind="ghost">Ghost</Button>
|
|
<Button size="small" kind="danger">Danger</Button>
|
|
|
|
### Disabled button
|
|
|
|
<Button disabled>Disabled button</Button>
|
|
|
|
### Skeleton
|
|
|
|
<Button skeleton />
|
|
<Button skeleton size="field" />
|
|
<Button skeleton size="small" /> |