From a86a1be7ccea730bffb96d3b1f626da961e891b8 Mon Sep 17 00:00:00 2001 From: Eric Liu Date: Sat, 3 May 2025 11:08:04 -0700 Subject: [PATCH] docs(tooltip-icon): improve docs --- docs/src/pages/components/TooltipIcon.svx | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/src/pages/components/TooltipIcon.svx b/docs/src/pages/components/TooltipIcon.svx index 3d23e343..4bdfeae6 100644 --- a/docs/src/pages/components/TooltipIcon.svx +++ b/docs/src/pages/components/TooltipIcon.svx @@ -5,12 +5,18 @@ import Preview from "../../components/Preview.svelte"; -## Default ("bottom" direction, "center" aligned) +`TooltipIcon` displays contextual information when users hover over or focus on an icon. It's ideal for providing additional context about icons or actions in your interface. + +## Default + +Display a tooltip with the default bottom-center alignment. ## Directions +Position the tooltip in different directions and alignments using the `direction` and `align` props. + @@ -18,7 +24,7 @@ ## Custom tooltip text -Use the "text" slot to customize the tooltip text. +Use the `tooltipText` slot to customize the tooltip content with additional styling. Carbon is an open source design system by IBM. @@ -26,4 +32,6 @@ Use the "text" slot to customize the tooltip text. ## Disabled state +Set `disabled` to `true` to prevent user interaction with the tooltip. + \ No newline at end of file