Interface UIVariantFactory

Lazily creates a UI variant the first time it is selected.

If the variant also needs SpatialNavigation, return it together with the created UI so both are built from the same component instances.

interface UIVariantFactory {
    condition?: UIConditionResolver;
    identifier?: UIVariantIdentifier;
    ui: () => UIContainer | Pick<UIVariant, "ui" | "spatialNavigation">;
}

Properties

Determines whether this variant can be displayed for the current player and document state.

Stable identifier for this variant, used to scope variant-specific component config in UIConfig.componentConfigOverrides.

ui: () => UIContainer | Pick<UIVariant, "ui" | "spatialNavigation">

Creates the UI container, optionally together with matching spatial navigation.