Skip to content

Commit 1c3bc37

Browse files
Gen files
1 parent b67aa11 commit 1c3bc37

File tree

30 files changed

+615
-10
lines changed

30 files changed

+615
-10
lines changed

docs/data/charts/localization/data.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
"languageTag": "fr-FR",
44
"importName": "frFR",
55
"localeName": "French",
6-
"missingKeysCount": 0,
7-
"totalKeysCount": 2,
6+
"missingKeysCount": 2,
7+
"totalKeysCount": 4,
88
"githubLink": "https://github.com/mui/mui-x/blob/master/packages/x-charts/src/locales/frFR.ts"
99
}
1010
]

docs/data/charts/toolbar/toolbar.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Charts - Toolbar
33
productId: x-charts
4+
components: Toolbar, ToolbarButton, ChartsToolbarPro
45
---
56

67
# Charts - Toolbar 🧪
@@ -22,3 +23,5 @@ For example, if the chart is not zoomable, the zoom buttons will not be displaye
2223
:::
2324

2425
{{"demo": "ChartsToolbar.js"}}
26+
27+
## Composition 🚧

docs/data/chartsApiPages.ts

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,11 @@ const chartsApiPages: MuiPage[] = [
100100
pathname: '/x/api/charts/charts-text',
101101
title: 'ChartsText',
102102
},
103+
{
104+
pathname: '/x/api/charts/charts-toolbar-pro',
105+
title: 'ChartsToolbarPro',
106+
plan: 'pro',
107+
},
103108
{
104109
pathname: '/x/api/charts/charts-tooltip',
105110
title: 'ChartsTooltip',
@@ -267,5 +272,13 @@ const chartsApiPages: MuiPage[] = [
267272
pathname: '/x/api/charts/spark-line-chart',
268273
title: 'SparkLineChart',
269274
},
275+
{
276+
pathname: '/x/api/charts/toolbar',
277+
title: 'Toolbar',
278+
},
279+
{
280+
pathname: '/x/api/charts/toolbar-button',
281+
title: 'ToolbarButton',
282+
},
270283
];
271284
export default chartsApiPages;

docs/pages/x/api/charts/bar-chart-pro.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@
8080
"describedArgs": ["zoomData"]
8181
}
8282
},
83+
"showToolbar": { "type": { "name": "bool" }, "default": "false" },
8384
"skipAnimation": { "type": { "name": "bool" } },
8485
"slotProps": { "type": { "name": "object" }, "default": "{}" },
8586
"slots": {
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
import * as React from 'react';
2+
import ApiPage from 'docs/src/modules/components/ApiPage';
3+
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
4+
import jsonPageContent from './charts-toolbar-pro.json';
5+
6+
export default function Page(props) {
7+
const { descriptions, pageContent } = props;
8+
return <ApiPage descriptions={descriptions} pageContent={pageContent} />;
9+
}
10+
11+
Page.getInitialProps = () => {
12+
const req = require.context(
13+
'docsx/translations/api-docs/charts/charts-toolbar-pro',
14+
false,
15+
/\.\/charts-toolbar-pro.*.json$/,
16+
);
17+
const descriptions = mapApiPageTranslations(req);
18+
19+
return {
20+
descriptions,
21+
pageContent: jsonPageContent,
22+
};
23+
};
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"props": {},
3+
"name": "ChartsToolbarPro",
4+
"imports": [
5+
"import { ChartsToolbarPro } from '@mui/x-charts-pro/ChartsToolbarPro';",
6+
"import { ChartsToolbarPro } from '@mui/x-charts-pro';"
7+
],
8+
"classes": [],
9+
"muiName": "MuiChartsToolbarPro",
10+
"filename": "/packages/x-charts-pro/src/ChartsToolbarPro/ChartsToolbarPro.tsx",
11+
"inheritance": null,
12+
"demos": "<ul><li><a href=\"/x/react-charts/toolbar/\">Charts - Toolbar 🧪</a></li></ul>",
13+
"cssComponent": false
14+
}

