@base-ui/react
Version:
Base UI is a library of headless ('unstyled') React components and low-level hooks. You gain complete control over your app's CSS and accessibility features.
43 lines • 1.43 kB
TypeScript
import * as React from 'react';
import type { BaseUIComponentProps } from "../../utils/types.js";
import { PreviewCardHandle } from "../store/PreviewCardHandle.js";
/**
* A link that opens the preview card.
* Renders an `<a>` element.
*
* Documentation: [Base UI Preview Card](https://base-ui.com/react/components/preview-card)
*/
export declare const PreviewCardTrigger: PreviewCardTrigger;
export interface PreviewCardTrigger {
<Payload>(componentProps: PreviewCardTrigger.Props<Payload> & React.RefAttributes<HTMLElement>): React.JSX.Element;
}
export interface PreviewCardTriggerState {
/**
* Whether the preview card is currently open.
*/
open: boolean;
}
export interface PreviewCardTriggerProps<Payload = unknown> extends BaseUIComponentProps<'a', PreviewCardTrigger.State> {
/**
* A handle to associate the trigger with a preview card.
*/
handle?: PreviewCardHandle<Payload>;
/**
* A payload to pass to the preview card when it is opened.
*/
payload?: Payload;
/**
* How long to wait before the preview card opens. Specified in milliseconds.
* @default 600
*/
delay?: number;
/**
* How long to wait before closing the preview card. Specified in milliseconds.
* @default 300
*/
closeDelay?: number;
}
export declare namespace PreviewCardTrigger {
type State = PreviewCardTriggerState;
type Props<Payload = unknown> = PreviewCardTriggerProps<Payload>;
}