#
Check Box
#
CheckBox
#
Description
The CheckBox component is a UI element used for binary selection, allowing users to toggle between two states: checked and unchecked. It provides a simple, clickable interface with an associated label, making it ideal for scenarios where a user chooses one or more items or settings (e.g., "Remember me" options or multi-selection lists).
#
Usage
Instantiate a CheckBox component using the static helper method from Tesserae.UI. In the sample below, a basic CheckBox is created, with fluent methods to set text, checked state, and disabled state.
using System;
using H5;
using static H5.Core.dom;
using Tesserae;
using static Tesserae.UI;
public class CheckBoxUsageExample
{
public static void Main()
{
// Create an unchecked checkbox
var checkBox = CheckBox("Accept Terms and Conditions");
// Mark the checkbox as checked
checkBox.Checked();
// Disable the checkbox to prevent user interaction
checkBox.Disabled();
// Render the component to the DOM
var element = checkBox.Render();
document.body.appendChild(element);
}
}
#
Methods
Disabled(bool value = true)
Disables (or enables) the CheckBox component.
Parameters:
• value (bool, optional): When true, disables the component; when false, enables it.Checked(bool value = true)
Sets the checked state of the CheckBox.
Parameters:
• value (bool, optional): When true, marks the CheckBox as checked; when false, leaves it unchecked.SetText(string text)
Sets the text label for the CheckBox.
Parameters:
• text (string): The label text to be displayed alongside the CheckBox.AsObservable()
Returns an observable for the CheckBox’s state, allowing subscription to changes.
Returns:
• IObservable: Observable that emits the CheckBox's checked state whenever it changes.
#
Properties
Text
Gets or sets the label text of the CheckBox.
Type: stringIsEnabled
Gets or sets whether the CheckBox is enabled. This property inversely reflects the disabled state.
Type: boolIsChecked
Gets or sets whether the CheckBox is checked.
Type: bool
#
Samples
#
Basic Usage
The following example demonstrates creating a few CheckBox instances with different configurations: unchecked, checked, disabled, and disabled when checked.
using System;
using H5;
using static H5.Core.dom;
using Tesserae;
using static Tesserae.UI;
public class CheckBoxSampleUsage
{
public static void Main()
{
// Create a stack container for layout
var container = Stack().Children(
// Basic unchecked checkbox
CheckBox("Unchecked checkbox"),
// Checked checkbox
CheckBox("Checked checkbox").Checked(),
// Disabled checkbox
CheckBox("Disabled checkbox").Disabled(),
// Disabled checkbox that is checked
CheckBox("Disabled checked checkbox").Checked().Disabled()
);
// Render container to the document body
document.body.appendChild(container.Render());
}
}
#
See also
- Toggle
- Radio Button (for mutually exclusive selections)
See also
The Button component provides an interactive UI element that the user can click to trigger an action.
The ChoiceGroup component allows users to select a single option from a set of mutually exclusive choices, similar to a group of radio buttons.
Welcome to the official documentation for Tesserae— a modern UI toolkit designed for building rich, web-based user interfaces using C# and the
The Toggle component represents a physical switch that allows users to turn a setting on or off.