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
101
102
103
|
import { FC, HTMLAttributes } from 'react';
import {
DescriptionListGroup,
type DescriptionListGroupProps,
} from './description-list-group';
import styles from './description-list.module.scss';
export type DescriptionListItem = {
/**
* The item id.
*/
id: string;
/**
* The list item layout.
*/
layout?: DescriptionListGroupProps['layout'];
/**
* A list label.
*/
label: DescriptionListGroupProps['label'];
/**
* An array of values for the list item.
*/
value: DescriptionListGroupProps['value'];
};
export type DescriptionListProps = Omit<
HTMLAttributes<HTMLDListElement>,
'children'
> & {
/**
* Set additional classnames to the `dt`/`dd` couple wrapper.
*/
groupClassName?: string;
/**
* The list items.
*/
items: DescriptionListItem[];
/**
* Set additional classnames to the `dt` element.
*/
labelClassName?: string;
/**
* The list layout. Default: column.
*/
layout?: 'inline' | 'column';
/**
* Set additional classnames to the `dd` element.
*/
valueClassName?: string;
/**
* If true, use a slash to delimitate multiple values.
*/
withSeparator?: DescriptionListGroupProps['withSeparator'];
};
/**
* DescriptionList component
*
* Render a description list.
*/
export const DescriptionList: FC<DescriptionListProps> = ({
className = '',
groupClassName = '',
items,
labelClassName = '',
layout = 'column',
valueClassName = '',
withSeparator,
...props
}) => {
const layoutModifier = `list--${layout}`;
const listClass = `${styles.list} ${styles[layoutModifier]} ${className}`;
/**
* Retrieve the description list items.
*
* @param {DescriptionListGroup[]} listItems - An array of items.
* @returns {JSX.Element[]} The description list items.
*/
const getItems = (listItems: DescriptionListItem[]): JSX.Element[] => {
return listItems.map(({ id, layout: itemLayout, label, value }) => {
return (
<DescriptionListGroup
key={id}
label={label}
value={value}
layout={itemLayout}
className={groupClassName}
descriptionClassName={valueClassName}
termClassName={labelClassName}
withSeparator={withSeparator}
/>
);
});
};
return (
<dl {...props} className={listClass}>
{getItems(items)}
</dl>
);
};
|
