Line

You are reading the unreleased docs (next). See latest (v0.9)

ui/client/features/envelopes/hooks/useEnvelopePreviews

Cockpit client (features), next. Source: ui/client/features/envelopes/hooks/useEnvelopePreviews.ts.

Functions#

useEnvelopePreviews()#

useEnvelopePreviews(steps): object

Defined in: ui/client/features/envelopes/hooks/useEnvelopePreviews.ts:9

The envelope each step of the draft would receive, recomputed whenever the draft's steps change. Empty steps means nothing to preview -- no request.

Parameters#

steps

ComposeStep[]

Returns#

object

error

error: string | null

previews

previews: EnvelopePreview[]