@chakra-ui/core/dist/Accordion/index.d.ts

Responsive and accessible React UI components built with React and Emotion

import * as React from "react";
import { BoxProps } from "../Box";
import { PseudoBoxProps } from "../PseudoBox";
import { CollapseProps } from "../Collapse";
import { IconProps } from "../Icon";
import { Omit } from "../common-types";

interface IAccordion {
  /**
   * If `true`, multiple accordion items can be expanded at once.
   */
  allowMultiple?: boolean;
  /**
   * If `true`, any expanded accordion item can be collapsed again.
   */
  allowToggle?: boolean;
  /**
   * The index(es) of the expanded accordion item
   */
  index?: number | number[];
  /**
   * The initial index(es) of the expanded accordion item
   */
  defaultIndex?: number | number[];
  /**
   * The callback invoked when accordion items are expanded or collapsed.
   */
  onChange?: (expandedIndex?: number | number[]) => void;
  /**
   * The content of the accordion. Must be `AccordionItem`
   */
  children: React.ReactNode;
}

type AccordionProps = IAccordion & Omit<BoxProps, "onChange">;

/**
 * The accordion component delivers large amounts of content in a small space through progressive disclosure.
 *
 * By default, only one item may be expanded and it can only be collapsed again by expanding another.
 */
export const Accordion: React.FC<AccordionProps>;

/////////////////////////////////////////////////////////////

interface IAccordionItemRenderProps {
  isExpanded?: boolean;
  isDisabled?: boolean;
}

/**
 * The content of the accordion.
 * The children must be the `AccordionHeader` and `AccordionPanel` components.
 */
type AccordionItemChildren =
  | { children(props: IAccordionItemRenderProps): React.ReactNode }
  | { children: React.ReactNode };

interface IAccordionItem {
  /**
   * If `true`, expands the accordion in the controlled mode.
   */
  isOpen?: boolean;
  /**
   * If `true`, expands the accordion by on initial mount.
   */
  defaultIsOpen?: boolean;
  /**
   * If `true`, the accordion header will be disabled.
   */
  isDisabled?: boolean;
  /**
   * A unique id for the accordion item.
   */
  id?: string;
  /**
   * The callback fired when the accordion is expanded/collapsed.
   */
  onChange?: (isOpen: boolean) => void;
}

export type AccordionItemProps = IAccordionItem &
  AccordionItemChildren &
  PseudoBoxProps;

/**
 * Accordions allow users to expand and collapse sections of content.
 * It composes `Box` component.
 */
export const AccordionItem: React.FC<AccordionItemProps>;

/////////////////////////////////////////////////////////////

export type AccordionHeaderProps = PseudoBoxProps &
  React.ButtonHTMLAttributes<any>;
/**
 * AccordionHeader component composes `PseudoBox`, this means you can use
 * the `_expanded`, `_disabled`, `_hover`, etc. props to style them
 */
export const AccordionHeader: React.FC<AccordionHeaderProps>;

/////////////////////////////////////////////////////////////

/**
 * AccordionPanel component composes `Collapse` to provide the height animation
 */
export const AccordionPanel: React.FC<CollapseProps>;
export const AccordionIcon: React.FC<IconProps>;