Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CardDisplayMode

interface

CardDisplayMode

description

This type defines the display mode settings for an individual card component. Display modes are used to determine whether a card must be displayed or not in the event of errors or the dataset being empty.

By default, cards that produce errors are hidden and cards that contain empty datasets are displayed.

since

v0.1.0

Hierarchy

  • CardDisplayMode

Index

Properties

classes: string[]

A list of custom CSS classes that should be added on the component tag. This applies to the <card> or <table-card> elements, not to their dynamic content.

It is recommended to add container classes from TailWind in this property if any must be set on a card instance.

var

{string[]}

onEmpty: string | boolean

This property defines whether a card should be displayed or not given an empty dataset. Typically, this should be set to true as it is usual to display a message to the end-user when datasets are returned empty.

Note that setting a string value for this field will use the value as a message being displayed given an empty dataset.

var

{boolean | string}

onError: string | boolean

This property defines whether a card should be displayed or not given an error during discovery. Typically, this should be set to false as it is usual to avoid displaying error information in production environments.

Note that setting a string value for this field will use the value as a message being displayed given an error during discovery.

var

{boolean | string}

The display size defines whether the card should be using the full screen width or be adaptive in that it adapts its width to its' own content.

var

{CardWrapperSize}

Generated using TypeDoc