@mui/x-charts/BarChart/useBarChartProps.d.mts

The community edition of MUI X Charts components.

import * as React from 'react';
import { type BarChartProps, type BarSeries } from "./BarChart.mjs";
import { type ChartsContainerProps } from "../ChartsContainer/index.mjs";
import { type BarPlotProps } from "./BarPlot.mjs";
import { type ChartsGridProps } from "../ChartsGrid/index.mjs";
import { type ChartsClipPathProps } from "../ChartsClipPath/index.mjs";
import { type ChartsOverlayProps } from "../ChartsOverlay/index.mjs";
import { type ChartsAxisProps } from "../ChartsAxis/index.mjs";
import { type ChartsAxisHighlightProps } from "../ChartsAxisHighlight/index.mjs";
import { type ChartsLegendSlotExtension } from "../ChartsLegend/index.mjs";
import type { ChartsWrapperProps } from "../ChartsWrapper/index.mjs";
import { type BarChartPluginSignatures } from "./BarChart.plugins.mjs";
export interface UseBarChartPropsExtensions {}
export type UseBarChartProps = Omit<BarChartProps, 'series'> & Omit<{
  series: ReadonlyArray<BarSeries>;
}, keyof UseBarChartPropsExtensions> & UseBarChartPropsExtensions;
/**
 * A helper function that extracts BarChartProps from the input props
 * and returns an object with props for the children components of BarChart.
 *
 * @param props The input props for BarChart
 * @returns An object with props for the children components of BarChart
 */
export declare const useBarChartProps: (props: UseBarChartProps) => {
  chartsWrapperProps: Omit<ChartsWrapperProps, "children">;
  chartsContainerProps: ChartsContainerProps<"bar", BarChartPluginSignatures>;
  barPlotProps: BarPlotProps;
  gridProps: ChartsGridProps;
  clipPathProps: ChartsClipPathProps;
  clipPathGroupProps: {
    clipPath: string;
  };
  overlayProps: ChartsOverlayProps;
  chartsAxisProps: ChartsAxisProps;
  axisHighlightProps: ChartsAxisHighlightProps;
  legendProps: ChartsLegendSlotExtension;
  children: React.ReactNode;
};