| Property | Type | Description |
|---|---|---|
ariaLabel? | string | Sets the `aria-label` HTML attribute. This is label will be available to screen readers. |
blurAfterClick? | boolean | Sets the button to lose focus after being clicked. |
children? | React.ReactNode | The content rendered within the button. This includes the button text. |
disabled? | boolean | Sets the button as disabled. |
download? | string | Sets the `download` attribute on the button. If the `linkTo` prop is set, the resource will be downloaded instead of being navigated to. |
dropdown? | boolean | Indicates the button will open a dropdown. |
fullWidth? | boolean | Sets the button to stretch across the width of its container. |
icon? | SVGAsset | Displays an icon in the button. One of: AddFriend, AddReaction, AddUser, AngleDown, AngleLeft, AngleRight, AngleUp, ArrowDown, ArrowLeft, ArrowRight, ArrowUp, Automod, Ban, Bits, Camera, ChatRiskFlag, ChatSettingsBack, Check, Clip, Close, Collections, Communities, Conversations, Copy, Crate, Crown, DeadGlitch, Document, Download, DragHandle, Drops, Edit, Emoticons, Events, EventsReminderAdd, EventsReminderAdded, EventsReminderRemove, Extensions, Facebook, Featured, Filter, FollowCheck, FollowX, Friends, FriendsSC, Gear, Github, Global, GlyphArrDown, GlyphArrLeft, GlyphArrRight, GlyphArrUp, GlyphArrUpDown, GlyphFollowers, GlyphLength, GlyphLive, GlyphLiveSmall, GlyphViews, GridLayout, HGCNexus, Halt, Hash, Heart, Hide, HourGlass, Ignore, Link, Lock, LogoGlitch, LogoTwitch, LogoTwitchDevelopers, LogoTwitchPrime, LogoTwitchPrimeHorizontal, Maximize, MessagesSC, MiniPlayerExpand, MiniPlayerPause, MiniPlayerPlay, Minimize, More, Muted, NavBackpack, NavBug, NavChannels, NavCreative, NavDashboard, NavDiscover, NavFollowing, NavGames, NavLogout, NavManager, NavMessages, NavMore, NavMyChannel, NavProfile, NavSearch, NavSettings, NavVideos, Neck, NotificationBell, NotificationError, NotificationInfo, NotificationSuccess, NotificationWarning, OP, PermissionsAdd, PermissionsAdded, PermissionsRemove, Pin, Pinned, Play, Playlist, Plus, Popout, QuestionMark, Reddit, RemoveTag, RequestsSC, Roman1, Roman2, Roman3, Roman4, Roman5, RoomList, RoomListOpen, SearchNoResults, Share, Shirt, Star, Steam, Sword, Team, Theater, Timeout, Timer, ToBottom, ToTop, Trash, Trophy, Twitter, Unheart, Unignore, Unlock, Upload, VKontakte, Verified, VideoPremiere, VideoRerun, ViewerList, VolumeMax, VolumeMuted, Warning, WhisperMuted |
linkTo? | history.LocationDescriptor | Indicates the button is a link and will navigate to the passed URL. |
onClick? | React.MouseEventHandler | Event called when the button is clicked. |
overlay? | boolean | Indicates that this button overlays on a darker background. |
purchase? | string | Displays a price associated with the button action. |
size? | ButtonSize | Size of the button. One of: Default, Large, Small |
state? | ButtonState | One of: Default, Loading, Success |
statusAlertIcon? | SVGAsset | Icon to display when the status button is hovered. One of: AddFriend, AddReaction, AddUser, AngleDown, AngleLeft, AngleRight, AngleUp, ArrowDown, ArrowLeft, ArrowRight, ArrowUp, Automod, Ban, Bits, Camera, ChatRiskFlag, ChatSettingsBack, Check, Clip, Close, Collections, Communities, Conversations, Copy, Crate, Crown, DeadGlitch, Document, Download, DragHandle, Drops, Edit, Emoticons, Events, EventsReminderAdd, EventsReminderAdded, EventsReminderRemove, Extensions, Facebook, Featured, Filter, FollowCheck, FollowX, Friends, FriendsSC, Gear, Github, Global, GlyphArrDown, GlyphArrLeft, GlyphArrRight, GlyphArrUp, GlyphArrUpDown, GlyphFollowers, GlyphLength, GlyphLive, GlyphLiveSmall, GlyphViews, GridLayout, HGCNexus, Halt, Hash, Heart, Hide, HourGlass, Ignore, Link, Lock, LogoGlitch, LogoTwitch, LogoTwitchDevelopers, LogoTwitchPrime, LogoTwitchPrimeHorizontal, Maximize, MessagesSC, MiniPlayerExpand, MiniPlayerPause, MiniPlayerPlay, Minimize, More, Muted, NavBackpack, NavBug, NavChannels, NavCreative, NavDashboard, NavDiscover, NavFollowing, NavGames, NavLogout, NavManager, NavMessages, NavMore, NavMyChannel, NavProfile, NavSearch, NavSettings, NavVideos, Neck, NotificationBell, NotificationError, NotificationInfo, NotificationSuccess, NotificationWarning, OP, PermissionsAdd, PermissionsAdded, PermissionsRemove, Pin, Pinned, Play, Playlist, Plus, Popout, QuestionMark, Reddit, RemoveTag, RequestsSC, Roman1, Roman2, Roman3, Roman4, Roman5, RoomList, RoomListOpen, SearchNoResults, Share, Shirt, Star, Steam, Sword, Team, Theater, Timeout, Timer, ToBottom, ToTop, Trash, Trophy, Twitter, Unheart, Unignore, Unlock, Upload, VKontakte, Verified, VideoPremiere, VideoRerun, ViewerList, VolumeMax, VolumeMuted, Warning, WhisperMuted |
statusAlertText? | string | Text to display when the status button is hovered. Setting this property turns the button into a "status" button. |
tabIndex? | number | Manually set the `tabIndex` of this button. |
targetBlank? | boolean | If the button is a link, open it in a new tab. |
type? | ButtonType | The type of button to display. One of: Alert, Default, Hollow, Success, Text |