NEURALNG

BUTTON

API

The complete typed input and output contract for the standalone Button component.

API

Inputs

NameTypeDefaultDescription
type 'button' | 'submit' | 'reset' 'button' Native button type.
severity NeuralButtonSeverity 'neutral' Semantic visual intent.
disabled boolean false Disables native interaction.
loading boolean false Displays progress and blocks activation.
loadingLabel string 'Loading' Visible and accessible busy label.
ariaLabel string | null null Accessible name for icon-only actions.
ariaExpanded 'true' | 'false' | null null Disclosure state.
ariaControls string | null null Controlled surface ID.
ariaKeyShortcuts string | null null Composite-control shortcuts.
title string '' Supplementary native title.
label string | null null Visible label; projection remains the fallback.
icon string | null null Icon class string, such as nt nt-check.
iconPosition 'start' | 'end' 'start' Logical icon position around the label.
size 'small' | 'medium' | 'large' 'medium' Preset control size.
iconSize 'small' | 'medium' | 'large' | null null Icon size override; null follows the control size.
outlined boolean false Uses a transparent bordered treatment.
raised boolean false Adds elevation to any visual variant.
text boolean false Uses a borderless text treatment.
rounded boolean false Uses the pill-shaped radius token.
buttonClass string '' Classes applied to the native button.
unstyled boolean false Removes NeuralNg visual classes.
badge string | number | null null Inline or floating badge value.
badgePosition NeuralButtonBadgePosition 'end' Inline or corner position.
badgeSeverity NeuralBadgeSeverity 'neutral' Badge semantic color.
badgeSize NeuralBadgeSize 'small' Badge size.
badgeMax number | null null Maximum count before + formatting.
badgeAriaLabel string | null null Accessible badge description.
badgeClass string '' Consumer classes for the badge.

Output

clickedMouseEvent

Emitted after an allowed native click.

Composite components can also consume keyDown, pointerDown, pointerMove, pointerUp and pointerCancel without falling back to a raw button.