Perseus
    Preparing search index...

    Interface Props

    Options for the image widget. Shows an image with a caption and alt text.

    interface Props {
        alt?: string;
        apiOptions: APIOptions;
        backgroundImage: PerseusImageBackground;
        box?: Size;
        caption?: string;
        decorative?: boolean;
        labels?: PerseusImageLabel[];
        longDescription?: string;
        onChange: (newValues: Partial<PerseusImageWidgetOptions>) => void;
        range?: [Interval, Interval];
        scale?: number;
        static?: boolean;
        title?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    alt? apiOptions backgroundImage box? caption? decorative? labels? longDescription? onChange range? scale? static? title?

    Properties

    alt?: string

    Translatable Text; The alt text to be shown in the img.alt attribute

    apiOptions: APIOptions
    backgroundImage: PerseusImageBackground

    The image details for the image to be displayed

    box?: Size
    • box for labels was removed from the image widget in 2017
    caption?: string

    Translatable Markdown; Text to be shown in the caption section of an image

    decorative?: boolean

    When true, standalone image will be rendered with alt="" and without any alt text, caption, title, or long description.

    labels?: PerseusImageLabel[]
    • labels were removed from the image widget in 2017
    longDescription?: string

    Translatable Markdown; Text to be shown as the long description of an image

    onChange: (newValues: Partial<PerseusImageWidgetOptions>) => void
    range?: [Interval, Interval]
    • range for labels was removed from the image widget in 2017
    scale?: number

    The size scale of the image

    static?: boolean

    Always false. Not used for this widget

    title?: string

    Translatable Markdown; Text to be shown for the title of the image

    Settings

    Member Visibility

    On This Page

    Properties