491f0cd08a
* Copyright headers 1 * Licence headers 2 * Copyright Headers 3 * Copyright Headers 4 * Copyright Headers 5 * Copyright Headers 6 * Copyright headers 7 * Add copyright headers for html and config file * Replace license files and update package.json * Update with CLA * lint
42 lines
1.4 KiB
TypeScript
42 lines
1.4 KiB
TypeScript
/*
|
|
Copyright 2024 New Vector Ltd.
|
|
Copyright 2022 The Matrix.org Foundation C.I.C.
|
|
|
|
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only
|
|
Please see LICENSE files in the repository root for full details.
|
|
*/
|
|
|
|
import React from "react";
|
|
import classnames from "classnames";
|
|
|
|
import StyledCheckbox from "./StyledCheckbox";
|
|
|
|
interface IProps {
|
|
// The value for the checkbox
|
|
value: boolean;
|
|
// The translated label for the checkbox
|
|
label: string;
|
|
// Optional translated string to show below the checkbox
|
|
byline?: string;
|
|
// Whether or not to disable the checkbox
|
|
disabled?: boolean;
|
|
// The function to call when the value changes
|
|
onChange(checked: boolean): void;
|
|
// Optional additional CSS class to apply to the label
|
|
className?: string;
|
|
}
|
|
|
|
const LabelledCheckbox: React.FC<IProps> = ({ value, label, byline, disabled, onChange, className }) => {
|
|
return (
|
|
<label className={classnames("mx_LabelledCheckbox", className)}>
|
|
<StyledCheckbox disabled={disabled} checked={value} onChange={(e) => onChange(e.target.checked)} />
|
|
<div className="mx_LabelledCheckbox_labels">
|
|
<span className="mx_LabelledCheckbox_label">{label}</span>
|
|
{byline ? <span className="mx_LabelledCheckbox_byline">{byline}</span> : null}
|
|
</div>
|
|
</label>
|
|
);
|
|
};
|
|
|
|
export default LabelledCheckbox;
|