| --- |
| title: IconTooltip |
| sidebar_label: IconTooltip |
| --- |
| |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| --> |
| |
| import { StoryWithControls } from '../../../src/components/StorybookWrapper'; |
| |
| # IconTooltip |
| |
| The IconTooltip component from Superset's UI library. |
| |
| ## Live Example |
| |
| <StoryWithControls |
| component="IconTooltip" |
| props={{ |
| tooltip: "Tooltip" |
| }} |
| controls={[ |
| { |
| name: "tooltip", |
| label: "Tooltip", |
| type: "text", |
| description: "Text content to display in the tooltip." |
| }, |
| { |
| name: "placement", |
| label: "Placement", |
| type: "select", |
| options: [ |
| "bottom", |
| "bottomLeft", |
| "bottomRight", |
| "left", |
| "leftBottom", |
| "leftTop", |
| "right", |
| "rightBottom", |
| "rightTop", |
| "top", |
| "topLeft", |
| "topRight" |
| ], |
| description: "Position of the tooltip relative to the icon." |
| } |
| ]} |
| sampleChildren={[{"component":"Icons.InfoCircleOutlined","props":{"iconSize":"l"}}]} |
| /> |
| |
| ## Try It |
| |
| Edit the code below to experiment with the component: |
| |
| ```tsx live |
| function Demo() { |
| return ( |
| <IconTooltip tooltip="Helpful information"> |
| <Icons.InfoCircleOutlined iconSize="l" /> |
| </IconTooltip> |
| ); |
| } |
| ``` |
| |
| ## Props |
| |
| | Prop | Type | Default | Description | |
| |------|------|---------|-------------| |
| | `tooltip` | `string` | `"Tooltip"` | Text content to display in the tooltip. | |
| |
| ## Import |
| |
| ```tsx |
| import { IconTooltip } from '@superset/components'; |
| ``` |
| |
| --- |
| |
| :::tip[Improve this page] |
| This documentation is auto-generated from the component's Storybook story. |
| Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/IconTooltip/IconTooltip.stories.tsx). |
| ::: |