aboutsummaryrefslogtreecommitdiffstats
path: root/src/components/molecules/buttons/help-button/help-button.tsx
diff options
context:
space:
mode:
authorArmand Philippot <git@armandphilippot.com>2023-10-04 15:06:29 +0200
committerArmand Philippot <git@armandphilippot.com>2023-11-11 18:14:41 +0100
commite97325a2c174a87c29593d1b42b9a1cc1eaf11af (patch)
tree8bc2f9bd386512350ef596729dae1a9b14b7f3fd /src/components/molecules/buttons/help-button/help-button.tsx
parent9eeb49155e2e74df4d5cb2833da20669b85fafe5 (diff)
refactor(components): rewrite HelpButton component
Diffstat (limited to 'src/components/molecules/buttons/help-button/help-button.tsx')
-rw-r--r--src/components/molecules/buttons/help-button/help-button.tsx42
1 files changed, 42 insertions, 0 deletions
diff --git a/src/components/molecules/buttons/help-button/help-button.tsx b/src/components/molecules/buttons/help-button/help-button.tsx
new file mode 100644
index 0000000..1951b4d
--- /dev/null
+++ b/src/components/molecules/buttons/help-button/help-button.tsx
@@ -0,0 +1,42 @@
+import { forwardRef, type ForwardRefRenderFunction } from 'react';
+import { Button, VisuallyHidden, type ButtonProps, Icon } from '../../../atoms';
+import styles from './help-button.module.scss';
+
+export type HelpButtonProps = Omit<
+ ButtonProps,
+ 'aria-label' | 'children' | 'kind' | 'shape'
+> & {
+ /**
+ * Define an accessible name for the button.
+ */
+ label: string;
+};
+
+const HelpButtonWithRef: ForwardRefRenderFunction<
+ HTMLButtonElement,
+ HelpButtonProps
+> = ({ className = '', isPressed = false, label, ...props }, ref) => {
+ const btnClass = `${styles.btn} ${className}`;
+
+ return (
+ <Button
+ {...props}
+ className={btnClass}
+ isPressed={isPressed}
+ ref={ref}
+ // eslint-disable-next-line react/jsx-no-literals -- Shape allowed
+ shape="circle"
+ >
+ {/* eslint-disable-next-line react/jsx-no-literals -- Config allowed */}
+ <Icon aria-hidden className={styles.icon} shape="help" size="sm" />
+ <VisuallyHidden>{label}</VisuallyHidden>
+ </Button>
+ );
+};
+
+/**
+ * HelpButton component
+ *
+ * Render a button with an interrogation mark icon.
+ */
+export const HelpButton = forwardRef(HelpButtonWithRef);