@postenbring/hedwig-react
Version:
React components for [Hedwig Design System](https://github.com/bring/hedwig-design-system).
42 lines • 1.05 kB
TypeScript
import { type HTMLAttributes, type ReactNode } from "react";
export interface DescriptionListProps extends HTMLAttributes<HTMLDListElement> {
/**
* Either `dt`, `dl`, or `div` elements
*/
children?: ReactNode;
/**
* Direction of the description list
*/
variant?: "vertical" | "horizontal";
}
/**
* Uses the HTML5 `<dl>` element
*
* Pass in corresponding `<dt>` and `<dd>` elements as children
*
* ```tsx
* <DescriptionList>
* <dt>Vekt</dt>
* <dd>12 kg</dd>
* <dt>Antall kolli</dt>
* <dd>2</dd>
* </DescriptionList>
* ```
*
* Optionally wrap them in `<div>` elements as allowed by the HTML5 spec
*
* ```tsx
* <DescriptionList>
* <div>
* <dt>Vekt</dt>
* <dd>12 kg</dd>
* </div>
* <div>
* <dt>Antall kolli</dt>
* <dd>2</dd>
* </div>
* </DescriptionList>
* ```
*/
export declare const DescriptionList: import("react").ForwardRefExoticComponent<DescriptionListProps & import("react").RefAttributes<HTMLDListElement>>;
//# sourceMappingURL=description-list.d.ts.map