Appearance
UI
Single public entry point for the SDK's UI surface.
Re-exports everything skill authors need to render UI from one module:
- The renderer entry (
render) and session/options types - Every block factory (PascalCase
Bubble/InputField/… and camelCasebubble/inputField/… aliases for back-compat) - Every template helper (
message,success,failure, …) - The
Ui*React component shells (UiBadge,UiBubble, …) that the renderer registers at mount time - Hooks (
useUIState,useAsyncProp, …) and the per-session state types - Block/ChildBlock types
Mapped to @matterway/sdk/UI in package.json#exports.
Example
ts
import {render, bubble, inputField, navigationBar} from '@matterway/sdk/UI';
const {data, button} = await render(ctx, bubble([
inputField({name: 'email'}),
navigationBar({buttons: [{label: 'Go', value: 'go'}]}),
]));Enumerations
Interfaces
Type Aliases
Variables
Functions
- UiAccordion
- UiAvatar
- UiCard
- UiCarousel
- UiDataTable
- UiDropdownMenu
- UiHoverCard
- UiItem
- UiItemGroup
- UiMultiSelectField
- UiNavigationMenu
- UiPagination
- UiPopover
- UiSheetModal
- UiSidebar
- UiTabs
- UiText
- UiTooltip
- useComputedItems
- useGetState
- useSetState
- resolveSessionId
- aliasSession
- unaliasSession
- getSessionStore
- getSessionInternalStore
- hasSessionStore
- acquireSession
- releaseSession
- updateFileUploadState
- Bubble
- Group
- Modal
- Shield
- Vertical
- Horizontal
- SplitView
- Text
- InputField
- SelectField
- MultiSelectField
- DateField
- CurrencyField
- PercentField
- PhoneField
- EmailField
- SegmentedField
- ToggleField
- ButtonToggleField
- CheckboxListField
- RadioListField
- BadgeField
- HeaderBar
- NavigationBar
- Badge
- Icon
- IconBox
- Image
- Link
- KeyValue
- Callout
- Highlight
- ImageViewer
- SheetViewer
- DocViewerList
- ToastNotification
- ButtonList
- Progress
- ProgressList
- StatusList
- Completion
- ThumbsFeedback
- Confirmation
- FieldComparison
- DownloadLink
- FileUpload
- DocViewer
- PdfNative
- Sheet
- Confetti
- Resolver
- Accordion
- Avatar
- Card
- Carousel
- Tabs
- Tooltip
- Pagination
- NavigationMenu
- DropdownMenu
- DataTable
- HoverCard
- Item
- Popover
- SheetModal
- Sidebar
- Conversation
- ConversationEmptyState
- Message
- MessageBody
- Response
- Suggestion
- SuggestionList
- MessageAction
- MessageActions
- PromptInput
- CodeBlock
- Snippet
- Sources
- Source
- InlineCitation
- Reasoning
- ChainOfThought
- ChainOfThoughtStep
- ToolInvocation
- Task
- TaskItem
- TaskItemFile
- Attachments
- Attachment
- TokenContext
- Artifact
- GeneratedImage
- OpenInChat
- ModelSelector
- Shimmer
- Checkpoint
- Terminal
- StackTrace
- FileTree
- EnvVarList
- Commit
- TestResults
- ApiSchema
- PackageInfo
- PlanList
- PlanItem
- Queue
- WebPreview
- Sandbox
- AgentCard
- LocalChat
- AudioPlayer
- Transcription
- MicSelector
- VoiceSelector
- SpeechInput
- setRendererHook
- render
- cleanupAll
- alert
- failure
- fileUpload
- message
- progress
- progressList
- requestUserAction
- runJobsWithProgressList