blob: 0a9246515653fe9bd99459332658b2f90510df77 (
plain)
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
import { VFC } from 'react';
import styles from './description-list.module.scss';
export type DescriptionListItem = {
/**
* The item id.
*/
id: string;
/**
* A list term.
*/
term: string;
/**
* An array of values for the list term.
*/
value: any[];
};
export type DescriptionListProps = {
/**
* Set additional classnames to the list wrapper.
*/
className?: string;
/**
* Set additional classnames to the `dd` element.
*/
descriptionClassName?: string;
/**
* Set additional classnames to the `dt`/`dd` couple wrapper.
*/
groupClassName?: string;
/**
* The list items.
*/
items: DescriptionListItem[];
/**
* The list items layout. Default: column.
*/
layout?: 'inline' | 'column';
/**
* Define if the layout should automatically create rows/columns.
*/
responsiveLayout?: boolean;
/**
* Set additional classnames to the `dt` element.
*/
termClassName?: string;
};
/**
* DescriptionList component
*
* Render a description list.
*/
const DescriptionList: VFC<DescriptionListProps> = ({
className = '',
descriptionClassName = '',
groupClassName = '',
items,
layout = 'column',
responsiveLayout = false,
termClassName = '',
}) => {
const layoutModifier = `list--${layout}`;
const responsiveModifier = responsiveLayout ? 'list--responsive' : '';
/**
* Retrieve the description list items wrapped in a div element.
*
* @param {DescriptionListItem[]} listItems - An array of term and description couples.
* @returns {JSX.Element[]} The description list items.
*/
const getItems = (listItems: DescriptionListItem[]): JSX.Element[] => {
return listItems.map(({ id, term, value }) => {
return (
<div key={id} className={`${styles.list__item} ${groupClassName}`}>
<dt className={`${styles.list__term} ${termClassName}`}>{term}</dt>
{value.map((currentValue, index) => (
<dd
key={`${id}-${index}`}
className={`${styles.list__description} ${descriptionClassName}`}
>
{currentValue}
</dd>
))}
</div>
);
});
};
return (
<dl
className={`${styles.list} ${styles[layoutModifier]} ${styles[responsiveModifier]} ${className}`}
>
{getItems(items)}
</dl>
);
};
export default DescriptionList;
|
