gestalt/dist/Sticky.d.ts

A set of React UI components which enforce Pinterest's design language

import { ReactNode } from 'react';
import { Indexable } from './zIndex';
type PositionType = number | string;
type Threshold = {
    top: PositionType;
    bottom?: never;
    left?: never;
    right?: never;
} | {
    top?: never;
    bottom: PositionType;
    left?: never;
    right?: never;
} | {
    top?: never;
    bottom?: never;
    left: PositionType;
    right?: never;
} | {
    top?: never;
    bottom?: never;
    left?: never;
    right: PositionType;
} | {
    top: PositionType;
    bottom: PositionType;
    left?: never;
    right?: never;
} | {
    top?: never;
    bottom?: never;
    left: PositionType;
    right: PositionType;
} | {
    top: PositionType;
    left: PositionType;
    right: PositionType;
    bottom: PositionType;
};
type Props = Threshold & {
    /**
     * The content to display.
     */
    children: ReactNode;
    /**
     * The height of the sticky container in pixels. This is useful when the sticky container and its content need to have different heights.
     */
    height?: number;
    /**
     * An object representing the z-index of the sticky container. See the [zIndex Classes](https://gestalt.pinterest.systems/web/zindex_classes) page for more information.
     */
    zIndex?: Indexable;
};
/**
 * [Sticky](https://gestalt.pinterest.systems/web/sticky) allows an element to become fixed when it reaches a threshold (top, left, bottom, or right).
 *
 * ![Sticky](https://raw.githubusercontent.com/pinterest/gestalt/master/docs/graphics/building-blocks/Sticky.svg)
 */
declare function Sticky({ bottom, children, height, left, right, top, zIndex }: Props): import("react/jsx-runtime").JSX.Element;
declare namespace Sticky {
    var displayName: string;
}
export default Sticky;