Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@aria-ui/tooltip

Package Overview
Dependencies
Maintainers
1
Versions
25
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@aria-ui/tooltip

## TooltipContent

  • 0.0.11
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

@aria-ui/tooltip

TooltipContent

TooltipContentElement

A custom TooltipContent element.

Properties: TooltipContentProps

new TooltipContentElement(props?: Partial<TooltipContentProps>): TooltipContentElement

TooltipContentDataAttributes

PropertyType
data-state"open" | "closed"

TooltipContentProps

PropertyTypeDescription
altBoundarybooleanSee
https://floating-ui.com/docs/detectoverflow

Default
true
autoUpdateboolean | Partial<Object>Options to activate auto-update listeners

See
https://floating-ui.com/docs/autoUpdate

Default
true
boundaryBoundarySee
https://floating-ui.com/docs/detectoverflow

Default
'clippingAncestors'
elementContextElementContextSee
https://floating-ui.com/docs/detectoverflow

Default
'floating'
fitViewportbooleanWhether to constrain the floating element's width and height to not exceed
the viewport.

Default
false
flipboolean | Placement[]Whether to flip the placement in order to keep it in view when the
preferred placement(s) will overflow the clipping boundary. You can also
provide an array of placements to try sequentially if the preferred
placement does not fit.

Default
false
hidebooleanWhether to hide the floating element when the reference element or the
floating element is fully clipped.

Default
false
hoistbooleanWhether to use the browser Popover API
to place the floating element on top of other page content. When enabled,
the floating element won't be clipped by an ancestor. This provides a
similar result to React's <Portals> or Vue's <Teleport>.

Default
"true"
inlinebooleanWhether to improve positioning for inline reference elements that span over
multiple lines.

Default
false
offsetnull | OffsetOptionsThe distance between the reference and floating element.

Default
null
overflowPaddingnumberSee
https://floating-ui.com/docs/detectoverflow

Default
0
overlapbooleanWhether the floating element can overlap the reference element to keep it
in view.

Default
false
placementPlacementThe initial placement of the floating element

Default
"top"
rootBoundaryRootBoundarySee
https://floating-ui.com/docs/detectoverflow

Default
'viewport'
sameHeightbooleanWhether to constrain the floating element's height so that it matches the
reference element.

Default
false
sameWidthbooleanWhether to constrain the floating element's width so that it matches the
reference element.

Default
false
shiftbooleanWhether the floating element should shift to keep it in view.

Default
false
strategy"absolute" | "fixed"The strategy to use for positioning

Default
"absolute"
transformbooleanWhether to use transform: translate3d() for positioning instead of top
and left (layout) to place the floating element.

Default
false

useTooltipContent()

function useTooltipContent(
  element: ConnectableElement,
  props?: Partial<TooltipContentProps>,
): SingalState<TooltipContentProps>;

Properties: TooltipContentProps

Data attributes: TooltipContentDataAttributes

TooltipRoot

TooltipRootElement

A custom TooltipRoot element.

Properties: TooltipRootProps

new TooltipRootElement(props?: Partial<TooltipRootProps>): TooltipRootElement

TooltipRootProps

PropertyTypeDescription
closeDelaynumberThe delay in milliseconds before the tooltip closes.

Default
300
openDelaynumberThe delay in milliseconds before the tooltip opens.

Default
700

useTooltipRoot()

function useTooltipRoot(
  element: ConnectableElement,
  props?: Partial<TooltipRootProps>,
): SingalState<TooltipRootProps>;

TooltipTrigger

TooltipTriggerElement

A custom TooltipTrigger element.

new TooltipTriggerElement(): TooltipTriggerElement

useTooltipTrigger()

function useTooltipTrigger(element: ConnectableElement): void;

FAQs

Package last updated on 09 Apr 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc