Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
72 lines
2.4 KiB
Plaintext
72 lines
2.4 KiB
Plaintext
import type { CSSProperties } from 'react';
|
|
export * as PopupList from './PopupButtonList/index.js';
|
|
import React from 'react';
|
|
import './index.scss';
|
|
export type PopupProps = {
|
|
backgroundColor?: CSSProperties['backgroundColor'];
|
|
boundingRef?: React.RefObject<HTMLElement>;
|
|
button?: React.ReactNode;
|
|
/**
|
|
* The class name to apply to the button that triggers the popup.
|
|
*/
|
|
buttonClassName?: string;
|
|
buttonSize?: 'large' | 'medium' | 'small' | 'xsmall';
|
|
buttonType?: 'custom' | 'default' | 'none';
|
|
caret?: boolean;
|
|
children?: React.ReactNode;
|
|
/**
|
|
* The class name to apply to the popup container containing the trigger.
|
|
* This does not wrap the actual popup content, which is rendered in a portal.
|
|
*/
|
|
className?: string;
|
|
disabled?: boolean;
|
|
/**
|
|
* Force control the open state of the popup, regardless of the trigger.
|
|
*/
|
|
forceOpen?: boolean;
|
|
/**
|
|
* Preferred horizontal alignment of the popup, if there is enough space available.
|
|
*
|
|
* @default 'left'
|
|
*/
|
|
horizontalAlign?: 'center' | 'left' | 'right';
|
|
id?: string;
|
|
initActive?: boolean;
|
|
noBackground?: boolean;
|
|
onToggleClose?: () => void;
|
|
onToggleOpen?: (active: boolean) => void;
|
|
/**
|
|
* Class name to apply to the portal container.
|
|
*/
|
|
portalClassName?: string;
|
|
render?: (args: {
|
|
close: () => void;
|
|
}) => React.ReactNode;
|
|
showOnHover?: boolean;
|
|
/**
|
|
* By default, the scrollbar is hidden. If you want to show it, set this to true.
|
|
* In both cases, the container is still scrollable.
|
|
*
|
|
* @default false
|
|
*/
|
|
showScrollbar?: boolean;
|
|
size?: 'fit-content' | 'large' | 'medium' | 'small';
|
|
/**
|
|
* Preferred vertical alignment of the popup (position below or above the trigger),
|
|
* if there is enough space available.
|
|
*
|
|
* If the popup is too close to the edge of the viewport, it will flip to the opposite side
|
|
* regardless of the preferred vertical alignment.
|
|
*
|
|
* @default 'bottom'
|
|
*/
|
|
verticalAlign?: 'bottom' | 'top';
|
|
};
|
|
/**
|
|
* Component that renders a popup, as well as a button that triggers the popup.
|
|
*
|
|
* The popup is rendered in a portal, and is automatically positioned above / below the trigger,
|
|
* depending on the verticalAlign prop and the space available.
|
|
*/
|
|
export declare const Popup: React.FC<PopupProps>;
|
|
//# sourceMappingURL=index.d.ts.map |