import { ToggleTip, ToggleTipActions } from "wis/toggleTip"

API Reference#

ToggleTip#

Name	Type	Default	Description
side	top right left bottom	top	The preferred side of the trigger to render against when open. May change when collisions occur.
align	start center end	center	The preferred alignment against the trigger. May change when collisions occur.
text	string	none	The content text to render in the toggleTip.
open	boolean	none	The controlled open state of the toggleTip. Must be used in conjunction with onOpen
defaultOpen	boolean	none	The open state of the toggleTip when it is initially rendered.
onOpen	(open: boolean) => void	none	Event handler called when the toggleTip is open state change.

ToggleTipActions#

None

Method#

import { useRef } from "react"
import { ToggleTip, type ToggleTipRef } from "wis/toggleTip"
 
function () {
  const toggleTip = useRef<ToggleTipRef>(null);
 
  return <ToggleTip ref={toggleTip} text="The tip content" />
}

Type Definition

interface ToggleTipRef {
  show: () => void;
  hide: () => void;
}

show(): void#

Display the toggle tip content

hide(): void#

Hide the toggle tip content