kopia lustrzana https://github.com/shoelace-style/shoelace
419 wiersze
11 KiB
Markdown
419 wiersze
11 KiB
Markdown
# Tooltip
|
|
|
|
[component-header:sl-tooltip]
|
|
|
|
A tooltip's target is its _first child element_, so you should only wrap one element inside of the tooltip. If you need the tooltip to show up for multiple elements, nest them inside a container first.
|
|
|
|
Tooltips use `display: contents` so they won't interfere with how elements are positioned in a flex or grid layout.
|
|
|
|
```html preview
|
|
<sl-tooltip content="This is a tooltip">
|
|
<sl-button>Hover Me</sl-button>
|
|
</sl-tooltip>
|
|
```
|
|
|
|
```jsx react
|
|
import { SlButton, SlTooltip } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const App = () => (
|
|
<SlTooltip content="This is a tooltip">
|
|
<SlButton>Hover Me</SlButton>
|
|
</SlTooltip>
|
|
);
|
|
```
|
|
|
|
## Examples
|
|
|
|
### Placement
|
|
|
|
Use the `placement` attribute to set the preferred placement of the tooltip.
|
|
|
|
```html preview
|
|
<div class="tooltip-placement-example">
|
|
<div class="tooltip-placement-example-row">
|
|
<sl-tooltip content="top-start" placement="top-start">
|
|
<sl-button></sl-button>
|
|
</sl-tooltip>
|
|
|
|
<sl-tooltip content="top" placement="top">
|
|
<sl-button></sl-button>
|
|
</sl-tooltip>
|
|
|
|
<sl-tooltip content="top-end" placement="top-end">
|
|
<sl-button></sl-button>
|
|
</sl-tooltip>
|
|
</div>
|
|
|
|
<div class="tooltip-placement-example-row">
|
|
<sl-tooltip content="left-start" placement="left-start">
|
|
<sl-button></sl-button>
|
|
</sl-tooltip>
|
|
|
|
<sl-tooltip content="right-start" placement="right-start">
|
|
<sl-button></sl-button>
|
|
</sl-tooltip>
|
|
</div>
|
|
|
|
<div class="tooltip-placement-example-row">
|
|
<sl-tooltip content="left" placement="left">
|
|
<sl-button></sl-button>
|
|
</sl-tooltip>
|
|
|
|
<sl-tooltip content="right" placement="right">
|
|
<sl-button></sl-button>
|
|
</sl-tooltip>
|
|
</div>
|
|
|
|
<div class="tooltip-placement-example-row">
|
|
<sl-tooltip content="left-end" placement="left-end">
|
|
<sl-button></sl-button>
|
|
</sl-tooltip>
|
|
|
|
<sl-tooltip content="right-end" placement="right-end">
|
|
<sl-button></sl-button>
|
|
</sl-tooltip>
|
|
</div>
|
|
|
|
<div class="tooltip-placement-example-row">
|
|
<sl-tooltip content="bottom-start" placement="bottom-start">
|
|
<sl-button></sl-button>
|
|
</sl-tooltip>
|
|
|
|
<sl-tooltip content="bottom" placement="bottom">
|
|
<sl-button></sl-button>
|
|
</sl-tooltip>
|
|
|
|
<sl-tooltip content="bottom-end" placement="bottom-end">
|
|
<sl-button></sl-button>
|
|
</sl-tooltip>
|
|
</div>
|
|
</div>
|
|
|
|
<style>
|
|
.tooltip-placement-example {
|
|
width: 250px;
|
|
margin: 1rem;
|
|
}
|
|
|
|
.tooltip-placement-example-row:after {
|
|
content: '';
|
|
display: table;
|
|
clear: both;
|
|
}
|
|
|
|
.tooltip-placement-example sl-button {
|
|
float: left;
|
|
width: 2.5rem;
|
|
margin-right: 0.25rem;
|
|
margin-bottom: 0.25rem;
|
|
}
|
|
|
|
.tooltip-placement-example-row:nth-child(1) sl-tooltip:first-child sl-button,
|
|
.tooltip-placement-example-row:nth-child(5) sl-tooltip:first-child sl-button {
|
|
margin-left: calc(40px + 0.25rem);
|
|
}
|
|
|
|
.tooltip-placement-example-row:nth-child(2) sl-tooltip:nth-child(2) sl-button,
|
|
.tooltip-placement-example-row:nth-child(3) sl-tooltip:nth-child(2) sl-button,
|
|
.tooltip-placement-example-row:nth-child(4) sl-tooltip:nth-child(2) sl-button {
|
|
margin-left: calc((40px * 3) + (0.25rem * 3));
|
|
}
|
|
</style>
|
|
```
|
|
|
|
```jsx react
|
|
import { SlButton, SlTooltip } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const css = `
|
|
.tooltip-placement-example {
|
|
width: 250px;
|
|
}
|
|
|
|
.tooltip-placement-example-row:after {
|
|
content: '';
|
|
display: table;
|
|
clear: both;
|
|
}
|
|
|
|
.tooltip-placement-example sl-button {
|
|
float: left;
|
|
width: 2.5rem;
|
|
margin-right: 0.25rem;
|
|
margin-bottom: 0.25rem;
|
|
}
|
|
|
|
.tooltip-placement-example-row:nth-child(1) sl-tooltip:first-child sl-button,
|
|
.tooltip-placement-example-row:nth-child(5) sl-tooltip:first-child sl-button {
|
|
margin-left: calc(40px + 0.25rem);
|
|
}
|
|
|
|
.tooltip-placement-example-row:nth-child(2) sl-tooltip:nth-child(2) sl-button,
|
|
.tooltip-placement-example-row:nth-child(3) sl-tooltip:nth-child(2) sl-button,
|
|
.tooltip-placement-example-row:nth-child(4) sl-tooltip:nth-child(2) sl-button {
|
|
margin-left: calc((40px * 3) + (0.25rem * 3));
|
|
}
|
|
`;
|
|
|
|
const App = () => (
|
|
<>
|
|
<div className="tooltip-placement-example">
|
|
<div className="tooltip-placement-example-row">
|
|
<SlTooltip content="top-start" placement="top-start">
|
|
<SlButton />
|
|
</SlTooltip>
|
|
|
|
<SlTooltip content="top" placement="top">
|
|
<SlButton />
|
|
</SlTooltip>
|
|
|
|
<SlTooltip content="top-end" placement="top-end">
|
|
<SlButton />
|
|
</SlTooltip>
|
|
</div>
|
|
|
|
<div className="tooltip-placement-example-row">
|
|
<SlTooltip content="left-start" placement="left-start">
|
|
<SlButton />
|
|
</SlTooltip>
|
|
|
|
<SlTooltip content="right-start" placement="right-start">
|
|
<SlButton />
|
|
</SlTooltip>
|
|
</div>
|
|
|
|
<div className="tooltip-placement-example-row">
|
|
<SlTooltip content="left" placement="left">
|
|
<SlButton />
|
|
</SlTooltip>
|
|
|
|
<SlTooltip content="right" placement="right">
|
|
<SlButton />
|
|
</SlTooltip>
|
|
</div>
|
|
|
|
<div className="tooltip-placement-example-row">
|
|
<SlTooltip content="left-end" placement="left-end">
|
|
<SlButton />
|
|
</SlTooltip>
|
|
|
|
<SlTooltip content="right-end" placement="right-end">
|
|
<SlButton />
|
|
</SlTooltip>
|
|
</div>
|
|
|
|
<div className="tooltip-placement-example-row">
|
|
<SlTooltip content="bottom-start" placement="bottom-start">
|
|
<SlButton />
|
|
</SlTooltip>
|
|
|
|
<SlTooltip content="bottom" placement="bottom">
|
|
<SlButton />
|
|
</SlTooltip>
|
|
|
|
<SlTooltip content="bottom-end" placement="bottom-end">
|
|
<SlButton />
|
|
</SlTooltip>
|
|
</div>
|
|
</div>
|
|
|
|
<style>{css}</style>
|
|
</>
|
|
);
|
|
```
|
|
|
|
### Click Trigger
|
|
|
|
Set the `trigger` attribute to `click` to toggle the tooltip on click instead of hover.
|
|
|
|
```html preview
|
|
<sl-tooltip content="Click again to dismiss" trigger="click">
|
|
<sl-button>Click to Toggle</sl-button>
|
|
</sl-tooltip>
|
|
```
|
|
|
|
```jsx react
|
|
import { SlButton, SlTooltip } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const App = () => (
|
|
<SlTooltip content="Click again to dismiss" trigger="click">
|
|
<SlButton>Click to Toggle</SlButton>
|
|
</SlTooltip>
|
|
);
|
|
```
|
|
|
|
### Manual Trigger
|
|
|
|
Tooltips can be controller programmatically by setting the `trigger` attribute to `manual`. Use the `open` attribute to control when the tooltip is shown.
|
|
|
|
```html preview
|
|
<sl-button style="margin-right: 4rem;">Toggle Manually</sl-button>
|
|
|
|
<sl-tooltip content="This is an avatar" trigger="manual" class="manual-tooltip">
|
|
<sl-avatar label="User"></sl-avatar>
|
|
</sl-tooltip>
|
|
|
|
<script>
|
|
const tooltip = document.querySelector('.manual-tooltip');
|
|
const toggle = tooltip.previousElementSibling;
|
|
|
|
toggle.addEventListener('click', () => (tooltip.open = !tooltip.open));
|
|
</script>
|
|
```
|
|
|
|
```jsx react
|
|
import { useState } from 'react';
|
|
import { SlAvatar, SlButton, SlTooltip } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const App = () => {
|
|
const [open, setOpen] = useState(false);
|
|
|
|
return (
|
|
<>
|
|
<SlButton style={{ marginRight: '4rem' }} onClick={() => setOpen(!open)}>
|
|
Toggle Manually
|
|
</SlButton>
|
|
|
|
<SlTooltip open={open} content="This is an avatar" trigger="manual">
|
|
<SlAvatar />
|
|
</SlTooltip>
|
|
</>
|
|
);
|
|
};
|
|
```
|
|
|
|
### Removing Arrows
|
|
|
|
You can control the size of tooltip arrows by overriding the `--sl-tooltip-arrow-size` design token. To remove them, set the value to `0` as shown below.
|
|
|
|
```html preview
|
|
<sl-tooltip content="This is a tooltip" style="--sl-tooltip-arrow-size: 0;">
|
|
<sl-button>No Arrow</sl-button>
|
|
</sl-tooltip>
|
|
```
|
|
|
|
```jsx react
|
|
import { SlButton, SlTooltip } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const App = () => (
|
|
<div style={{ '--sl-tooltip-arrow-size': '0' }}>
|
|
<SlTooltip content="This is a tooltip">
|
|
<SlButton>Above</SlButton>
|
|
</SlTooltip>
|
|
|
|
<SlTooltip content="This is a tooltip" placement="bottom">
|
|
<SlButton>Below</SlButton>
|
|
</SlTooltip>
|
|
</div>
|
|
);
|
|
```
|
|
|
|
To override it globally, set it in a root block in your stylesheet after the Shoelace stylesheet is loaded.
|
|
|
|
```css
|
|
:root {
|
|
--sl-tooltip-arrow-size: 0;
|
|
}
|
|
```
|
|
|
|
### HTML in Tooltips
|
|
|
|
Use the `content` slot to create tooltips with HTML content. Tooltips are designed only for text and presentational elements. Avoid placing interactive content, such as buttons, links, and form controls, in a tooltip.
|
|
|
|
```html preview
|
|
<sl-tooltip>
|
|
<div slot="content">I'm not <strong>just</strong> a tooltip, I'm a <em>tooltip</em> with HTML!</div>
|
|
|
|
<sl-button>Hover me</sl-button>
|
|
</sl-tooltip>
|
|
```
|
|
|
|
```jsx react
|
|
import { SlButton, SlTooltip } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const App = () => (
|
|
<SlTooltip>
|
|
<div slot="content">
|
|
I'm not <strong>just</strong> a tooltip, I'm a <em>tooltip</em> with HTML!
|
|
</div>
|
|
|
|
<SlButton>Hover Me</SlButton>
|
|
</SlTooltip>
|
|
);
|
|
```
|
|
|
|
### Setting a Maximum Width
|
|
|
|
Use the `--max-width` custom property to change the width the tooltip can grow to before wrapping occurs.
|
|
|
|
```html preview
|
|
<sl-tooltip style="--max-width: 80px;" content="This tooltip will wrap after only 80 pixels.">
|
|
<sl-button>Hover me</sl-button>
|
|
</sl-tooltip>
|
|
```
|
|
|
|
```jsx react
|
|
import { SlButton, SlTooltip } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const App = () => (
|
|
<SlTooltip style={{ '--max-width': '80px' }} content="This tooltip will wrap after only 80 pixels.">
|
|
<SlButton>Hover Me</SlButton>
|
|
</SlTooltip>
|
|
);
|
|
```
|
|
|
|
### Hoisting
|
|
|
|
Tooltips will be clipped if they're inside a container that has `overflow: auto|hidden|scroll`. The `hoist` attribute forces the tooltip to use a fixed positioning strategy, allowing it to break out of the container. In this case, the tooltip will be positioned relative to its containing block, which is usually the viewport unless an ancestor uses a `transform`, `perspective`, or `filter`. [Refer to this page](https://developer.mozilla.org/en-US/docs/Web/CSS/position#fixed) for more details.
|
|
|
|
```html preview
|
|
<div class="tooltip-hoist">
|
|
<sl-tooltip content="This is a tooltip">
|
|
<sl-button>No Hoist</sl-button>
|
|
</sl-tooltip>
|
|
|
|
<sl-tooltip content="This is a tooltip" hoist>
|
|
<sl-button>Hoist</sl-button>
|
|
</sl-tooltip>
|
|
</div>
|
|
|
|
<style>
|
|
.tooltip-hoist {
|
|
position: relative;
|
|
border: solid 2px var(--sl-panel-border-color);
|
|
overflow: hidden;
|
|
padding: var(--sl-spacing-medium);
|
|
}
|
|
</style>
|
|
```
|
|
|
|
```jsx react
|
|
import { SlButton, SlTooltip } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const css = `
|
|
.tooltip-hoist {
|
|
border: solid 2px var(--sl-panel-border-color);
|
|
overflow: hidden;
|
|
padding: var(--sl-spacing-medium);
|
|
position: relative;
|
|
}
|
|
`;
|
|
|
|
const App = () => (
|
|
<>
|
|
<div class="tooltip-hoist">
|
|
<SlTooltip content="This is a tooltip">
|
|
<SlButton>No Hoist</SlButton>
|
|
</SlTooltip>
|
|
|
|
<SlTooltip content="This is a tooltip" hoist>
|
|
<SlButton>Hoist</SlButton>
|
|
</SlTooltip>
|
|
</div>
|
|
|
|
<style>{css}</style>
|
|
</>
|
|
);
|
|
```
|
|
|
|
[component-metadata:sl-tooltip]
|