Backstage
    Preparing search index...

    Interface EntityRefPresentationSnapshot

    The visual presentation of an entity reference at some point in time.

    interface EntityRefPresentationSnapshot {
        entityRef: string;
        Icon?: false | IconComponent;
        primaryTitle: string;
        secondaryTitle?: string;
    }
    Index

    Properties

    entityRef Icon? primaryTitle secondaryTitle?

    Properties

    entityRef: string

    The ref to the entity that this snapshot represents.

    Note that when the input data was broken or had missing vital pieces of information, this string may contain placeholders such as "unknown". You can therefore not necessarily assume that the ref is completely valid and usable for example for forming a clickable link to the entity.

    Icon?: false | IconComponent

    Optionally, an icon that represents the kind/type of entity.

    This icon should ideally be easily recognizable as the kind of entity, and be used consistently throughout the Backstage interface. It can be rendered both in larger formats such as in a header, or in smaller formats such as inline with regular text, so bear in mind that the legibility should be high in both cases.

    A value of false here indicates the desire to not have an icon present for the given implementation. A value of undefined leaves it at the discretion of the display layer to choose what to do (such as for example showing a fallback icon).

    primaryTitle: string

    A string that can be used as a plain representation of the entity, for example in a header or a link.

    The title may be short and not contain all of the information that the entity holds. When rendering the primary title, you may also want to make sure to add more contextual information nearby such as the icon or secondary title, since the primary could for example just be the metadata.name of the entity which might be ambiguous to the reader.

    secondaryTitle?: string

    Optionally, some additional textual information about the entity, to be used as a clarification on top of the primary title.

    This text can for example be rendered in a tooltip or be used as a subtitle. It may not be sufficient to display on its own; it should typically be used in conjunction with the primary title. It can contain such information as the entity ref and/or a spec.type etc.

    Settings

    Member Visibility

    On This Page

    Properties