Sanity Library Reference Docs
    Preparing search index...

    Interface DefaultPreviewPropsBeta

    interface DefaultPreviewProps {
        actions?: ReactNode | ComponentType<{ layout: "default" }>;
        children?: ReactNode;
        description?: ReactNode | ComponentType<{ layout: "default" }>;
        error?: Error;
        fallbackTitle?: ReactNode;
        imageUrl?: string;
        isPlaceholder?: boolean;
        layout?: "default";
        media?:
            | string
            | number
            | bigint
            | boolean
            | ReactElement<unknown, string | JSXElementConstructor<any>>
            | Iterable<ReactNode, any, any>
            | ReactPortal
            | Promise<AwaitedReactNode>
            | SanityReference
            | SanityImageAsset
            | SanityAssetIdStub
            | SanityAssetUrlStub
            | SanityAssetPathStub
            | SanityImageObjectStub
            | SanityImageUploadStub
            | ComponentClass<
                { dimensions: PreviewMediaDimensions; layout: "default" },
                any,
            >
            | FunctionComponent<
                { dimensions: PreviewMediaDimensions; layout: "default" },
            >;
        mediaDimensions?: PreviewMediaDimensions;
        progress?: number;
        schemaType?: SchemaType;
        status?: ReactNode | ComponentType<{ layout: "default" }>;
        styles?: {
            children?: string;
            hasSubtitle?: string;
            heading?: string;
            media?: string;
            mediaString?: string;
            placeholder?: string;
            root?: string;
            status?: string;
            subtitle?: string;
            title?: string;
        };
        subtitle?: ReactNode
        | ComponentType<{ layout: "default" }>;
        title?: ReactNode | ComponentType<{ layout: "default" }>;
        withBorder?: boolean;
        withRadius?: boolean;
        withShadow?: boolean;
    }

    Hierarchy

    • Omit<PreviewProps<"default">, "renderDefault">
      • DefaultPreviewProps
    Index

    Properties

    actions?: ReactNode | ComponentType<{ layout: "default" }>
    children?: ReactNode
    description?: ReactNode | ComponentType<{ layout: "default" }>
    error?: Error
    fallbackTitle?: ReactNode
    imageUrl?: string
    isPlaceholder?: boolean
    layout?: "default"
    media?:
        | string
        | number
        | bigint
        | boolean
        | ReactElement<unknown, string | JSXElementConstructor<any>>
        | Iterable<ReactNode, any, any>
        | ReactPortal
        | Promise<AwaitedReactNode>
        | SanityReference
        | SanityImageAsset
        | SanityAssetIdStub
        | SanityAssetUrlStub
        | SanityAssetPathStub
        | SanityImageObjectStub
        | SanityImageUploadStub
        | ComponentClass<
            { dimensions: PreviewMediaDimensions; layout: "default" },
            any,
        >
        | FunctionComponent<
            { dimensions: PreviewMediaDimensions; layout: "default" },
        >
    mediaDimensions?: PreviewMediaDimensions
    progress?: number
    schemaType?: SchemaType
    status?: ReactNode | ComponentType<{ layout: "default" }>
    styles?: {
        children?: string;
        hasSubtitle?: string;
        heading?: string;
        media?: string;
        mediaString?: string;
        placeholder?: string;
        root?: string;
        status?: string;
        subtitle?: string;
        title?: string;
    }
    subtitle?: ReactNode | ComponentType<{ layout: "default" }>
    title?: ReactNode | ComponentType<{ layout: "default" }>
    withBorder?: boolean
    withRadius?: boolean
    withShadow?: boolean