Class CustomFieldInternal

Array where each object represents a custom preview field. Preview fields are displayed on the bottom half of the app card in the compact view.

Hierarchy

  • CustomField

Constructors

constructor

Properties

fillColor? iconShape? iconUrl? textColor? tooltip? value?

Constructors

constructor

Properties

Optional fillColor

fillColor?: string

Hex value representing the color that fills the background area of the preview field, when it's displayed on the app card.

Optional iconShape

iconShape?: string = CustomField.IconShapeEnum.Round

The shape of the icon on the preview field.

Optional iconUrl

iconUrl?: string

A valid URL pointing to an image available online. The transport protocol must be HTTPS. Possible image file formats: JPG/JPEG, PNG, SVG.

Optional textColor

textColor?: string

Hex value representing the color of the text string assigned to value.

Optional tooltip

tooltip?: string

A short text displayed in a tooltip when clicking or hovering over the preview field.

Optional value

value?: string

The actual data value of the custom field. It can be any type of information that you want to convey.

@mirohq/miro-api