Switch

The Switch is a two value control. It is like a physical toggle switch, it has an on and an off state that is represented as a boolean value.

Basic usage

The following example will render a simple switch with a label.

<Switch label="The label of the switch" />

For being more informative a description and a color can also be passed to the switch.

<!-- Label and description for more info -->
<Switch label="Front door" description="Controls the lock of the front door." checked={myFrontLock} />

<!-- Different color switches -->
<Switch color="danger" label="Sync on mobile data" />
<Switch color="info" label="Email notification" />

Value binding

Controlled component

The switch can be used as a controlled component by providing the checked and the onChange props.

const App = () => {
    const [lights, setLights] = useState(false);
    return <Switch checked={lights} onChange={(ev) => setLights(ev.target.checked)} />;
}

ReactDOM.render(
  <App />,
  document.getElementById('root')
);

Uncontrolled component

When using the switch as an uncontrolled component, a ref prop can be used to have a reference to the component. In this case, the checked property can be used to get the switch value.

const App = () => {
    const myRef = useRef(null);
    const saveChanges = () => { 
        console.log(myRef.current.checked); // the checked property will hold the value 
    };
    return <div>
        <Switch ref={myRef} label="Air Conditioner" defaultChecked={true} />
        <Button onClick={saveChanges}>Save the changes</Button>
    </div>
}

For many more examples - simple and complex use-cases - check out the switch demos for react.

Options

const handler = (ev) => { setState(ev.target.checked) }
<Switch onChange={handler} checked={state.myChecked} />

Customizing the appearance

While the provided pre-built themes are enough in many use cases, most of the times on top of adapting to a specific platform, you'd also like to match a brand or color scheme. Mobiscroll provides various ways to achieve this:

• Create custom themes using the theme builder - the custom themes can be also built using out theme builder, on a graphical user interface, without any coding, or the need for Sass support in your project.
• Create custom themes using Sass - use this, if you need multiple themes with different color variatons, in case you have pages with different colors, or you'd like to users to customize the colors of your app.
• Override the Sass color variables - the straightforward way to change the colors in one place throughout the application.

Override the Sass Color Variables

A convenient way to customize the colors of the Mobiscroll components is to override the Sass color variables.

Let's say your branding uses a nice red accent color, and you'd like that color to appear on the Mobiscroll components as well, while still using platform specific themes (e.g. ios on iOS devices, material on Android devices, and mobiscroll on desktop). You can override the accent color for every theme:

$mbsc-ios-accent: #e61d2a;
$mbsc-material-accent: #e61d2a;
$mbsc-mobiscroll-accent: #e61d2a;

@import "~@mobiscroll/React/dist/css/mobiscroll.react.scss"

You can also customize the colors on many levels:

1. Theme specific variables (ex. $mbsc-material-background, $mbsc-ios-dark-text) are applied to all components in a theme. Complete list of variables here.
2. Component specific global variables (ex. $mbsc-card-background-light, $mbsc-listview-text-dark) are applied to all themes for a specific component.
3. Component and theme specific variables (ex. $mbsc-ios-dark-form-background, $mbsc-material-input-text) are applied to a specific theme and a specific component.

Global variables of the Switch

These variables are applied to all base themes: iOS, material, windows and mobiscroll.
They all come in pairs. One for the light and one for the dark variant in each theme.

If you really want to get sophisticated or if a color doesn't look good on a specific theme and you want to overwrite it, you can fine tune all of the above variables individually for each theme. Below are the complete list of variables broken down to themes:

iOS theme

iOS Dark theme

Material theme

Material Dark theme

Windows theme

Windows Dark theme