@mui/x-data-grid-premium/components/pivotPanel/PivotPanelTrigger.d.ts

The Premium plan edition of the MUI X Data Grid Components.

import * as React from 'react';
import { type RenderProp } from '@mui/x-internals/useComponentRenderer';
import { type GridSlotProps } from '@mui/x-data-grid-pro';
export interface PivotPanelState {
  /**
   * If `true`, the pivot panel is open.
   */
  open: boolean;
  /**
   * If `true`, pivot is active.
   */
  active: boolean;
}
export type PivotPanelTriggerProps = Omit<GridSlotProps['baseButton'], 'className'> & {
  /**
   * A function to customize rendering of the component.
   */
  render?: RenderProp<GridSlotProps['baseButton'], PivotPanelState>;
  /**
   * A function to customize rendering of the component.
   */
  className?: string | ((state: PivotPanelState) => string);
};
/**
 * A button that opens and closes the pivot panel.
 * It renders the `baseButton` slot.
 *
 * Demos:
 *
 * - [Pivot Panel](https://mui.com/x/react-data-grid/components/pivot-panel/)
 *
 * API:
 *
 * - [PivotPanelTrigger API](https://mui.com/x/api/data-grid/pivot-panel-trigger/)
 */
declare const PivotPanelTrigger: React.ForwardRefExoticComponent<PivotPanelTriggerProps> | React.ForwardRefExoticComponent<Omit<PivotPanelTriggerProps, "ref"> & React.RefAttributes<HTMLButtonElement>>;
export { PivotPanelTrigger };