Lime Web Components API Documentation - v7.9.0
    Preparing search index...

    Type Alias ConfigDescriptionBeta

    A short summary of one part of a config.

    The part can be a configured instance of a resource, such as one info tile, or plain config, such as one account in a list. The summary tells parts of the same kind apart, for example two info tiles that show different filters.

    Every field is optional. A field that is set replaces what would be shown otherwise, and a field that is left out keeps it. Text is already translated.

    type ConfigDescription = {
        badge?: string | number;
        facts?: ConfigFact[];
        icon?: string | Icon;
        title?: string;
    }
    Index

    Properties

    badge?: string | number

    A short count or status for the part, for example "4/7" for four options checked out of seven.

    A badge of 0 counts as no badge.

    facts?: ConfigFact[]

    A few short facts about the part, for example the limetype and the filter.

    The most useful fact comes first, because there may be room for only the first few. A fact with no value is left out.

    icon?: string | Icon

    An icon for the part.

    title?: string

    A name for the part, for example the name of an account.