Import
import { Checkbox } from '@strongtie/design-system/checkbox';
Usage
<Checkbox name="checkbox" />
Props
The controlled checked state of the checkbox
When true, prevents the user from interacting with the checkbox
When true, indicates that the user must check the checkbox before the form can be submitted
The name of the checkbox. Submitted with its form data
The value of the checkbox. Submitted with its form data
The default checked state of the checkbox
Event handler called when the checked state changes
Styling Classes
The following CSS classes are applied by the Checkbox component:
checkbox – Base checkbox class
checkbox-indicator – Checkbox indicator wrapper
checkbox-icon – Checkbox icon (check or indeterminate)
For more examples, visit the Storybook. <StudsCheckBox Name="checkbox" TValue="bool?" Value="false" />
Parameters
InputAttributes
IReadOnlyDictionary<string, Object>
Specifies additional custom attributes that will be rendered by the input.
Gets or sets a value indicating whether is tri-state (true, false or null).
Gets or sets a value indicating whether is read only.
Gets or sets the name of the checkbox. Submitted with its form data.
Gets or sets the tab index of the checkbox.
Gets or sets the placeholder.
Gets or sets a value indicating whether this “T:Studs.FormComponent`1” is disabled.
Gets or sets the value changed.
Gets or sets the value of the checkbox. Submitted with its form data.
Gets or sets the change event.
Gets or sets the value expression.
Attributes
Dictionary<string, object>
Specifies additional custom attributes that will be rendered by the component.
MouseEnter
EventCallback<ElementReference>
Gets or sets the callback that is invoked when the mouse enters an item.
MouseLeave
EventCallback<ElementReference>
Gets or sets the callback that is invoked when the mouse leaves an item.
A callback that will be invoked when the user right-clicks the component. Commonly used to display a context menu.
Culture
CultureInfo
default:"CultureInfo.CurrentCulture"
Gets or sets the culture used to display localizable data (numbers, dates). Set by default to “CultureInfo.CurrentCulture”.
Gets or sets the inline CSS style.
Gets or sets a value indicating whether this “T:Studs.StudsComponent” is visible. Invisible components are not rendered.
Styling Classes
The following CSS classes are applied by the Checkbox component:
checkbox – Base checkbox wrapper class
-wrapper – Wrapper modifier (applied to root checkbox element)
-box – Checkbox visual box element
-active – Active state modifier (applied when checked or indeterminate)
-disabled – Disabled state modifier (applied when disabled)
For more examples, visit the Storybook.