docs/pages/x/api/charts/line-chart-pro.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@
7272
"describedArgs": ["zoomData"]
7373
}
7474
},
75+
"showToolbar": { "type": { "name": "bool" }, "default": "false" },
7576
"skipAnimation": { "type": { "name": "bool" }, "default": "false" },
7677
"slotProps": { "type": { "name": "object" }, "default": "{}" },
7778
"slots": {

docs/pages/x/api/charts/scatter-chart-pro.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@
7676
"describedArgs": ["zoomData"]
7777
}
7878
},
79+
"showToolbar": { "type": { "name": "bool" }, "default": "false" },
7980
"skipAnimation": { "type": { "name": "bool" } },
8081
"slotProps": { "type": { "name": "object" }, "default": "{}" },
8182
"slots": {
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
import * as React from 'react';
2+
import ApiPage from 'docs/src/modules/components/ApiPage';
3+
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
4+
import jsonPageContent from './toolbar-button.json';
5+
6+
export default function Page(props) {
7+
const { descriptions, pageContent } = props;
8+
return <ApiPage descriptions={descriptions} pageContent={pageContent} />;
9+
}
10+
11+
Page.getInitialProps = () => {
12+
const req = require.context(
13+
'docsx/translations/api-docs/charts/toolbar-button',
14+
false,
15+
/\.\/toolbar-button.*.json$/,
16+
);
17+
const descriptions = mapApiPageTranslations(req);
18+
19+
return {
20+
descriptions,
21+
pageContent: jsonPageContent,
22+
};
23+
};
Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
{
2+
"props": {
3+
"action": {
4+
"type": {
5+
"name": "union",
6+
"description": "func<br>&#124;&nbsp;{ current?: { focusVisible: func } }"
7+
}
8+
},
9+
"centerRipple": { "type": { "name": "bool" }, "default": "false" },
10+
"color": {
11+
"type": {
12+
"name": "enum",
13+
"description": "'default'<br>&#124;&nbsp;'error'<br>&#124;&nbsp;'info'<br>&#124;&nbsp;'inherit'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'secondary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'"
14+
},
15+
"default": "'default'"
16+
},
17+
"disabled": { "type": { "name": "bool" }, "default": "false" },
18+
"disableFocusRipple": { "type": { "name": "bool" }, "default": "false" },
19+
"disableRipple": { "type": { "name": "bool" }, "default": "false" },
20+
"disableTouchRipple": { "type": { "name": "bool" }, "default": "false" },
21+
"edge": {
22+
"type": {
23+
"name": "enum",
24+
"description": "'end'<br>&#124;&nbsp;'start'<br>&#124;&nbsp;false"
25+
},
26+
"default": "false"
27+
},
28+
"focusRipple": { "type": { "name": "bool" }, "default": "false" },
29+
"focusVisibleClassName": { "type": { "name": "string" } },
30+
"LinkComponent": { "type": { "name": "elementType" }, "default": "'a'" },
31+
"loading": { "type": { "name": "bool" }, "default": "null" },
32+
"loadingIndicator": {
33+
"type": { "name": "node" },
34+
"default": "<CircularProgress color=\"inherit\" size={16} />"
35+
},
36+
"onFocusVisible": { "type": { "name": "func" } },
37+
"size": {
38+
"type": {
39+
"name": "enum",
40+
"description": "'large'<br>&#124;&nbsp;'medium'<br>&#124;&nbsp;'small'"
41+
},
42+
"default": "'medium'"
43+
},
44+
"sx": {
45+
"type": {
46+
"name": "union",
47+
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
48+
},
49+
"additionalInfo": { "sx": true }
50+
},
51+
"TouchRippleProps": { "type": { "name": "object" } },
52+
"touchRippleRef": {
53+
"type": {
54+
"name": "union",
55+
"description": "func<br>&#124;&nbsp;{ current?: { pulsate: func, start: func, stop: func } }"
56+
}
57+
}
58+
},
59+
"name": "ToolbarButton",
60+
"imports": [
61+
"import { ToolbarButton } from '@mui/x-charts/Toolbar';",
62+
"import { ToolbarButton } from '@mui/x-charts';",
63+
"import { ToolbarButton } from '@mui/x-charts-pro';"
64+
],
65+
"classes": [
66+
{
67+
"key": "colorError",
68+
"className": "MuiToolbarButton-colorError",
69+
"description": "Styles applied to the root element if `color=\"error\"`.",
70+
"isGlobal": false
71+
},
72+
{
73+
"key": "colorInfo",
74+
"className": "MuiToolbarButton-colorInfo",
75+
"description": "Styles applied to the root element if `color=\"info\"`.",
76+
"isGlobal": false
77+
},
78+
{
79+
"key": "colorInherit",
80+
"className": "MuiToolbarButton-colorInherit",
81+
"description": "Styles applied to the root element if `color=\"inherit\"`.",
82+
"isGlobal": false
83+
},
84+
{
85+
"key": "colorPrimary",
86+
"className": "MuiToolbarButton-colorPrimary",
87+
"description": "Styles applied to the root element if `color=\"primary\"`.",
88+
"isGlobal": false
89+
},
90+
{
91+
"key": "colorSecondary",
92+
"className": "MuiToolbarButton-colorSecondary",
93+
"description": "Styles applied to the root element if `color=\"secondary\"`.",
94+
"isGlobal": false
95+
},
96+
{
97+
"key": "colorSuccess",
98+
"className": "MuiToolbarButton-colorSuccess",
99+
"description": "Styles applied to the root element if `color=\"success\"`.",
100+
"isGlobal": false
101+
},
102+
{
103+
"key": "colorWarning",
104+
"className": "MuiToolbarButton-colorWarning",
105+
"description": "Styles applied to the root element if `color=\"warning\"`.",
106+
"isGlobal": false
107+
},
108+
{
109+
"key": "disabled",
110+
"className": "Mui-disabled",
111+
"description": "State class applied to the root element if `disabled={true}`.",
112+
"isGlobal": true
113+
},
114+
{
115+
"key": "edgeEnd",
116+
"className": "MuiToolbarButton-edgeEnd",
117+
"description": "Styles applied to the root element if `edge=\"end\"`.",
118+
"isGlobal": false
119+
},
120+
{
121+
"key": "edgeStart",
122+
"className": "MuiToolbarButton-edgeStart",
123+
"description": "Styles applied to the root element if `edge=\"start\"`.",
124+
"isGlobal": false
125+
},
126+
{
127+
"key": "loading",
128+
"className": "MuiToolbarButton-loading",
129+
"description": "Styles applied to the root element if `loading={true}`.",
130+
"isGlobal": false
131+
},
132+
{
133+
"key": "loadingIndicator",
134+
"className": "MuiToolbarButton-loadingIndicator",
135+
"description": "Styles applied to the loadingIndicator element.",
136+
"isGlobal": false
137+
},
138+
{
139+
"key": "loadingWrapper",
140+
"className": "MuiToolbarButton-loadingWrapper",
141+
"description": "Styles applied to the loadingWrapper element.",
142+
"isGlobal": false
143+
},
144+
{
145+
"key": "root",
146+
"className": "MuiToolbarButton-root",
147+
"description": "Styles applied to the root element.",
148+
"isGlobal": false
149+
},
150+
{
151+
"key": "sizeLarge",
152+
"className": "MuiToolbarButton-sizeLarge",
153+
"description": "Styles applied to the root element if `size=\"large\"`.",
154+
"isGlobal": false
155+
},
156+
{
157+
"key": "sizeMedium",
158+
"className": "MuiToolbarButton-sizeMedium",
159+
"description": "Styles applied to the root element if `size=\"medium\"`.",
160+
"isGlobal": false
161+
},
162+
{
163+
"key": "sizeSmall",
164+
"className": "MuiToolbarButton-sizeSmall",
165+
"description": "Styles applied to the root element if `size=\"small\"`.",
166+
"isGlobal": false
167+
}
168+
],
169+
"muiName": "MuiToolbarButton",
170+
"filename": "/packages/x-charts/src/Toolbar/ToolbarButton.tsx",
171+
"inheritance": null,
172+
"demos": "<ul><li><a href=\"/x/react-charts/toolbar/\">Charts - Toolbar 🧪</a></li></ul>",
173+
"cssComponent": false
174+
}

docs/pages/x/api/charts/toolbar.js

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
import * as React from 'react';
2+
import ApiPage from 'docs/src/modules/components/ApiPage';
3+
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
4+
import jsonPageContent from './toolbar.json';
5+
6+
export default function Page(props) {
7+
const { descriptions, pageContent } = props;
8+
return <ApiPage descriptions={descriptions} pageContent={pageContent} />;
9+
}
10+
11+
Page.getInitialProps = () => {
12+
const req = require.context(
13+
'docsx/translations/api-docs/charts/toolbar',
14+
false,
15+
/\.\/toolbar.*.json$/,
16+
);
17+
const descriptions = mapApiPageTranslations(req);
18+
19+
return {
20+
descriptions,
21+
pageContent: jsonPageContent,
22+
};
23+
};

docs/pages/x/api/charts/toolbar.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"props": {},
3+
"name": "Toolbar",
4+
"imports": [
5+
"import { Toolbar } from '@mui/x-charts/Toolbar';",
6+
"import { Toolbar } from '@mui/x-charts';",
7+
"import { Toolbar } from '@mui/x-charts-pro';"
8+
],
9+
"classes": [],
10+
"muiName": "MuiToolbar",
11+
"filename": "/packages/x-charts/src/Toolbar/Toolbar.tsx",
12+
"inheritance": null,
13+
"demos": "<ul><li><a href=\"/x/react-charts/toolbar/\">Charts - Toolbar 🧪</a></li></ul>",
14+
"cssComponent": false
15+
}

