TooltipTooltip
Tooltip dostarcza dodatkowych podpowiedzi tekstowych lub informacji kontekstowych dla określonego elementu, pomagając zrozumieć jego funkcję lub przeznaczenie.
Sposób użycia
Zaimportuj komponent:
import 'mdui/components/tooltip.js';
Zaimportuj typ TypeScript komponentu:
import type { Tooltip } from 'mdui/components/tooltip.js';
Przykład użycia:
<mdui-tooltip content="Zwykły tooltip">
<mdui-button>przycisk</mdui-button>
</mdui-tooltip>Przykłady
Zwykły tooltip
Domyślnie tooltip jest zwykły. Możesz ustawić treść tooltipa za pomocą atrybutu content.
Możesz również ustawić treść tooltipa za pomocą slotu content.
Bogaty tooltip
Ustawienie atrybutu variant na rich tworzy bogaty tooltip. Możesz ustawić tytuł tooltipa za pomocą atrybutu headline, a treść za pomocą atrybutu content.
Możesz również ustawić tytuł i treść tooltipa za pomocą slotów headline i content. Użyj slotu action, aby dodać przycisk akcji.
Pozycja
Atrybut placement ustawia pozycję tooltipa.
Sposób wyzwalania
Atrybut trigger ustawia sposób wyzwalania tooltipa.
Opóźnienie otwierania/zamykania
Gdy sposób wyzwalania to hover, możesz ustawić opóźnienie otwierania i zamykania tooltipa za pomocą atrybutów open-delay i close-delay, odpowiednio w milisekundach.
Stan wyłączony
Dodanie atrybutu disabled wyłącza tooltip.
API
Właściwości
| Atrybut HTML | Właściwość JavaScript | Reflect | Typ | Domyślne |
|---|---|---|---|---|
variant | variant | 'plain' | 'rich' | 'plain' | |
Wariant tooltipa. Domyślnie
| ||||
placement | placement | 'auto' | 'top-left' | 'top-start' | 'top' | 'top-end' | 'top-right' | 'bottom-left' | 'bottom-start' | 'bottom' | 'bottom-end' | 'bottom-right' | 'left-start' | 'left' | 'left-end' | 'right-start' | 'right' | 'right-end' | 'auto' | |
Pozycja tooltipa. Domyślnie
| ||||
open-delay | openDelay | number | 150 | |
Opóźnienie wyświetlenia po najechaniu myszą, w milisekundach | ||||
close-delay | closeDelay | number | 150 | |
Opóźnienie ukrycia po najechaniu myszą, w milisekundach | ||||
headline | headline | string | - | |
Tytuł tooltipa. Można używać tylko, gdy | ||||
content | content | string | - | |
Treść tooltipa. Można również ustawić za pomocą | ||||
trigger | trigger | 'click' | 'hover' | 'focus' | 'manual' | string | 'hover focus' | |
Sposób wyzwalania. Obsługuje wiele wartości oddzielonych spacjami. Dozwolone wartości:
| ||||
disabled | disabled | boolean | false | |
Określa, czy tooltip jest wyłączony. | ||||
open | open | boolean | false | |
Określa, czy tooltip jest wyświetlany. | ||||
Zdarzenia
| Nazwa |
|---|
open |
Wywoływane przed wyświetleniem tooltipa. Można zapobiec otwarciu, wywołując |
opened |
Wywoływane po zakończeniu animacji wyświetlania tooltipa |
close |
Wywoływane przed ukryciem tooltipa. Można zapobiec zamknięciu, wywołując |
closed |
Wywoływane po zakończeniu animacji ukrywania tooltipa |
Slots
| Nazwa |
|---|
| (domyślny) |
Element docelowy wyzwalający tooltip, tylko pierwszy element w slocie domyślnym będzie elementem docelowym |
headline |
Tytuł tooltipa, ten slot jest skuteczny tylko wtedy, gdy |
content |
Treść tooltipa, może zawierać HTML. Jeśli zawiera tylko zwykły tekst, można użyć atrybutu |
action |
Przycisk na dole tooltipa, ten slot jest skuteczny tylko wtedy, gdy |
Właściwości niestandardowe CSS
| Nazwa |
|---|
--shape-corner-plain |
Wielkość zaokrąglenia rogów komponentu, gdy variant="plain". Można określić konkretną wartość w pikselach; ale zaleca się odwołanie do tokenów projektowych |
--shape-corner-rich |
Wielkość zaokrąglenia rogów komponentu, gdy variant="rich". Można określić konkretną wartość w pikselach; ale zaleca się odwołanie do tokenów projektowych |
--z-index |
Wartość CSS |