Await

The generated section below is sourced from runtime/types/await.d.ts.

Generated Component Signatures

Scroll

This is an experimental component and may change in the future.

export const Scroll: (
		props: ID &
			Mods & {
				children?: NativeView;
			},
	) => NativeView;

VStack

export const VStack: (
		props: VStackValue &
			ID &
			Mods & {
				children?: NativeView;
			},
	) => NativeView;

HStack

export const HStack: (
		props: HStackValue &
			ID &
			Mods & {
				children?: NativeView;
			},
	) => NativeView;

Flow

export const Flow: (
		props: FlowValue &
			ID &
			Mods & {
				children?: NativeView;
			},
	) => NativeView;

ZStack

export const ZStack: (
		props: ZStackValue &
			ID &
			Mods & {
				children?: NativeView;
			},
	) => NativeView;

Link

Opens a custom-scheme URL or universal link through the Await app when tapped.

export const Link: (
		props: LinkValue &
			ID &
			Mods & {
				children?: NativeView;
			},
	) => NativeView;

Button

When tapped, runs an intent or opens a universal link directly without going through the Await app.

export const Button: (
		props: ButtonValue &
			ID &
			Mods & {
				children?: NativeView;
			},
	) => NativeView;

Color

Displays a solid color and expands to fill the available space.

export const Color: (
		props: ColorValue &
			ID &
			Mods & {
				children?: never;
			},
	) => NativeView;

Text

Displays text and can contain nested Text or Image views.

export const Text: (
		props: TextValue &
			ID &
			Mods & {
				children?: NativeView;
			},
	) => NativeView;

TextRender

Displays text in a fixed area, or as a rendered image when fontURL is set. Without lines, lays out as much text as fits in the fixed area. Supplied lines are drawn directly, including an empty array that draws no lines.

export const TextRender: (
		props: TextRenderValue &
			ID &
			Mods & {
				children?: never;
			},
	) => NativeView;

Time

Displays an automatically updating clock, countdown/count-up timer, or stopwatch.

export const Time: (
		props: TimeValue &
			ID &
			Mods & {
				children?: never;
			},
	) => NativeView;

ProgressView

export const ProgressView: (
		props: ProgressViewValue &
			ID &
			Mods & {
				children?: never;
			},
	) => NativeView;

Gauge

export const Gauge: (
		props: GaugeValue &
			ID &
			Mods & {
				children?: never;
			},
	) => NativeView;

Image

Displays an image from a local or remote path, or renders child views as an image. Avoid large or complex child content due to system limits.

export const Image: (
		props: ImageValue &
			ID &
			Mods & {
				children?: NativeView;
			},
	) => NativeView;

Icon

Displays a system SF Symbol.

export const Icon: (
		props: IconValue &
			ID &
			Mods & {
				children?: never;
			},
	) => NativeView;

Svg

Displays an SVG from a local or remote path, or from raw SVG markup.

export const Svg: (
		props: SvgValue &
			ID &
			Mods & {
				children?: never;
			},
	) => NativeView;

RoundedRectangle

Draws a rounded rectangle that expands to fill the available space.

export const RoundedRectangle: (
		props: RoundedRectangleValue &
			ShapeValue &
			ID &
			Mods & {
				children?: never;
			},
	) => NativeView;

UnevenRoundedRectangle

Draws a rounded rectangle with independently configurable corners that expands to fill the available space.

export const UnevenRoundedRectangle: (
		props: UnevenRoundedRectangleValue &
			ShapeValue &
			ID &
			Mods & {
				children?: never;
			},
	) => NativeView;

Rectangle

Draws a rectangle that expands to fill the available space.

export const Rectangle: (
		props: ShapeValue &
			ID &
			Mods & {
				children?: never;
			},
	) => NativeView;

Sector

Draws a circular sector that expands to fill the available space.

export const Sector: (
		props: SectorValue &
			ShapeValue &
			ID &
			Mods & {
				children?: never;
			},
	) => NativeView;

Ellipse

Draws an ellipse that expands to fill the available space.

export const Ellipse: (
		props: ShapeValue &
			ID &
			Mods & {
				children?: never;
			},
	) => NativeView;

Circle

Draws a circle that expands to fill the available space.

export const Circle: (
		props: ShapeValue &
			ID &
			Mods & {
				children?: never;
			},
	) => NativeView;

Polygon

Draws a polygon that expands to fill the available space.

export const Polygon: (
		props: PolygonValue &
			ShapeValue &
			ID &
			Mods & {
				children?: never;
			},
	) => NativeView;

Diamond

Draws a diamond that expands to fill the available space.

export const Diamond: (
		props: ShapeValue &
			ID &
			Mods & {
				children?: never;
			},
	) => NativeView;

Capsule

Draws a capsule that expands to fill the available space.

export const Capsule: (
		props: CapsuleValue &
			ShapeValue &
			ID &
			Mods & {
				children?: never;
			},
	) => NativeView;

Spacer

Adds flexible space within an HStack or VStack, expanding to fill the available space.

export const Spacer: (
		props: SpacerValue &
			ID &
			Mods & {
				children?: never;
			},
	) => NativeView;

Group

export const Group: (
		props: ID &
			Mods & {
				children?: NativeView;
			},
	) => NativeView;

Modifier

Creates a modifier for use in a CustomButtonStyle.

export const Modifier: (
		props: ID &
			Mods & {
				children?: never;
			},
	) => NativeView;

EmptyView

export const EmptyView: (
		props: ID &
			Mods & {
				children?: never;
			},
	) => NativeView;

FullButton

Creates a transparent button that expands to fill the available space.

export const FullButton: (
		props: ButtonValue &
			ID &
			Mods & {
				children?: never;
			},
	) => NativeView;

Stamp

Displays a random number for debugging.

export const Stamp: (
		props: ID &
			Mods & {
				children?: never;
			},
	) => NativeView;

VFlip

Creates a vertical page-flip effect.

export const VFlip: (
		props: FlipValue &
			ID &
			Mods & {
				children?: never;
			},
	) => NativeView;

HFlip

Creates a horizontal page-flip effect.

export const HFlip: (
		props: FlipValue &
			ID &
			Mods & {
				children?: never;
			},
	) => NativeView;

XFlip

Creates a flip transition around the x-axis.

export const XFlip: (
		props: AxisFlipValue &
			ID &
			Mods & {
				children?: never;
			},
	) => NativeView;

YFlip

Creates a flip transition around the y-axis.

export const YFlip: (
		props: AxisFlipValue &
			ID &
			Mods & {
				children?: never;
			},
	) => NativeView;

Gif

Creates a GIF-like animation with limited system support. Only specific durations are available, transparency is not supported directly, and frame dimensions and count should remain small.

export const Gif: (
		props: GifValue &
			ID &
			Mods & {
				children: NativeView[];
			},
	) => NativeView;

Ticker

Cycles through a sequence of views based on the selected time unit, enabling effects such as a ticking second hand. Available on iOS 26 and later.

export const Ticker: (
		props: TickerValue &
			ID &
			Mods & {
				children: NativeView[];
			},
	) => NativeView;

FlashTicker

Flashes once per second in a 60-second cycle, achieving the effect of a ticking second hand. Available on iOS 18 and later.

export const FlashTicker: (
		props: FlashTickerValue &
			ID &
			Mods & {
				children: NativeView[];
			},
	) => NativeView;