EntityRefPresentationSnapshot.Icon

Home > @backstage/plugin-catalog-react > EntityRefPresentationSnapshot > Icon

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

Signature:

Icon?: IconComponent | undefined | false;

Remarks

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).