@navikt/ds-react
Version:
React components from the Norwegian Labour and Welfare Administration.
66 lines (65 loc) • 2.15 kB
TypeScript
import React from "react";
import { AccordionContentProps } from "./AccordionContent.js";
import { AccordionHeaderProps } from "./AccordionHeader.js";
import { AccordionItemProps } from "./AccordionItem.js";
interface AccordionComponent extends React.ForwardRefExoticComponent<AccordionProps & React.RefAttributes<HTMLDivElement>> {
/**
* @see 🏷️ {@link AccordionItemProps}
*/
Item: React.ForwardRefExoticComponent<AccordionItemProps & React.RefAttributes<HTMLDivElement>>;
/**
* @see 🏷️ {@link AccordionHeaderProps}
*/
Header: React.ForwardRefExoticComponent<AccordionHeaderProps & React.RefAttributes<HTMLButtonElement>>;
/**
* @see 🏷️ {@link AccordionContentProps}
*/
Content: React.ForwardRefExoticComponent<AccordionContentProps & React.RefAttributes<HTMLDivElement>>;
}
export interface AccordionProps extends React.HTMLAttributes<HTMLDivElement> {
/**
* @deprecated "default" will be the only variant.
* @default "default"
*/
variant?: "default" | "neutral";
/**
* @default "small"
* @deprecated `size`-prop will be the only prop to control the size of the accordion.
*/
headingSize?: "large" | "medium" | "small" | "xsmall";
/**
* @default "medium"
*/
size?: "large" | "medium" | "small";
/**
* Whether to indent content or not.
* @default true
*/
indent?: boolean;
/**
* Instances of `Accordion.Item`.
*/
children: React.ReactNode;
}
/**
* A component that displays collapsible content sections.
*
* @see [📝 Documentation](https://aksel.nav.no/komponenter/core/accordion)
* @see 🏷️ {@link AccordionProps}
*
* @example
* ```jsx
* <Accordion>
* <Accordion.Item>
* <Accordion.Header>Section 1</Accordion.Header>
* <Accordion.Content>Content 1</Accordion.Content>
* </Accordion.Item>
* <Accordion.Item>
* <Accordion.Header>Section 2</Accordion.Header>
* <Accordion.Content>Content 2</Accordion.Content>
* </Accordion.Item>
* </Accordion>
* ```
*/
export declare const Accordion: AccordionComponent;
export default Accordion;