Interface DetailViewConfig

interface DetailViewConfig {
    alwaysShowPropertyNames?: string[];
    article?: DetailArticleOptions;
    cardActions?: EntityActionsConfig;
    cardPresentation?: CardPresentation;
    density?: ViewDensity;
    detailLayoutType?: string;
    entityActions?: EntityActionsConfig;
    extraRenderers?: DetailRendererRegistryEntry[];
    fallbackRenderers?: DetailRendererRegistryEntry[];
    hiddenPropertyNames?: string[];
    hideHeaderPrimaryFields?: boolean;
    hideLinkedDataProperties?: boolean;
    linkedDataPropertyNames?: string[];
    maxDepth?: number;
    nesting?: DetailNestingOptions;
    onCardAction?: (
        actionId: string,
        ctx: {
            data: unknown;
            entityIRI?: string;
            typeIRI?: string;
            typeName?: string;
        },
    ) => void;
    onEntityAction?: (
        actionId: string,
        ctx: {
            data: unknown;
            entityIRI?: string;
            typeIRI?: string;
            typeName?: string;
        },
    ) => void;
    overrideRenderers?: DetailRendererRegistryEntry[];
    overrideValueRenderers?: ValueRendererEntry[];
    primaryFields?: Record<string, unknown>;
    topLevelLayoutVariant?: DetailTopLevelLayoutVariant;
    typeIRIOverrides?: Record<string, Partial<DetailViewConfig>>;
    typeIRIToTypeName?: (iri: string) => string;
    typeNameOverrides?: Record<string, Partial<DetailViewConfig>>;
    uiSchemata?: Record<string, UISchemaElement>;
    uiSchemataByTypeIRI?: Record<string, UISchemaElement>;
    valueRenderers?: ValueRendererEntry[];
}

Properties

alwaysShowPropertyNames? article? cardActions? cardPresentation? density? detailLayoutType? entityActions? extraRenderers? fallbackRenderers? hiddenPropertyNames? hideHeaderPrimaryFields? hideLinkedDataProperties? linkedDataPropertyNames? maxDepth? nesting? onCardAction? onEntityAction? overrideRenderers? overrideValueRenderers? primaryFields? topLevelLayoutVariant? typeIRIOverrides? typeIRIToTypeName? typeNameOverrides? uiSchemata? uiSchemataByTypeIRI? valueRenderers?

Properties

OptionalalwaysShowPropertyNames

alwaysShowPropertyNames?: string[]

Optionalarticle

article?: DetailArticleOptions

App-wide default for ArticleLayout presentation. Per-layout overrides via UI schema.

OptionalcardActions

cardActions?: EntityActionsConfig

Deprecated

Use entityActions.

OptionalcardPresentation

cardPresentation?: CardPresentation

Per-type card presentation merged into generated CardLayout options.

Optionaldensity

density?: ViewDensity

OptionaldetailLayoutType

detailLayoutType?: string

Root layout type used when generating a default detail UISchema ("TopLevelLayout" | "ArticleLayout" | …). Default "TopLevelLayout".

OptionalentityActions

entityActions?: EntityActionsConfig

Property-driven entity actions (parallel to ChipsConfig).

OptionalextraRenderers

extraRenderers?: DetailRendererRegistryEntry[]

OptionalfallbackRenderers

fallbackRenderers?: DetailRendererRegistryEntry[]

Lowest-priority entries appended after the size defaults (e.g. AllPropsTable).

OptionalhiddenPropertyNames

hiddenPropertyNames?: string[]

OptionalhideHeaderPrimaryFields

hideHeaderPrimaryFields?: boolean

OptionalhideLinkedDataProperties

hideLinkedDataProperties?: boolean

OptionallinkedDataPropertyNames

linkedDataPropertyNames?: string[]

OptionalmaxDepth

maxDepth?: number

Optionalnesting

nesting?: DetailNestingOptions

App-wide default for foldable nested sections. Per-scope overrides via UI schema.

OptionalonCardAction

onCardAction?: (
    actionId: string,
    ctx: {
        data: unknown;
        entityIRI?: string;
        typeIRI?: string;
        typeName?: string;
    },
) => void

Deprecated

Use onEntityAction.

OptionalonEntityAction

onEntityAction?: (
    actionId: string,
    ctx: {
        data: unknown;
        entityIRI?: string;
        typeIRI?: string;
        typeName?: string;
    },
) => void

Entity action callback for custom intents on declared actions.

OptionaloverrideRenderers

overrideRenderers?: DetailRendererRegistryEntry[]

OptionaloverrideValueRenderers

overrideValueRenderers?: ValueRendererEntry[]

Highest-priority value formatters (prepended to the merged registry).

OptionalprimaryFields

primaryFields?: Record<string, unknown>

Typically adb primaryFields map — used by TopLevelLayout (binding) for header fields

OptionaltopLevelLayoutVariant

topLevelLayoutVariant?: DetailTopLevelLayoutVariant

Top-level detail layout; default is "default".

OptionaltypeIRIOverrides

typeIRIOverrides?: Record<string, Partial<DetailViewConfig>>

OptionaltypeIRIToTypeName

typeIRIToTypeName?: (iri: string) => string

Typically useAdbContext().typeIRIToTypeName

OptionaltypeNameOverrides

typeNameOverrides?: Record<string, Partial<DetailViewConfig>>

OptionaluiSchemata

uiSchemata?: Record<string, UISchemaElement>

Per-type-name UISchema roots

OptionaluiSchemataByTypeIRI

uiSchemataByTypeIRI?: Record<string, UISchemaElement>

Per-type-IRI UISchema roots

OptionalvalueRenderers

valueRenderers?: ValueRendererEntry[]

App value formatters; merged before framework defaults unless overridden.

Settings

Member Visibility

On This Page

Properties