mirror of
https://github.com/scm-manager/scm-manager.git
synced 2025-11-03 12:05:52 +01:00
Fixes several accessibility issues: - Provide a style for empty table column headers - Add aria references and aria-labels - Remove aria references if the referenced element is not rendered
113 lines
3.7 KiB
TypeScript
113 lines
3.7 KiB
TypeScript
/*
|
|
* MIT License
|
|
*
|
|
* Copyright (c) 2020-present Cloudogu GmbH and Contributors
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in all
|
|
* copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
* SOFTWARE.
|
|
*/
|
|
import React, { ChangeEvent, FC, FocusEvent, useMemo } from "react";
|
|
import classNames from "classnames";
|
|
import { Help } from "../index";
|
|
import { createFormFieldWrapper, FieldProps, FieldType, isLegacy, isUsingRef } from "./FormFieldTypes";
|
|
import { createA11yId } from "../createA11yId";
|
|
|
|
type BaseProps = {
|
|
label?: string;
|
|
name?: string;
|
|
value?: string;
|
|
checked?: boolean;
|
|
disabled?: boolean;
|
|
helpText?: string;
|
|
defaultChecked?: boolean;
|
|
className?: string;
|
|
readOnly?: boolean;
|
|
ariaLabelledby?: string;
|
|
};
|
|
|
|
const InnerRadio: FC<FieldProps<BaseProps, HTMLInputElement, boolean>> = ({
|
|
name,
|
|
defaultChecked,
|
|
readOnly,
|
|
ariaLabelledby,
|
|
...props
|
|
}) => {
|
|
const id = useMemo(() => ariaLabelledby || createA11yId("radio"), [ariaLabelledby]);
|
|
const helpId = useMemo(() => createA11yId("radio"), []);
|
|
|
|
const renderHelp = () => {
|
|
const helpText = props.helpText;
|
|
if (helpText) {
|
|
return <Help message={helpText} id={helpId} />;
|
|
}
|
|
};
|
|
|
|
const handleChange = (event: ChangeEvent<HTMLInputElement>) => {
|
|
if (props.onChange) {
|
|
if (isUsingRef<BaseProps, HTMLInputElement, boolean>(props)) {
|
|
props.onChange(event);
|
|
} else if (isLegacy(props)) {
|
|
props.onChange(Boolean(event.target.checked), name);
|
|
}
|
|
}
|
|
};
|
|
|
|
const handleBlur = (event: FocusEvent<HTMLInputElement>) => {
|
|
if (props.onBlur) {
|
|
if (isUsingRef<BaseProps, HTMLInputElement, boolean>(props)) {
|
|
props.onBlur(event);
|
|
} else if (isLegacy(props)) {
|
|
props.onBlur(Boolean(event.target.checked), name);
|
|
}
|
|
}
|
|
};
|
|
|
|
const labelElement = props.label ? <span id={id}>{props.label}</span> : null;
|
|
|
|
return (
|
|
<fieldset className="is-inline-block" disabled={readOnly}>
|
|
{/*
|
|
we have to ignore the next line,
|
|
because jsx label does not the custom disabled attribute
|
|
but bulma does.
|
|
// @ts-ignore */}
|
|
<label className={classNames("radio", "mr-2", props.className)} disabled={props.disabled}>
|
|
<input
|
|
type="radio"
|
|
name={name}
|
|
value={props.value}
|
|
checked={props.checked}
|
|
onChange={handleChange}
|
|
onBlur={handleBlur}
|
|
disabled={props.disabled}
|
|
ref={props.innerRef}
|
|
defaultChecked={defaultChecked}
|
|
aria-labelledby={id}
|
|
aria-describedby={props.helpText ? helpId : undefined}
|
|
/>{" "}
|
|
{labelElement}
|
|
{renderHelp()}
|
|
</label>
|
|
</fieldset>
|
|
);
|
|
};
|
|
|
|
const Radio: FieldType<BaseProps, HTMLInputElement, boolean> = createFormFieldWrapper(InnerRadio);
|
|
|
|
export default Radio;
|