apphouse
Version:
Component library for React that uses observable state management and theme-able components.
40 lines (39 loc) • 885 B
TypeScript
import React from 'react';
import { StyleOverwrites } from './component.interfaces';
export interface TooltipStyleType {
container?: React.CSSProperties;
tooltip?: React.CSSProperties;
}
export interface TooltipProps extends StyleOverwrites<TooltipStyleType> {
/**
* The message content of the tooltip
*/
text: string;
/**
* the children of the tooltip
*/
children: React.ReactNode;
/**
* if true it will limit the width of the tooltip to the width of the contents
* @default false
*/
noCutOff?: boolean;
}
/**
* The Tooltip component
*
* ** This component is still under development **
*
* usage:
*
* `npm install apphouse`
*
* ```tsx
*
* `import { Tooltip } from 'apphouse';`
*
* `<Tooltip text="Tooltip text">Hover over me</Tooltip>`
* ```
*
*/
export declare const Tooltip: React.FC<TooltipProps>;