@tinacms/toolkit
Version:
Tina is a lightweight but powerful toolkit for creating a site editing ui with javascript components. Tina surfaces superpowers for dev’s to create, expand on and customize a simple yet intuitive ui for editing content.
38 lines (34 loc) • 1.1 kB
TypeScript
/**
*/
import * as React from 'react';
export interface DismissibleProps {
/**
* The function that called in response to a dismissal.
*/
onDismiss: Function;
/**
* If `true`, pressing `ESC` key will trigger a dismissal. Default: `false`
*/
escape?: boolean;
/**
* When `true` clicking outside of the surrounding area triggers a dismissal. Default: `false`
*/
click?: boolean;
/**
* When `true` there will be no dismissals. Default: `false`
*/
disabled?: boolean;
/**
* An extra Document to add the event listeners too.
*
* Used when the dismissible area is inside of an iframe.
*/
document?: Document;
/**
* Adding this flag allows click events outside of the
* dismissible area to propagate to their intended target.
*/
allowClickPropagation?: boolean;
}
export declare const Dismissible: React.FC<DismissibleProps>;
export declare function useDismissible({ onDismiss, escape, click, disabled, allowClickPropagation, document: customDocument, }: DismissibleProps): any;