docs(tooltip): improve docs

This commit is contained in:
Eric Liu 2025-05-03 11:06:20 -07:00
commit 022836872c

View file

@ -8,9 +8,11 @@ components: ["Tooltip", "TooltipFooter"]
import Preview from "../../components/Preview.svelte"; import Preview from "../../components/Preview.svelte";
</script> </script>
`Tooltip` displays contextual information when users hover over or focus on an element. It supports various directions, alignments, and interactive content to provide additional context or guidance.
## Default ## Default
By default, the tooltip is triggered by an information icon. Display a tooltip triggered by the default information icon.
<Tooltip> <Tooltip>
<p> <p>
@ -20,6 +22,8 @@ By default, the tooltip is triggered by an information icon.
## With trigger text ## With trigger text
Use custom trigger text instead of the default icon.
<Tooltip triggerText="Resource list"> <Tooltip triggerText="Resource list">
<p> <p>
Resources are provisioned based on your account's organization. Resources are provisioned based on your account's organization.
@ -28,10 +32,14 @@ By default, the tooltip is triggered by an information icon.
## Reactive example ## Reactive example
Control the tooltip state programmatically.
<FileSource src="/framed/Tooltip/TooltipReactive" /> <FileSource src="/framed/Tooltip/TooltipReactive" />
## Directions ## Directions
Position the tooltip in different directions using the `direction` prop.
<Tooltip triggerText="Top" direction="top"><p>Top</p></Tooltip> <Tooltip triggerText="Top" direction="top"><p>Top</p></Tooltip>
<Tooltip triggerText="Right" direction="right"><p>Right</p></Tooltip> <Tooltip triggerText="Right" direction="right"><p>Right</p></Tooltip>
<Tooltip triggerText="Bottom" direction="bottom"><p>Bottom</p></Tooltip> <Tooltip triggerText="Bottom" direction="bottom"><p>Bottom</p></Tooltip>
@ -39,12 +47,16 @@ By default, the tooltip is triggered by an information icon.
## Alignment ## Alignment
Align the tooltip content using the `align` prop.
<Tooltip triggerText="Start" align="start"><p>Start</p></Tooltip> <Tooltip triggerText="Start" align="start"><p>Start</p></Tooltip>
<Tooltip triggerText="End" align="end"><p>End</p></Tooltip> <Tooltip triggerText="End" align="end"><p>End</p></Tooltip>
<Tooltip triggerText="Center" align="center"><p>Center</p></Tooltip> <Tooltip triggerText="Center" align="center"><p>Center</p></Tooltip>
## Interactive ## Interactive
Add interactive elements like links and buttons using `TooltipFooter`.
<Tooltip triggerText="Resource list"> <Tooltip triggerText="Resource list">
<p> <p>
Resources are provisioned based on your account's organization. Resources are provisioned based on your account's organization.
@ -52,11 +64,13 @@ By default, the tooltip is triggered by an information icon.
<TooltipFooter selectorPrimaryFocus="#d"> <TooltipFooter selectorPrimaryFocus="#d">
<Link href="/">Learn more</Link> <Link href="/">Learn more</Link>
<Button id="d" size="small">Manage</Button> <Button id="d" size="small">Manage</Button>
</TooltipFooter> </TooltipFooter>
</Tooltip> </Tooltip>
## Custom icon (component) ## Custom icon (component)
Use a custom icon component with the `icon` prop.
<Tooltip triggerText="Resource list" icon={Catalog}> <Tooltip triggerText="Resource list" icon={Catalog}>
<p> <p>
Resources are provisioned based on your account's organization. Resources are provisioned based on your account's organization.
@ -65,6 +79,8 @@ By default, the tooltip is triggered by an information icon.
## Custom icon (slot) ## Custom icon (slot)
Customize the icon using the `icon` slot for more flexibility.
<Tooltip triggerText="Resource list"> <Tooltip triggerText="Resource list">
<div slot="icon" style="width: 1rem; height: 1rem; outline: 1px solid red;"></div> <div slot="icon" style="width: 1rem; height: 1rem; outline: 1px solid red;"></div>
<p> <p>
@ -74,6 +90,8 @@ By default, the tooltip is triggered by an information icon.
## Hidden icon ## Hidden icon
Hide the icon while keeping the tooltip functionality using `hideIcon`.
<Tooltip hideIcon triggerText="Resource list"> <Tooltip hideIcon triggerText="Resource list">
<p> <p>
Resources are provisioned based on your account's organization. Resources are provisioned based on your account's organization.