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

@leafygreen-ui/tooltip

Package Overview
Dependencies
Maintainers
3
Versions
97
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@leafygreen-ui/tooltip

LeafyGreen UI Kit Tooltip

  • 2.0.2
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
52K
increased by14.26%
Maintainers
3
Weekly downloads
 
Created
Source

Tooltip

npm (scoped)

Example

import Tooltip from '@leafygreen-ui/tooltip';

<Tooltip
  align="top"
  justify="start"
  trigger={<button>trigger</button>}
  triggerEvent="hover"
  variant="dark"
>
  I am an uncontrolled Tooltip!
</Tooltip>;

Output HTML

<button aria-describedby="tooltip-6">
  trigger
  <div class="leafygreen-ui-1hyfx7x"></div>
</button>
<div>
  <div class="leafygreen-ui-63ea86">
    <div role="tooltip" id="tooltip-6" class="leafygreen-ui-a17v6a">
      <div class="leafygreen-ui-11wlmto">
        <div class="leafygreen-ui-ry7wu4"></div>
      </div>
      I am an uncontrolled Tooltip!
    </div>
  </div>
</div>

Properties

PropTypeDescriptionDefault
openbooleanControls the component, and determines whether or not the <Tooltip /> will appear open or closed.false
setOpenfunctionIf controlling the component, pass state handling function to setOpen prop. This will keep the consuming application's state in-sync with LeafyGreen's state, while the <Tooltip /> component responds to events such as backdrop clicks and a user pressing the Escape key.(boolean) => boolean
shouldClosefunctionCallback that should return a boolean that determines whether or not the <Tooltip /> should close when a user tries to close it.() => true
align'top', 'bottom', 'left', 'right'Determines the preferred alignment of the <Tooltip /> component relative to the element passed to the trigger prop. If no trigger is passed, the Tooltip will be positioned against its nearest parent element.'top'
justify'start', 'middle', 'end'Determines the preferred justification of the <Tooltip /> component (based on the alignment) relative to the element passed to the trigger prop. If no trigger is passed, the Tooltip will be positioned against its nearest parent element.'start'
triggerHTMLElement or ReactNodeAn HTMLElement or ReactNode against which the <Tooltip /> will be positioned, and what will be used to trigger the opening and closing of the Tooltip component, when the Tooltip is uncontrolled. If no trigger is passed, the Tooltip will be positioned against its nearest parent element. If using a ReactNode or inline function, trigger signature is: ({children, ...rest}) => (<button {...rest}>trigger {children})
triggerEvent'hover' or 'click'DOM event that triggers opening/closing of <Tooltip /> component'hover'
variant'light' or 'dark'Determines the color variant of the <Tooltip /> component.'light
idstringid applied to <Tooltip /> component
classNamestringApplies a className to Tooltip container
childrennodeContent that will be rendered inside of <Tooltip />

Any other properties will be spread on the Tooltip div container

FAQs

Package last updated on 20 Nov 2019

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