animation
説明
The animation of the tooltip.
タイプ
"bottom" | "left" | "right" | "scale" | "top" | "none"デフォルト
'scale'Tooltip
Tooltipは、要素の補足など短い情報を表示するコンポーネントです。
Props
TooltipProps
as
説明
The HTML element to render.
タイプ
keyof ReactDOMboundary
説明
The boundary area for the popper. Used within the preventOverflow modifier.
タイプ
HTMLElement | "clippingParents" | "scrollParent"デフォルト
'clippingParents'closeDelay
説明
The delay before hiding the tooltip.
タイプ
numberデフォルト
0closeOnClick
説明
If true, the tooltip will hide on click.
タイプ
booleanデフォルト
falsecloseOnEsc
説明
If true, the tooltip will hide on pressing Esc key.
タイプ
booleanデフォルト
truecloseOnMouseDown
説明
If true, the tooltip will hide while the mouse is down.
タイプ
booleanデフォルト
falsecloseOnPointerDown
説明
If true, the tooltip will hide while the pointer is down.
タイプ
booleanデフォルト
falsecloseOnScroll
説明
If true, the tooltip will hide on scroll.
タイプ
booleanデフォルト
falsedefaultIsOpen
非推奨説明
If true, the tooltip will be initially shown.
非推奨
Use defaultOpen instead.
タイプ
booleandefaultOpen
説明
If true, the tooltip will be initially shown.
タイプ
booleandisabled
説明
If true, the tooltip will be disabled.
タイプ
booleanデフォルト
falseduration
説明
The animation duration.
タイプ
number | MotionLifecycleProps<number>eventListeners
説明
If provided, determines whether the popper will reposition itself on scroll and resize of the window.
タイプ
type ONLY_FOR_FORMAT =
| boolean
| { resize?: boolean | undefined; scroll?: boolean | undefined }デフォルト
trueflip
説明
If true, the popper will change its placement and flip when it's about to overflow its boundary area.
タイプ
booleanデフォルト
truegutter
説明
The distance or margin between the reference and popper.
It is used internally to create an offset modifier.
タイプ
UIValue<number>デフォルト
8isDisabled
非推奨説明
If true, the tooltip will be disabled.
非推奨
Use disabled instead.
タイプ
booleanデフォルト
falseisOpen
非推奨説明
If true, the tooltip will be shown.
非推奨
Use open instead.
タイプ
booleanlabel
説明
The label of the tooltip.
タイプ
type ONLY_FOR_FORMAT =
| string
| number
| boolean
| ReactElement<any, string | JSXElementConstructor<any>>
| Iterable<ReactNode>
| ReactPortalmatchWidth
説明
If true, the popper will match the width of the reference at all times.
It's useful for autocomplete, date-picker and select patterns.
タイプ
booleanデフォルト
falsemodifiers
説明
Array of popper.js modifiers. Check the docs to see the list of possible modifiers you can pass.
タイプ
Partial<Modifier<string, any>>[]ドキュメント
https://popper.js.org/docs/v2/modifiers/offset
説明
The main and cross-axis offset to displace popper element from its reference element.
タイプ
[number, number]onClose
説明
Callback to run when the tooltip hides.
タイプ
() => voidonOpen
説明
Callback to run when the tooltip shows.
タイプ
() => voidopen
説明
If true, the tooltip will be shown.
タイプ
booleanopenDelay
説明
The delay before showing the tooltip.
タイプ
numberデフォルト
0placement
説明
The placement of the popper relative to its reference.
タイプ
UIValue<Placement>デフォルト
'bottom'portalProps
説明
Props for portal component.
タイプ
Pick<PortalProps,
"appendToParentPortal" | "containerRef">preventOverflow
説明
If true, will prevent the popper from being cut off and ensure it's visible within the boundary area.
タイプ
booleanデフォルト
truestrategy
説明
The CSS positioning strategy to use.
タイプ
"absolute" | "fixed"デフォルト
'absolute'withPortal
説明
If true, the element will be transported to the end of document.body.
タイプ
booleanGitHubでこのページを編集する