@bedrock-layout/frame/lib/index.d.ts

bedrock-layout frame

type RatioString = `${number}/${number}` | `${number} / ${number}` | `${number}:${number}` | `${number} : ${number}`;
/**
 * The `Ratio` type is used to specify the aspect ratio of the content.
 */
export type Ratio = readonly [number, number] | RatioString;
/**
 * Props for the `Frame` component.
 */
export type FrameProps = {
    /**
     * The `ratio` prop is used to specify the aspect ratio of the content.
     */
    ratio?: Ratio;
    /**
     * The `position` prop is used to specify the position of the content within the frame.
     */
    position?: string;
};
/**
 * The `Frame` component is useful for cropping content, typically media, to a desired aspect ratio.
 */
export declare const Frame: import("@bedrock-layout/type-utils").PolymorphicForwardedRefComponent<"div", FrameProps>;
export {};