GeoLeaf Core API - v3.0.0
    Preparing search index...

    Interface RenderField

    Field-config shape consumed by the ported renderers. Mirrors the authored layout entries of the pre-extraction core (type, variant, accordion, …) plus an index signature for renderer-specific extras. Every property is optional except field; renderers read only what they need.

    interface RenderField {
        field: string;
        type?: string;
        label?: string;
        style?: string;
        variant?: string;
        accordion?: boolean;
        defaultOpen?: boolean;
        columns?: { key: string; label?: string }[];
        borders?: Record<string, unknown>;
        maxCount?: number;
        prefix?: string;
        suffix?: string;
        closedLabel?: string;
        hidden?: boolean;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

      Escape hatch for renderer-specific configuration keys.

    Index

    Properties

    field type? label? style? variant? accordion? defaultOpen? columns? borders? maxCount? prefix? suffix? closedLabel? hidden?

    Properties

    field: string

    Dotted path resolved against the normalized feature model (e.g. attributes.photo).

    type?: string

    Renderer selector (text, image, list, table, tags, badge, …).

    label?: string

    Human label shown as a section heading or link text.

    style?: string

    Presentation style (title, multiline, …).

    variant?: string

    Renderer variant (hero, short, disc, …).

    accordion?: boolean

    Wrap the section in a collapsible accordion.

    defaultOpen?: boolean

    Open the accordion by default when accordion is set.

    columns?: { key: string; label?: string }[]

    Table column descriptors ({ key, label? }).

    borders?: Record<string, unknown>

    Table border toggles / colour (outer, row, column, color).

    maxCount?: number

    Maximum number of items rendered (e.g. reviews).

    prefix?: string

    Text inserted before the resolved value.

    suffix?: string

    Text inserted after the resolved value.

    closedLabel?: string

    Label shown when an accordion is closed.

    hidden?: boolean

    Skip rendering this field entirely.

    Settings

    Member Visibility

    On This Page

    Properties