Await

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

Generated Component Signatures

VStack

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

HStack

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

ZStack

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

Link

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

export function 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 function Button(
		props: ButtonValue &
			ID &
			Mods & {
				children?: NativeView;
			},
	): NativeView;

Color

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

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

Text

Displays text and can contain nested Text or Image views.

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

Time

Displays an automatically updating clock or countdown.

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

ProgressView

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

Gauge

export function 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 function Image(
		props: ImageValue &
			ID &
			Mods & {
				children?: NativeView;
			},
	): NativeView;

Icon

Displays a system SF Symbol.

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

Svg

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

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

RoundedRectangle

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

export function 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 function UnevenRoundedRectangle(
		props: UnevenRoundedRectangleValue &
			ShapeValue &
			ID &
			Mods & {
				children?: never;
			},
	): NativeView;

Rectangle

Draws a rectangle that expands to fill the available space.

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

Sector

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

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

Ellipse

Draws an ellipse that expands to fill the available space.

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

Circle

Draws a circle that expands to fill the available space.

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

Polygon

Draws a polygon that expands to fill the available space.

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

Diamond

Draws a diamond that expands to fill the available space.

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

Capsule

Draws a capsule that expands to fill the available space.

export function 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 function Spacer(
		props: SpacerValue &
			ID &
			Mods & {
				children?: never;
			},
	): NativeView;

Group

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

Modifier

Creates a modifier for use in a CustomButtonStyle.

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

EmptyView

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

FullButton

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

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

Stamp

Displays a random number for debugging.

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

VFlip

Creates a vertical page-flip effect.

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

HFlip

Creates a horizontal page-flip effect.

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

XFlip

Creates a flip transition around the x-axis.

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

YFlip

Creates a flip transition around the y-axis.

export function 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 function 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 function Ticker(
		props: TickerValue &
			ID &
			Mods & {
				children: NativeView[];
			},
	): NativeView;