aboutsummaryrefslogtreecommitdiffstats
path: root/src/components/atoms/lists/description-list/description.tsx
diff options
context:
space:
mode:
Diffstat (limited to 'src/components/atoms/lists/description-list/description.tsx')
-rw-r--r--src/components/atoms/lists/description-list/description.tsx28
1 files changed, 28 insertions, 0 deletions
diff --git a/src/components/atoms/lists/description-list/description.tsx b/src/components/atoms/lists/description-list/description.tsx
new file mode 100644
index 0000000..9fa7ecd
--- /dev/null
+++ b/src/components/atoms/lists/description-list/description.tsx
@@ -0,0 +1,28 @@
+import {
+ forwardRef,
+ type ForwardRefRenderFunction,
+ type HTMLAttributes,
+} from 'react';
+import styles from './description-list.module.scss';
+
+export type DescriptionProps = HTMLAttributes<HTMLElement>;
+
+const DescriptionWithRef: ForwardRefRenderFunction<
+ HTMLElement,
+ DescriptionProps
+> = ({ children, className = '', ...props }, ref) => {
+ const descriptionClass = `${styles.description} ${className}`;
+
+ return (
+ <dd {...props} className={descriptionClass} ref={ref}>
+ {children}
+ </dd>
+ );
+};
+
+/**
+ * Description component.
+ *
+ * Use it inside a `DescriptionList` or a `Group` component.
+ */
+export const Description = forwardRef(DescriptionWithRef);