chrome:shell.skip

generated:catalog.entry.toggle-button.title

generated:catalog.entry.toggle-button.description

@xngui/components/toggle-button
@xngui/components/toggle-button

chrome:demo.section

chrome:demo.preview

demo-preview:hints.category.navigation:
Tab
demo-preview:hints.category.focus:
Focus
demo-preview:hints.category.shortcuts:
Space
demo-preview:hints.category.assistive:
SR
demo-preview:projection.slots-label:
[xStart] ng-content [xEnd]
import { Component } from '@angular/core';
import { XToggleButton } from '@xngui/components/toggle-button';
import { XIcon } from '@xngui/icons';
 
@Component({
selector: 'app-example',
imports: [XToggleButton, XIcon],
templateUrl: './toggle-button.component.html',
})
export class ExampleComponent {
protected onChanged(event: XChangeEvent<boolean>): void {
// handle pressed change
}
protected onClicked(event: { originalEvent: MouseEvent }): void {
// handle click
}
protected onFocused(): void {
// handle focus
}
protected onBlurred(): void {
// handle blur
}
}

chrome:demo.events.title

chrome:demo.events.empty

chrome:demo.api.title

x-toggle-button

chrome:demo.api.col.property
chrome:demo.api.col.type
chrome:demo.api.col.default
chrome:demo.api.col.description
size
XSize
—
Visual size tier — falls back to XConfigService or parent group when unset.
density
XDensity
—
Spacing offsets — orthogonal to `size`; falls back to XConfigService or group when unset.
variant
XVariant
—
Color role — falls back to parent group or XConfigService when unset.
appearance
XAppearance
—
Surface treatment — falls back to parent group or XConfigService when unset.
type
XButtonType
'button'
Native button `type` attribute.
disabled
boolean
—
Prevents interaction — cascades from parent group when unset locally.
loading
boolean
false
Shows spinner and blocks interaction — sets `aria-busy`.
ripple
boolean
—
Material-style press ripple — falls back to XConfigService when unset; off when disabled or loading.
iconOnly
boolean
false
Square icon-only layout; project the icon as default content.
ariaLabel
string
—
Accessible name — required when `iconOnly` is true.
groupValue
string
—
Value when composed inside XToggleGroup .