Components/GuideState
Since 2.4.7BETA

GuideState

Shortcut empty-state component for onboarding scenarios, based on TxEmptyState with `variant="guide"`.

This page was migrated by AI, please review carefully

Migration is complete, but please validate against source code and manual review.

GuideState

TxGuideState is a shortcut wrapper around TxEmptyState with variant="guide" pre-set. Use it for onboarding flows, feature introductions, and first-use experiences.

Basic Usage

Uses default title and description with action buttons.

GuideState (basic)

Interactive preview paused.

Custom Content

Custom title and description, with surface="card" and size="large" for a more prominent guide.

GuideState (custom)

Interactive preview paused.

API

TxGuideState inherits all Props (except variant), Slots, and Events from TxEmptyState. See EmptyState.

Props

PropTypeDefaultDescription
titlestring'Start here'Title (overridable)
descriptionstring'Follow the steps to get started.'Description (overridable)
layout'vertical' | 'horizontal''vertical'Layout direction
align'start' | 'center' | 'end''center'Alignment
size'small' | 'medium' | 'large''medium'Size tier
surface'plain' | 'card''plain'Surface style
primaryActionEmptyStateAction-Primary action config
secondaryActionEmptyStateAction-Secondary action config

Full Props reference: EmptyState API

Interaction Contract

  • TxGuideState always forwards variant="guide" to TxEmptyState.
  • The wrapper does not rewrite title, description, surface, size, or action config; explicit props are forwarded as-is.
  • icon, title, description, and actions slots are forwarded unchanged to TxEmptyState.