Documents / @faasjs/ant-design / FaasDataWrapperProps

Interface: FaasDataWrapperProps<T>

Ant Design wrapper props for the underlying @faasjs/react data wrapper.

Extends

• FaasDataWrapperProps<T>

Type Parameters

T

T extends FaasActionPaths = any

Registered action path used to infer params and response data.

Methods

onDataChange()?

optional onDataChange(args): void

Callback invoked whenever the resolved data value changes.

Parameters

args

FaasDataInjection<T>

Returns

void

Inherited from

OriginProps.onDataChange

render()?

optional render(args): Element | Element[]

Render prop invoked with the resolved request state after the first load completes.

Parameters

args

FaasDataInjection<T>

Returns

Element | Element[]

Inherited from

OriginProps.render

Properties

action

action: T

Action path to request.

Inherited from

OriginProps.action

baseUrl?

optional baseUrl?: `${string}/`

Base URL override used for this wrapper instance.

Inherited from

OriginProps.baseUrl

children?

optional children?: ReactElement<Partial<FaasDataInjection<T>>, string | JSXElementConstructor<any>>

Child element cloned with injected request state after the first load completes.

Inherited from

OriginProps.children

data?

optional data?: FaasData<T>

Controlled data value used instead of internal state.

Inherited from

OriginProps.data

fallback?

optional fallback?: false | Element

Element rendered before the first successful load.

Inherited from

OriginProps.fallback

loading?

optional loading?: Element

Explicit loading element that overrides the built-in Loading fallback.

loadingProps?

optional loadingProps?: LoadingProps

Props forwarded to the built-in Loading fallback.

params?

optional params?: FaasParams<T>

Params sent to the action.

Inherited from

OriginProps.params

polling?

optional polling?: number | false

Milliseconds to wait after each completed request before refreshing data in the background.

Inherited from

OriginProps.polling

ref?

optional ref?: Ref<FaasDataWrapperRef<T>>

Imperative ref exposing the current injected request state.

Inherited from

OriginProps.ref

setData?

optional setData?: Dispatch<SetStateAction<FaasData<T>>>

Controlled setter used instead of internal state.

Inherited from

OriginProps.setData