docs/translations/api-docs/charts/bar-chart-pro/bar-chart-pro.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@
6161
"series": {
6262
"description": "The series to display in the bar chart. An array of <a href='/x/api/charts/bar-series-type/'>BarSeriesType</a> objects."
6363
},
64+
"showToolbar": { "description": "If true, shows the default chart toolbar." },
6465
"skipAnimation": {
6566
"description": "If <code>true</code>, animations are skipped. If unset or <code>false</code>, the animations respects the user&#39;s <code>prefers-reduced-motion</code> setting."
6667
},
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{ "componentDescription": "", "propDescriptions": {}, "classDescriptions": {} }

docs/translations/api-docs/charts/line-chart-pro/line-chart-pro.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@
5555
"series": {
5656
"description": "The series to display in the line chart. An array of <a href='/x/api/charts/line-series-type/'>LineSeriesType</a> objects."
5757
},
58+
"showToolbar": { "description": "If true, shows the default chart toolbar." },
5859
"skipAnimation": { "description": "If <code>true</code>, animations are skipped." },
5960
"slotProps": { "description": "The props used for each component slot." },
6061
"slots": { "description": "Overridable component slots." },

docs/translations/api-docs/charts/scatter-chart-pro/scatter-chart-pro.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@
5959
"series": {
6060
"description": "The series to display in the scatter chart. An array of <a href='/x/api/charts/scatter-series-type/'>ScatterSeriesType</a> objects."
6161
},
62+
"showToolbar": { "description": "If true, shows the default chart toolbar." },
6263
"skipAnimation": {
6364
"description": "If <code>true</code>, animations are skipped. If unset or <code>false</code>, the animations respects the user&#39;s <code>prefers-reduced-motion</code> setting."
6465
},

0 commit comments

Comments
 (0)