Skip to main content
Give us your valuable feedback

It will help us understand how we can serve you better

Give feedback

Components

Switch

Control that allows users to turn on or off item

banner-Switch
Component Status Details

Status component contains a list of checks and completeness that has been tested and owned by each component

check-list-icon We don't use color as the only visual tool to convey information.
check-list-icon The component’s structure and properties include relevant options such as variant, style, size, orientation, optional iconography, decorations, selection, error state, etc.check-list-icon The title is the component name that uses the frame base component template.check-list-icon The base component name contains: .Base & "Component Name" if there is more than one.check-list-icon All component properties use the Legion foundation.
check-list-icon We can change all the parts that are connected to the component base.check-list-icon The inside of the base component remains connected to the master component.check-list-icon All variant options are not damaged when we change from one to another.check-list-icon Overriding changes to components will not reset other variants.
check-list-icon Component's already has component specs documentation.

Status

Resources

Upcoming

Usage

Switch is component that allows the user to toggle between two states. Switch is usually used for implementing toggle based settings, where the user can change the setting parameters to either on or off.

switch react native

An example on how to implement switch component in your app:

import { Switch } from "@legion-crossplatform/ui";
const Switch = () => {
return <Switch label="Switch Label" defaultChecked={false} size="$3" />;
};
switch preview

Example With Value Toggle

The following is example usage for switch implementation with value

import { Switch } from "@legion-crossplatform/ui";
import { useState } from "react";
const [checked, setChecked] = useState(false);
const toggleCheckedChange = () => {
setChecked(!checked);
};
switch preview

Props

ParameterTypeDescriptionRequired
valueanyCurrent value of the switchNo
labelstringText label for this switchNo
onCheckedChange(checked: boolean) => voidCallback in which value should be updatedNo
checkedbooleanControl for the inputYes
disabledbooleanSet switch disabled or notNo
labeledBystringSet aria-labeled-byNo
requiredbooleanSet aria-requiredNo