FaasJS
Home
  • Guide
  • Documents
  • Templates
  • Changelog
  • Ecosystem

    • Docker Images
  • Github
  • Contributing
  • Sponsor
  • Security
Home
  • Guide
  • Documents
  • Templates
  • Changelog
  • Ecosystem

    • Docker Images
  • Github
  • Contributing
  • Sponsor
  • Security

Documents / @faasjs/ant-design / DescriptionWithFaasProps

Interface: DescriptionWithFaasProps<Path, T, ExtendItemProps>

Props for the Description component when fetching data via FaasJS.

Extends

  • DescriptionCommonProps<T, ExtendItemProps>

Type Parameters

Path

Path extends FaasActionPaths = any

Action path type inferred from faasData.action.

T

T = any

Data record shape rendered by the description list.

ExtendItemProps

ExtendItemProps = any

Additional item prop shape accepted by items.

Methods

renderTitle()?

optional renderTitle(this, values): ReactNode

Callback that returns a custom React node for the title.

Parameters

this

void

values

T

Returns

ReactNode

Inherited from

DescriptionCommonProps.renderTitle

Properties

dataSource?

optional dataSource?: undefined

Must not be set when using faasData.

extendTypes?

optional extendTypes?: object

Custom type renderers keyed by item type.

Index Signature

[key: string]: ExtendDescriptionTypeProps<any>

Inherited from

DescriptionCommonProps.extendTypes

faasData?

optional faasData?: FaasDataWrapperProps<Path>

FaasJS data wrapper configuration that fetches the data source.

items

items: (DescriptionItemProps<any> | ExtendItemProps)[]

Item metadata definitions rendered as description entries.

Inherited from

DescriptionCommonProps.items