element-web/src/components/views/elements/ToggleSwitch.js

/*
Copyright 2019 New Vector Ltd
Copyright 2019 The Matrix.org Foundation C.I.C.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

import React from "react";
import PropTypes from "prop-types";
import classNames from "classnames";

import {KeyCode} from "../../../Keyboard";

// Controlled Toggle Switch element
const ToggleSwitch = ({checked, disabled=false, onChange, ...props}) => {
    const _toggle = () => {
        if (disabled) return;
        onChange(!checked);
    };

    const _onClick = (e) => {
        e.stopPropagation();
        e.preventDefault();
        _toggle();
    };

    const _onKeyDown = (e) => {
        e.stopPropagation();
        e.preventDefault();

        if (e.keyCode === KeyCode.ENTER || e.keyCode === KeyCode.SPACE) {
            _toggle();
        }
    };

    const classes = classNames({
        "mx_ToggleSwitch": true,
        "mx_ToggleSwitch_on": checked,
        "mx_ToggleSwitch_enabled": !disabled,
    });

    return (
        <div {...props}
            className={classes}
            onClick={_onClick}
            onKeyDown={_onKeyDown}
            role="checkbox"
            aria-checked={checked}
            aria-disabled={disabled}
            tabIndex={0}
        >
            <div className="mx_ToggleSwitch_ball" />
        </div>
    );
};

ToggleSwitch.propTypes = {
    // Whether or not this toggle is in the 'on' position.
    checked: PropTypes.bool.isRequired,

    // Whether or not the user can interact with the switch
    disabled: PropTypes.bool,

    // Called when the checked state changes. First argument will be the new state.
    onChange: PropTypes.func.isRequired,
};