aboutsummaryrefslogtreecommitdiffstats
path: root/src/components/atoms/lists/description-list.tsx
diff options
context:
space:
mode:
authorArmand Philippot <git@armandphilippot.com>2022-04-08 19:41:40 +0200
committerArmand Philippot <git@armandphilippot.com>2022-04-08 19:41:40 +0200
commita5df28fad0dae266a857ae110c43b3cb8b23c996 (patch)
treea32ea390e90697dc51c3ccb9018de9da2ee4fac3 /src/components/atoms/lists/description-list.tsx
parent5c75a302c2203cb3ebf31233121026b4775662cf (diff)
refactor: use a consistent classname prop and avoid children prop
I was using the FunctionComponent type for some component that do not use children. So I change the type to VoidFunctionComponent to avoid mistakes. I also rename all the "classes" or "additionalClasses" props to "className" to keep consistency between each components.
Diffstat (limited to 'src/components/atoms/lists/description-list.tsx')
-rw-r--r--src/components/atoms/lists/description-list.tsx13
1 files changed, 8 insertions, 5 deletions
diff --git a/src/components/atoms/lists/description-list.tsx b/src/components/atoms/lists/description-list.tsx
index df2880f..a5ab1d5 100644
--- a/src/components/atoms/lists/description-list.tsx
+++ b/src/components/atoms/lists/description-list.tsx
@@ -1,4 +1,4 @@
-import { FC } from 'react';
+import { VFC } from 'react';
import styles from './description-list.module.scss';
export type DescriptionListItem = {
@@ -18,9 +18,9 @@ export type DescriptionListItem = {
export type DescriptionListProps = {
/**
- * Set additional classes to the list wrapper.
+ * Set additional classnames to the list wrapper.
*/
- classes?: string;
+ className?: string;
/**
* The list items.
*/
@@ -32,7 +32,10 @@ export type DescriptionListProps = {
*
* Render a description list.
*/
-const DescriptionList: FC<DescriptionListProps> = ({ classes = '', items }) => {
+const DescriptionList: VFC<DescriptionListProps> = ({
+ className = '',
+ items,
+}) => {
/**
* Retrieve the description list items wrapped in a div element.
*
@@ -54,7 +57,7 @@ const DescriptionList: FC<DescriptionListProps> = ({ classes = '', items }) => {
});
};
- return <dl className={`${styles.list} ${classes}`}>{getItems(items)}</dl>;
+ return <dl className={`${styles.list} ${className}`}>{getItems(items)}</dl>;
};
export default DescriptionList;