@mui/x-charts 6.18.1 → 7.0.0-alpha.0

package/modern/ChartsLegend/ChartsLegend.js

@@ -3,6 +3,7 @@ import _extends from "@babel/runtime/helpers/esm/extends";
 const _excluded = ["rotate", "dominantBaseline"],
   _excluded2 = ["label"];
 import * as React from 'react';
+import PropTypes from 'prop-types';
 import { useSlotProps } from '@mui/base/utils';
 import { NoSsr } from '@mui/base/NoSsr';
 import { unstable_composeClasses as composeClasses } from '@mui/utils';
@@ -233,7 +234,107 @@ function DefaultChartsLegend(props) {
     })
   });
 }
-export function ChartsLegend(inProps) {
+process.env.NODE_ENV !== "production" ? DefaultChartsLegend.propTypes = {
+  // ----------------------------- Warning --------------------------------
+  // | These PropTypes are generated from the TypeScript type definitions |
+  // | To update them edit the TypeScript types and run "yarn proptypes"  |
+  // ----------------------------------------------------------------------
+  /**
+   * Override or extend the styles applied to the component.
+   */
+  classes: PropTypes.object.isRequired,
+  /**
+   * The direction of the legend layout.
+   * The default depends on the chart.
+   */
+  direction: PropTypes.oneOf(['column', 'row']).isRequired,
+  drawingArea: PropTypes.shape({
+    bottom: PropTypes.number.isRequired,
+    height: PropTypes.number.isRequired,
+    left: PropTypes.number.isRequired,
+    right: PropTypes.number.isRequired,
+    top: PropTypes.number.isRequired,
+    width: PropTypes.number.isRequired
+  }).isRequired,
+  /**
+   * Set to true to hide the legend.
+   */
+  hidden: PropTypes.bool,
+  /**
+   * Space between two legend items (in px).
+   * @default 10
+   */
+  itemGap: PropTypes.number,
+  /**
+   * Height of the item mark (in px).
+   * @default 20
+   */
+  itemMarkHeight: PropTypes.number,
+  /**
+   * Width of the item mark (in px).
+   * @default 20
+   */
+  itemMarkWidth: PropTypes.number,
+  /**
+   * Style applied to legend labels.
+   * @default theme.typography.subtitle1
+   */
+  labelStyle: PropTypes.object,
+  /**
+   * Space between the mark and the label (in px).
+   * @default 5
+   */
+  markGap: PropTypes.number,
+  /**
+   * Legend padding (in px).
+   * Can either be a single number, or an object with top, left, bottom, right properties.
+   * @default 0
+   */
+  padding: PropTypes.oneOfType([PropTypes.number, PropTypes.shape({
+    bottom: PropTypes.number,
+    left: PropTypes.number,
+    right: PropTypes.number,
+    top: PropTypes.number
+  })]),
+  position: PropTypes.shape({
+    horizontal: PropTypes.oneOf(['left', 'middle', 'right']).isRequired,
+    vertical: PropTypes.oneOf(['bottom', 'middle', 'top']).isRequired
+  }).isRequired,
+  series: PropTypes.shape({
+    bar: PropTypes.shape({
+      series: PropTypes.object.isRequired,
+      seriesOrder: PropTypes.arrayOf(PropTypes.string).isRequired,
+      stackingGroups: PropTypes.arrayOf(PropTypes.shape({
+        ids: PropTypes.arrayOf(PropTypes.string).isRequired,
+        stackingOffset: PropTypes.func.isRequired,
+        stackingOrder: PropTypes.func.isRequired
+      })).isRequired
+    }),
+    line: PropTypes.shape({
+      series: PropTypes.object.isRequired,
+      seriesOrder: PropTypes.arrayOf(PropTypes.string).isRequired,
+      stackingGroups: PropTypes.arrayOf(PropTypes.shape({
+        ids: PropTypes.arrayOf(PropTypes.string).isRequired,
+        stackingOffset: PropTypes.func.isRequired,
+        stackingOrder: PropTypes.func.isRequired
+      })).isRequired
+    }),
+    pie: PropTypes.shape({
+      series: PropTypes.object.isRequired,
+      seriesOrder: PropTypes.arrayOf(PropTypes.string).isRequired
+    }),
+    scatter: PropTypes.shape({
+      series: PropTypes.object.isRequired,
+      seriesOrder: PropTypes.arrayOf(PropTypes.string).isRequired
+    })
+  }).isRequired,
+  seriesToDisplay: PropTypes.arrayOf(PropTypes.shape({
+    color: PropTypes.string.isRequired,
+    id: PropTypes.string.isRequired,
+    label: PropTypes.string.isRequired
+  })).isRequired
+} : void 0;
+function ChartsLegend(inProps) {
   const props = useThemeProps({
     props: _extends({}, defaultProps, inProps),
     name: 'MuiChartsLegend'
@@ -268,4 +369,39 @@ export function ChartsLegend(inProps) {
     ownerState: {}
   });
   return /*#__PURE__*/_jsx(ChartLegendRender, _extends({}, chartLegendRenderProps));
-}
+}
+process.env.NODE_ENV !== "production" ? ChartsLegend.propTypes = {
+  // ----------------------------- Warning --------------------------------
+  // | These PropTypes are generated from the TypeScript type definitions |
+  // | To update them edit the TypeScript types and run "yarn proptypes"  |
+  // ----------------------------------------------------------------------
+  /**
+   * Override or extend the styles applied to the component.
+   */
+  classes: PropTypes.object,
+  /**
+   * The direction of the legend layout.
+   * The default depends on the chart.
+   */
+  direction: PropTypes.oneOf(['column', 'row']),
+  /**
+   * Set to true to hide the legend.
+   * @default false
+   */
+  hidden: PropTypes.bool,
+  position: PropTypes.shape({
+    horizontal: PropTypes.oneOf(['left', 'middle', 'right']).isRequired,
+    vertical: PropTypes.oneOf(['bottom', 'middle', 'top']).isRequired
+  }),
+  /**
+   * The props used for each component slot.
+   * @default {}
+   */
+  slotProps: PropTypes.object,
+  /**
+   * Overridable component slots.
+   * @default {}
+   */
+  slots: PropTypes.object
+} : void 0;
+export { ChartsLegend };

package/modern/index.js

@@ -1,5 +1,5 @@
 /**
- * @mui/x-charts v6.18.1
+ * @mui/x-charts v7.0.0-alpha.0
  *
  * @license MIT
  * This source code is licensed under the MIT license found in the
@@ -16,6 +16,7 @@ export * from './ChartsAxis';
 export * from './ChartsXAxis';
 export * from './ChartsYAxis';
 export * from './ChartsTooltip';
+export * from './ChartsLegend';
 export * from './ChartsAxisHighlight';
 export * from './BarChart';
 export * from './LineChart';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mui/x-charts",
-  "version": "6.18.1",
+  "version": "7.0.0-alpha.0",
   "description": "The community edition of the charts components (MUI X).",
   "author": "MUI Team",
   "main": "./index.js",