diff options
Diffstat (limited to 'src/components/atoms/forms/label.tsx')
| -rw-r--r-- | src/components/atoms/forms/label.tsx | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/src/components/atoms/forms/label.tsx b/src/components/atoms/forms/label.tsx new file mode 100644 index 0000000..2ec614f --- /dev/null +++ b/src/components/atoms/forms/label.tsx @@ -0,0 +1,53 @@ +import { FC, ReactNode } from 'react'; +import styles from './label.module.scss'; + +export type LabelProps = { + /** + * An accessible name for the label. + */ + 'aria-label'?: string; + /** + * The label body. + */ + children: ReactNode; + /** + * Add classnames to the label. + */ + className?: string; + /** + * The field id. + */ + htmlFor?: string; + /** + * Is the field required? Default: false. + */ + required?: boolean; + /** + * The label size. Default: small. + */ + size?: 'medium' | 'small'; +}; + +/** + * Label Component + * + * Render a HTML label element. + */ +const Label: FC<LabelProps> = ({ + children, + className = '', + required = false, + size = 'small', + ...props +}) => { + const sizeClass = styles[`label--${size}`]; + + return ( + <label className={`${styles.label} ${sizeClass} ${className}`} {...props}> + {children} + {required && <span className={styles.required}> *</span>} + </label> + ); +}; + +export default Label; |
