@avvyr/storefront-sdk - v0.19.0
    Preparing search index...

    Interface StorefrontAsset

    interface StorefrontAsset {
        assetId?: string;
        name?: string | null;
        path?: string;
        type: string & {} | "image" | "video" | "document" | "drawing";
        url: string;
        view?: "top" | "front" | "side" | null;
    }
    Index
    assetId? name? path? type url view?
    assetId?: string

    The asset's id, e.g. for assets.list({ ids })

    name?: string | null

    Asset display name (original filename or admin-set). Plain string — not localized.

    path?: string
    type: string & {} | "image" | "video" | "document" | "drawing"

    "drawing": a dimensioned drawing of the product (SVG or PNG), never a card or cart picture. Pick the picture with type === "image"; a planner/builder reads type === "drawing" with view: "top" (SVG viewBox in cm, back at the top), see options.drawingOf. Other document types (product-sheet, assembly-instruction, …) come through as stored.

    url: string
    view?: "top" | "front" | "side" | null

    Drawings only: which side the drawing shows.

    Settings
    Member Visibility

    On This Page
    Properties