@firecms/core/dist/preview/PropertyPreviewProps.d.ts

Awesome Firebase/Firestore-based headless open-source CMS

import { CMSType, Property, ResolvedProperty } from "../types";
/**
 * @group Preview components
 */
export type PreviewSize = "small" | "medium" | "large";
/**
 * @group Preview components
 */
export interface PropertyPreviewProps<T extends CMSType = any, CustomProps = any> {
    /**
     * Name of the property
     */
    propertyKey?: string;
    /**
     * Current value of the property
     */
    value: T;
    /**
     * Property this display is related to
     */
    property: Property<T> | ResolvedProperty<T>;
    /**
     * Desired size of the preview, depending on the context.
     */
    size: PreviewSize;
    /**
     * Max height assigned to the preview, depending on the context.
     * It may be undefined if unlimited.
     */
    height?: number;
    /**
     * Max height width to the preview, depending on the context.
     * It may be undefined if unlimited.
     */
    width?: number;
    /**
     * Additional properties set by the developer
     */
    customProps?: CustomProps;
    /**
     * If the preview should be interactive or not.
     * This applies only to videos.
     */
    interactive?: boolean;
}