1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
import {
forwardRef,
type ForwardRefRenderFunction,
type LabelHTMLAttributes,
type ReactNode,
} from 'react';
import styles from './label.module.scss';
export type LabelSize = 'md' | 'sm';
export type LabelProps = Omit<
LabelHTMLAttributes<HTMLLabelElement>,
'hidden' | 'size'
> & {
/**
* The label body.
*/
children: ReactNode;
/**
* Should the label be hidden?
*
* @default false
*/
isHidden?: boolean;
/**
* Is the field required?
*
* @default false
*/
isRequired?: boolean;
/**
* The label size.
*
* @default 'sm'
*/
size?: LabelSize;
};
const LabelWithRef: ForwardRefRenderFunction<HTMLLabelElement, LabelProps> = (
{
children,
className = '',
isHidden = false,
isRequired = false,
size = 'sm',
...props
},
ref
) => {
const labelClass = [
styles.label,
styles[`label--${size}`],
isHidden ? 'screen-reader-text' : '',
className,
].join(' ');
const requiredSymbol = ' *';
return (
<label {...props} className={labelClass} ref={ref}>
{children}
{isRequired ? (
<span aria-hidden className={styles.required}>
{requiredSymbol}
</span>
) : null}
</label>
);
};
/**
* Label Component
*
* Render a HTML label element.
*/
export const Label = forwardRef(LabelWithRef);
|
