Move Settings flag to ts
This commit is contained in:
parent
b35cde4546
commit
35ecaff399
3 changed files with 89 additions and 69 deletions
|
@ -15,7 +15,6 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import React from 'react';
|
import React from 'react';
|
||||||
import PropTypes from 'prop-types';
|
|
||||||
|
|
||||||
import {Key} from '../../../Keyboard';
|
import {Key} from '../../../Keyboard';
|
||||||
|
|
||||||
|
@ -27,11 +26,20 @@ import {Key} from '../../../Keyboard';
|
||||||
* @param {Object} props react element properties
|
* @param {Object} props react element properties
|
||||||
* @returns {Object} rendered react
|
* @returns {Object} rendered react
|
||||||
*/
|
*/
|
||||||
export default function AccessibleButton(props) {
|
export default function AccessibleButton({
|
||||||
const {element, onClick, children, kind, disabled, ...restProps} = props;
|
element,
|
||||||
|
onClick,
|
||||||
|
children,
|
||||||
|
kind,
|
||||||
|
disabled,
|
||||||
|
inputRef,
|
||||||
|
className,
|
||||||
|
...restProps
|
||||||
|
}: IProps) {
|
||||||
|
|
||||||
|
const newProps: IAccessibleButtonProps = restProps;
|
||||||
if (!disabled) {
|
if (!disabled) {
|
||||||
restProps.onClick = onClick;
|
newProps.onClick = onClick,
|
||||||
// We need to consume enter onKeyDown and space onKeyUp
|
// We need to consume enter onKeyDown and space onKeyUp
|
||||||
// otherwise we are risking also activating other keyboard focusable elements
|
// otherwise we are risking also activating other keyboard focusable elements
|
||||||
// that might receive focus as a result of the AccessibleButtonClick action
|
// that might receive focus as a result of the AccessibleButtonClick action
|
||||||
|
@ -39,7 +47,7 @@ export default function AccessibleButton(props) {
|
||||||
// And divs which we report as role button to assistive technologies.
|
// And divs which we report as role button to assistive technologies.
|
||||||
// Browsers handle space and enter keypresses differently and we are only adjusting to the
|
// Browsers handle space and enter keypresses differently and we are only adjusting to the
|
||||||
// inconsistencies here
|
// inconsistencies here
|
||||||
restProps.onKeyDown = function(e) {
|
newProps.onKeyDown = (e) => {
|
||||||
if (e.key === Key.ENTER) {
|
if (e.key === Key.ENTER) {
|
||||||
e.stopPropagation();
|
e.stopPropagation();
|
||||||
e.preventDefault();
|
e.preventDefault();
|
||||||
|
@ -49,8 +57,8 @@ export default function AccessibleButton(props) {
|
||||||
e.stopPropagation();
|
e.stopPropagation();
|
||||||
e.preventDefault();
|
e.preventDefault();
|
||||||
}
|
}
|
||||||
};
|
},
|
||||||
restProps.onKeyUp = function(e) {
|
newProps.onKeyUp = (e) => {
|
||||||
if (e.key === Key.SPACE) {
|
if (e.key === Key.SPACE) {
|
||||||
e.stopPropagation();
|
e.stopPropagation();
|
||||||
e.preventDefault();
|
e.preventDefault();
|
||||||
|
@ -60,26 +68,26 @@ export default function AccessibleButton(props) {
|
||||||
e.stopPropagation();
|
e.stopPropagation();
|
||||||
e.preventDefault();
|
e.preventDefault();
|
||||||
}
|
}
|
||||||
};
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Pass through the ref - used for keyboard shortcut access to some buttons
|
// Pass through the ref - used for keyboard shortcut access to some buttons
|
||||||
restProps.ref = restProps.inputRef;
|
newProps.ref = inputRef;
|
||||||
delete restProps.inputRef;
|
|
||||||
|
|
||||||
restProps.className = (restProps.className ? restProps.className + " " : "") + "mx_AccessibleButton";
|
newProps.className = (className ? className + " " : "") + "mx_AccessibleButton";
|
||||||
|
|
||||||
if (kind) {
|
if (kind) {
|
||||||
// We apply a hasKind class to maintain backwards compatibility with
|
// We apply a hasKind class to maintain backwards compatibility with
|
||||||
// buttons which might not know about kind and break
|
// buttons which might not know about kind and break
|
||||||
restProps.className += " mx_AccessibleButton_hasKind mx_AccessibleButton_kind_" + kind;
|
newProps.className += " mx_AccessibleButton_hasKind mx_AccessibleButton_kind_" + kind;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (disabled) {
|
if (disabled) {
|
||||||
restProps.className += " mx_AccessibleButton_disabled";
|
newProps.className += " mx_AccessibleButton_disabled";
|
||||||
restProps["aria-disabled"] = true;
|
newProps["aria-disabled"] = true;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// React.createElement expects InputHTMLAttributes
|
||||||
return React.createElement(element, restProps, children);
|
return React.createElement(element, restProps, children);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -89,28 +97,25 @@ export default function AccessibleButton(props) {
|
||||||
* onClick: (required) Event handler for button activation. Should be
|
* onClick: (required) Event handler for button activation. Should be
|
||||||
* implemented exactly like a normal onClick handler.
|
* implemented exactly like a normal onClick handler.
|
||||||
*/
|
*/
|
||||||
AccessibleButton.propTypes = {
|
interface IProps extends React.InputHTMLAttributes<HTMLElement> {
|
||||||
children: PropTypes.node,
|
inputRef?: React.Ref<HTMLElement>,
|
||||||
inputRef: PropTypes.oneOfType([
|
element?: string;
|
||||||
// Either a function
|
|
||||||
PropTypes.func,
|
|
||||||
// Or the instance of a DOM native element
|
|
||||||
PropTypes.shape({ current: PropTypes.instanceOf(Element) }),
|
|
||||||
]),
|
|
||||||
element: PropTypes.string,
|
|
||||||
onClick: PropTypes.func.isRequired,
|
|
||||||
|
|
||||||
// The kind of button, similar to how Bootstrap works.
|
// The kind of button, similar to how Bootstrap works.
|
||||||
// See available classes for AccessibleButton for options.
|
// See available classes for AccessibleButton for options.
|
||||||
kind: PropTypes.string,
|
kind?: string,
|
||||||
// The ARIA role
|
// The ARIA role
|
||||||
role: PropTypes.string,
|
role?: string,
|
||||||
// The tabIndex
|
// The tabIndex
|
||||||
tabIndex: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
|
tabIndex?: number,
|
||||||
|
disabled?: boolean,
|
||||||
disabled: PropTypes.bool,
|
className?: string,
|
||||||
|
onClick(e?: React.MouseEvent<HTMLElement> | React.KeyboardEvent<HTMLElement>): void;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
interface IAccessibleButtonProps extends React.InputHTMLAttributes<HTMLElement> {
|
||||||
|
ref?: React.Ref<HTMLElement>,
|
||||||
|
}
|
||||||
|
|
||||||
AccessibleButton.defaultProps = {
|
AccessibleButton.defaultProps = {
|
||||||
element: 'div',
|
element: 'div',
|
||||||
role: 'button',
|
role: 'button',
|
|
@ -21,58 +21,76 @@ import createReactClass from 'create-react-class';
|
||||||
import SettingsStore from "../../../settings/SettingsStore";
|
import SettingsStore from "../../../settings/SettingsStore";
|
||||||
import { _t } from '../../../languageHandler';
|
import { _t } from '../../../languageHandler';
|
||||||
import ToggleSwitch from "./ToggleSwitch";
|
import ToggleSwitch from "./ToggleSwitch";
|
||||||
|
import StyledCheckbox from "./StyledCheckbox";
|
||||||
|
|
||||||
export default createReactClass({
|
interface IProps {
|
||||||
displayName: 'SettingsFlag',
|
name: string,
|
||||||
propTypes: {
|
level: string,
|
||||||
name: PropTypes.string.isRequired,
|
roomId?: string, // for per-room settings
|
||||||
level: PropTypes.string.isRequired,
|
label?: string, // untranslated
|
||||||
roomId: PropTypes.string, // for per-room settings
|
isExplicit: boolean,
|
||||||
label: PropTypes.string, // untranslated
|
// XXX: once design replaces all toggles make this the default
|
||||||
onChange: PropTypes.func,
|
useCheckbox?: boolean,
|
||||||
isExplicit: PropTypes.bool,
|
onChange(checked: boolean): void,
|
||||||
},
|
}
|
||||||
|
|
||||||
getInitialState: function() {
|
interface IState {
|
||||||
return {
|
// XXX: make this generic when the settings store is typed
|
||||||
|
value: any;
|
||||||
|
}
|
||||||
|
|
||||||
|
export default class SettingsFlag extends React.Component<IProps, IState> {
|
||||||
|
|
||||||
|
constructor(props: IProps) {
|
||||||
|
super(props);
|
||||||
|
|
||||||
|
this.state = {
|
||||||
value: SettingsStore.getValueAt(
|
value: SettingsStore.getValueAt(
|
||||||
this.props.level,
|
this.props.level,
|
||||||
this.props.name,
|
this.props.name,
|
||||||
this.props.roomId,
|
this.props.roomId,
|
||||||
this.props.isExplicit,
|
this.props.isExplicit,
|
||||||
),
|
),
|
||||||
};
|
}
|
||||||
},
|
}
|
||||||
|
|
||||||
onChange: function(checked) {
|
|
||||||
if (this.props.group && !checked) return;
|
|
||||||
|
|
||||||
|
private onChange = (checked: boolean): void => {
|
||||||
this.save(checked);
|
this.save(checked);
|
||||||
this.setState({ value: checked });
|
this.setState({ value: checked });
|
||||||
if (this.props.onChange) this.props.onChange(checked);
|
if (this.props.onChange) this.props.onChange(checked);
|
||||||
},
|
}
|
||||||
|
|
||||||
save: function(val = undefined) {
|
private checkBoxOnChange = (e: React.ChangeEvent<HTMLInputElement>) => {
|
||||||
|
this.onChange(e.target.checked);
|
||||||
|
}
|
||||||
|
|
||||||
|
private save = (val?: any): void => {
|
||||||
return SettingsStore.setValue(
|
return SettingsStore.setValue(
|
||||||
this.props.name,
|
this.props.name,
|
||||||
this.props.roomId,
|
this.props.roomId,
|
||||||
this.props.level,
|
this.props.level,
|
||||||
val !== undefined ? val : this.state.value,
|
val !== undefined ? val : this.state.value,
|
||||||
);
|
);
|
||||||
},
|
}
|
||||||
|
|
||||||
render: function() {
|
public render() {
|
||||||
const canChange = SettingsStore.canSetValue(this.props.name, this.props.roomId, this.props.level);
|
const canChange = SettingsStore.canSetValue(this.props.name, this.props.roomId, this.props.level);
|
||||||
|
|
||||||
let label = this.props.label;
|
let label = this.props.label;
|
||||||
if (!label) label = SettingsStore.getDisplayName(this.props.name, this.props.level);
|
if (!label) label = SettingsStore.getDisplayName(this.props.name, this.props.level);
|
||||||
else label = _t(label);
|
else label = _t(label);
|
||||||
|
|
||||||
return (
|
if (this.props.useCheckbox) {
|
||||||
<div className="mx_SettingsFlag">
|
return <StyledCheckbox checked={this.state.value} onChange={this.checkBoxOnChange} disabled={!canChange} >
|
||||||
<span className="mx_SettingsFlag_label">{label}</span>
|
{label}
|
||||||
<ToggleSwitch checked={this.state.value} onChange={this.onChange} disabled={!canChange} aria-label={label} />
|
</StyledCheckbox>;
|
||||||
</div>
|
} else {
|
||||||
);
|
return (
|
||||||
},
|
<div className="mx_SettingsFlag">
|
||||||
});
|
<span className="mx_SettingsFlag_label">{label}</span>
|
||||||
|
<ToggleSwitch checked={this.state.value} onChange={this.onChange} disabled={!canChange} aria-label={label} />
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
|
@ -15,14 +15,13 @@ See the License for the specific language governing permissions and
|
||||||
limitations under the License.
|
limitations under the License.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import React from "react";
|
import React, { EventHandler } from "react";
|
||||||
import PropTypes from "prop-types";
|
|
||||||
import classNames from "classnames";
|
import classNames from "classnames";
|
||||||
import * as sdk from "../../../index";
|
import * as sdk from "../../../index";
|
||||||
|
|
||||||
// Controlled Toggle Switch element, written with Accessibility in mind
|
// Controlled Toggle Switch element, written with Accessibility in mind
|
||||||
const ToggleSwitch = ({checked, disabled=false, onChange, ...props}) => {
|
export default ({checked, disabled=false, onChange, ...props}: IProps) => {
|
||||||
const _onClick = (e) => {
|
const _onClick = () => {
|
||||||
if (disabled) return;
|
if (disabled) return;
|
||||||
onChange(!checked);
|
onChange(!checked);
|
||||||
};
|
};
|
||||||
|
@ -47,15 +46,13 @@ const ToggleSwitch = ({checked, disabled=false, onChange, ...props}) => {
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
ToggleSwitch.propTypes = {
|
interface IProps {
|
||||||
// Whether or not this toggle is in the 'on' position.
|
// Whether or not this toggle is in the 'on' position.
|
||||||
checked: PropTypes.bool.isRequired,
|
checked: boolean,
|
||||||
|
|
||||||
// Whether or not the user can interact with the switch
|
// Whether or not the user can interact with the switch
|
||||||
disabled: PropTypes.bool,
|
disabled: boolean,
|
||||||
|
|
||||||
// Called when the checked state changes. First argument will be the new state.
|
// Called when the checked state changes. First argument will be the new state.
|
||||||
onChange: PropTypes.func.isRequired,
|
onChange(checked: boolean): void,
|
||||||
};
|
};
|
||||||
|
|
||||||
export default ToggleSwitch;
|
|
Loading…
Reference in a new issue