Skip to content
CraftDocs
GitHub
Home
Home
Changelog
What's New
Guide
Guide
Getting Started
Principles
Styling Components
Theme System
Foundations
All Tokens
Color
Elevation
Icons
Motion
Shape
Spacing
Typography
Libraries
Libraries
@xds/cli
@xds/core
Themes
Themes
Theme: daily
Default Theme
Theme: matcha
Neutral Theme
Components
Components
AppShell
AspectRatio
Avatar
Avatar
AvatarStatusDot
Badge
Banner
Breadcrumbs
BreadcrumbItem
Breadcrumbs
Button
Button
IconButton
ToggleButton
ToggleButtonGroup
Calendar
Card
Carousel
Chat
ChatComposer
ChatComposerDrawer
ChatComposerInput
ChatComposerTokenElement
ChatDictationButton
ChatLayout
ChatLayoutScrollButton
ChatMessage
ChatMessageBubble
ChatMessageList
ChatMessageMetadata
ChatSendButton
ChatSystemMessage
ChatTokenizedText
ChatToolCalls
Checkbox
CheckboxInput
CheckboxList
CheckboxListItem
ClickableCard
Code
CodeBlock
Collapsible
Collapsible
CollapsibleGroup
useXDSCollapsible
CommandPalette
CommandPalette
CommandPaletteEmpty
CommandPaletteFooter
CommandPaletteGroup
CommandPaletteInput
CommandPaletteItem
CommandPaletteList
DateInput
Dialog
AlertDialog
Dialog
DialogHeader
useXDSImperativeAlertDialog
useXDSImperativeDialog
Divider
DropdownMenu
DropdownMenu
DropdownMenuDivider
DropdownMenuItem
DropdownMenuItemData
DropdownMenuSection
EmptyState
Field
Field
FieldLabel
FieldStatus
Heading
HoverCard
Icon
Kbd
Layout
Center
FormLayout
Grid
GridSpan
HStack
Layout
LayoutContainer
LayoutContent
LayoutFooter
LayoutHeader
LayoutPanel
Section
StackItem
VStack
Link
List
List
ListItem
Markdown
MetadataList
MetadataList
MetadataListItem
MobileNav
MoreMenu
NavHeadingMenu
NavIcon
NumberInput
OverflowList
Pagination
Popover
PowerSearch
ProgressBar
Radio
RadioList
RadioListItem
Resizable
ResizeHandle
useXDSResizable
SegmentedControl
SegmentedControl
SegmentedControlItem
SelectableCard
Selector
MultiSelector
Selector
SelectorOption
SideNav
SideNav
SideNavCollapseButton
SideNavHeading
SideNavItem
SideNavSection
Skeleton
Slider
Spinner
StatusDot
Switch
Table
BaseTable
Table
TableCell
TableHeaderCell
TableRow
useXDSTableColumnSettings
useXDSTablePagination
useXDSTableSelection
useXDSTableSelectionState
useXDSTableSortable
Tabs
Tab
TabList
TabMenu
Text
TextArea
TextInput
Thumbnail
TimeInput
Timestamp
Toast
Toast
useXDSToast
Token
Tokenizer
Toolbar
Tooltip
TopNav
TopNav
TopNavHeading
TopNavItem
TopNavMegaMenu
TopNavMegaMenuFeaturedCard
TopNavMegaMenuItem
TopNavMenu
TreeList
Typeahead
BaseTypeahead
Typeahead
TypeaheadItem
useXDSHoverCard
useXDSPopover
useXDSTooltip
Utilities
Utilities
LinkProvider
MediaTheme
SyntaxTheme
Theme
useClickableContainer
useEntryAnimation
useFocusTrap
useGridFocus
useImageMode
useInputContainer
useListFocus
useMediaQuery
useOverflow
useScrollLock
useScrollOverflow
useXDSLayer
useXDSStreamingText
Terms of UsePrivacy Policy
Type to search
↑↓Navigate↵SelectEscClose
ChatDictationButton@xds/core · XDSChatDictationButton v0.0.13

Usage

ChatDictationButton is a toggle button that starts and stops voice dictation inside a chat composer. It pairs with useXDSChatDictation to show a microphone icon when idle and animated frequency bars when listening. Place it in the sendActions slot of XDSChatComposer.
ts
import {XDSChatDictationButton} from '@xds/core/Chat'

Best practices

GuidancePractices
DoPlace the dictation button in the sendActions slot of XDSChatComposer so it sits next to the send button where users expect voice input controls.
DoPass an inputRef to useXDSChatDictation so interim transcripts appear as ghost text in the composer input while the user speaks.
DoEnable hasSounds on useXDSChatDictation to give users audio feedback when dictation starts and stops — especially helpful when the button's visual change is subtle.
Don'tDon't use the dictation button outside a chat composer context — it's designed for the composer's send-action layout, not as a standalone recording control.
Don'tDon't forget to handle the unsupported case — the button hides itself by default when the browser lacks SpeechRecognition, but you should still design the composer to work without it.

Showcase source

tsx
'use client';
​
import {useRef} from 'react';
import {
XDSChatDictationButton,
XDSChatComposer,
XDSChatComposerInput,
useXDSChatDictation,
} from '@xds/core/Chat';
import type {XDSChatComposerInputHandle} from '@xds/core/Chat';
import {XDSHStack, XDSVStack} from '@xds/core/Layout';
import {XDSText} from '@xds/core/Text';
​
export default function ChatDictationButtonShowcase() {
const inputRef = useRef<XDSChatComposerInputHandle>(null);
​
const dictation = useXDSChatDictation({
inputRef,
hasSounds: true,
onResult: (text) => {
console.log('Dictation result:', text);
},
});
​
return (
<XDSVStack gap={4}>
<XDSText type="supporting" color="secondary">
Click the microphone to start dictating. Speech is transcribed into the
input.
</XDSText>
​
<XDSChatComposer
onSubmit={(v) => console.log('Submit:', v)}
input={<XDSChatComposerInput ref={inputRef} />}
sendActions={<XDSChatDictationButton dictation={dictation} />}
/>
​
{dictation.isListening && (
<XDSHStack gap={2} vAlign="center">
<XDSText type="supporting" color="secondary">
{dictation.isSpeaking ? 'Speaking detected' : 'Listening...'}
</XDSText>
<div
style={{
width: 80,
height: 6,
backgroundColor: 'var(--color-surface-secondary)',
borderRadius: 3,
overflow: 'hidden',
}}>
<div
style={{
height: '100%',
backgroundColor: dictation.isSpeaking
? 'var(--color-accent)'
: 'var(--color-text-secondary)',
borderRadius: 3,
transition: 'width 0.08s ease-out',
width: `${Math.min(dictation.volume * 200, 100)}%`,
}}
/>
</div>
</XDSHStack>
)}
​
{!dictation.isSupported && (
<XDSText type="supporting" color="active">
SpeechRecognition is not supported in this browser.
</XDSText>
)}
</XDSVStack>
);
}