Checkbox

The Checkbox component is a UI element designed for binary selections. It consists of a small box that can be checked (selected) or unchecked (deselected) by the user.

info

The Checkbox component contains an embedded Checkbox Input and a Label element. This is of great importance as configuring the Checkbox component may require adjusting properties within the embedded elements. This applies to the visual style, triggers, and actions as they may differ.

Use Cases

The Checkbox component serve various purposes in user interfaces, including:

• Feature Control: Enable/disable features.

• Preference Indication: Reflect user preferences.

• Agree/Disagree Choices: Obtain user consent.

Properties Customization

Checkbox Component

Enhance the Checkbox component to align with your application's requirements using the following customization options:

• Label Position: Developers can tailor the label's position, placing it above, below, to the left, to the right, or even hidden.

• Variant Selection: Choose the variant that aligns with your design:

  • Checkbox Variant: Select this for the standard checkbox style.
  
  
  • Switch Variant: Choose this for a switch-like appearance.

  

• Size: Choose from small, medium, or large sizes for the Checkbox component.

Embedded Label

Within the Checkbox component, an embedded Label allows for further customization of the following properties:

• Label: Personalize the label to offer clear instructions or guidance.

Data Integration

The Checkbox component allows for seamless integration of Qodly Sources, enabling dynamic data binding and interaction within the Page.

info

The qodlysource for the Checkbox component should be binary, with values limited to true or false.

Data Binding

To associate data with the Checkbox component, follow these steps:

1. Navigate to the Properties Panel: Access the Data Access category located within the Properties panel for the Checkbox component.

2. Define the Qodly Source: Specify the relevant qodlysource that will capture the user's selected choice.

tip

Alternatively, you can establish the connection by dragging and dropping the qodlysource onto the Checkbox component.

Server-Side Interaction

Interacting with user input data is straightforward. When you bind a qodlysource to the Checkbox component, you can access and make use of the input content.

Subsequently, you can utilize this input value in various ways, such as within a standard action to initiate a search with matching attribute values.

Customizing Checkbox Styles

The Checkbox component offers additional customization options through CSS, providing control over the appearance of checkbox elements.

Understanding Checkbox CSS Classes

The Checkbox component supports various CSS classes that enable customization of the checkbox container, label, outline, and checkmark area. Below is a list of the supported CSS classes and their corresponding elements.

Class Name	Applies To	Description
.chakra-checkbox	The outline of the checkbox component	Applies styles to the outline of the checkbox component.
.chakra-checkbox__control	The embedded checkmark area	Customizes the chechmark area within the checkbox element.

Custom styling examples

The following examples demonstrate how to customize the appearance of the Checkbox component.

Example 1 - Rounded Silver Outline

This example customizes the outline of the checkbox component by using a rounded border in silver and a background color in white for contrast.

self {
	padding: 10px;
	width: 150px;
	box-shadow: 4px 4px 10px rgba(215, 218, 225, 0.9), 4px 4px 10px rgba(221, 221, 232, 0.9), 4px 4px 10px rgba(240, 240, 244, 0.9), 4px 4px 10px rgba(227, 227, 234, 0.9);
	font-family: 'Times New Roman', Times, serif;	
	border-radius: 10px;
}
self .chakra-checkbox{
	background-color:white;
	margin-left: 60px;
	border-radius: 20px;
	border-color:silver;
	border-width: 3px;
}

Example 2 - Shadowed Checkmark Area

In this example, the checkmark area is styled by setting the background color to white, adding rounded corners, and applying a silver border to highlight changes. A shadow is also added for depth.

self {
	padding: 10px;
	width: 150px;
	box-shadow: 4px 4px 10px rgba(215, 218, 225, 0.9), 4px 4px 10px rgba(221, 221, 232, 0.9), 4px 4px 10px rgba(240, 240, 244, 0.9), 4px 4px 10px rgba(227, 227, 234, 0.9);
	font-family: 'Times New Roman', Times, serif;	
	border-radius: 10px;
}
self .chakra-checkbox__control{
	background-color:white;
	box-shadow: 4px 4px 10px rgba(215, 218, 225, 0.9), 4px 4px 10px rgba(221, 221, 232, 0.9), 4px 4px 10px rgba(240, 240, 244, 0.9), 4px 4px 10px rgba(227, 227, 234, 0.9);
	border-radius: 10px;
	border-color: silver;
	margin-left: 70px;
}

Example 3 - Grey Hovered Embedded Checkmark Area

In this example, the checkmark area is styled with a grey background, rounded corners, and a shadow is added for depth.

self {
	padding: 10px;
	width: 150px;
	box-shadow: 4px 4px 10px rgba(215, 218, 225, 0.9), 4px 4px 10px rgba(221, 221, 232, 0.9), 4px 4px 10px rgba(240, 240, 244, 0.9), 4px 4px 10px rgba(227, 227, 234, 0.9);
	font-family: 'Times New Roman', Times, serif;	
	border-radius: 10px;
}
self .chakra-checkbox__control:hover{
	background-color:grey;
	box-shadow: 4px 4px 10px rgba(215, 218, 225, 0.9), 4px 4px 10px rgba(221, 221, 232, 0.9), 4px 4px 10px rgba(240, 240, 244, 0.9), 4px 4px 10px rgba(227, 227, 234, 0.9);
	border-radius: 10px;
}

Example 4 - Dark-blue Checked Embedded Checkmark

In this example, the embedded checked checkmark area is styled with a dark blue background, rounded corners, and a white text color for contrast.

self {
	padding: 10px;
	width: 150px;
	box-shadow: 4px 4px 10px rgba(215, 218, 225, 0.9), 4px 4px 10px rgba(221, 221, 232, 0.9), 4px 4px 10px rgba(240, 240, 244, 0.9), 4px 4px 10px rgba(227, 227, 234, 0.9);
	font-family: 'Times New Roman', Times, serif;	
	border-radius: 10px;
}
self .chakra-checkbox__control[data-checked]{
	color:white;
	background-color:rgb(63, 17, 103);
	margin: 5px 5px 5px 5px;
	border-radius: 10px;
}

Triggers and Events

Checkbox Component

The Checkbox component can respond to various events, enabling dynamic user experiences. Events that can trigger actions within the component include:

Event	Description
On Click	Calls for an action when the user clicks on the component.
On Blur	Calls for an action when the component loses focus (user clicks outside).
On Focus	Calls for an action when the component gains focus (user clicks on it).
On MouseEnter	Calls for an action when the user's mouse cursor enters the area of the component.
On MouseLeave	Calls for an action when the user's mouse cursor exits the area of the component.

Embedded Label

The embedded Label can also respond to various events, allowing for dynamic user experiences. Events that can trigger actions within the embedded icon include:

Event	Description
On Click	Calls for an action when the user clicks on the Label.
On Keyup	Calls for an action when a keyboard key is released while the Label is in focus
On KeyDown	Calls for an action when a keyboard key is pressed down while the Label is in focus.
On MouseEnter	Calls for an action when the user's mouse cursor enters the area of the Label.
On MouseLeave	Calls for an action when the user's mouse cursor exits the area of the Label.