-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[docs] Document missing Charts API's (#12875)
- Loading branch information
1 parent
0a2d34e
commit d3c13f9
Showing
11 changed files
with
662 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| import * as React from 'react'; | ||
| import ApiPage from 'docs/src/modules/components/ApiPage'; | ||
| import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; | ||
| import jsonPageContent from './charts-x-axis.json'; | ||
|
|
||
| export default function Page(props) { | ||
| const { descriptions, pageContent } = props; | ||
| return <ApiPage descriptions={descriptions} pageContent={pageContent} />; | ||
| } | ||
|
|
||
| Page.getInitialProps = () => { | ||
| const req = require.context( | ||
| 'docsx/translations/api-docs/charts/charts-x-axis', | ||
| false, | ||
| /\.\/charts-x-axis.*.json$/, | ||
| ); | ||
| const descriptions = mapApiPageTranslations(req); | ||
|
|
||
| return { | ||
| descriptions, | ||
| pageContent: jsonPageContent, | ||
| }; | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| { | ||
| "props": { | ||
| "axisId": { "type": { "name": "union", "description": "number<br>| string" } }, | ||
| "classes": { "type": { "name": "object" }, "additionalInfo": { "cssApi": true } }, | ||
| "disableLine": { "type": { "name": "bool" }, "default": "false" }, | ||
| "disableTicks": { "type": { "name": "bool" }, "default": "false" }, | ||
| "fill": { "type": { "name": "string" }, "default": "'currentColor'" }, | ||
| "label": { "type": { "name": "string" } }, | ||
| "labelFontSize": { | ||
| "type": { "name": "number" }, | ||
| "default": "14", | ||
| "deprecated": true, | ||
| "deprecationInfo": "Consider using <code>labelStyle.fontSize</code> instead." | ||
| }, | ||
| "labelStyle": { "type": { "name": "object" } }, | ||
| "position": { "type": { "name": "enum", "description": "'bottom'<br>| 'top'" } }, | ||
| "slotProps": { "type": { "name": "object" }, "default": "{}" }, | ||
| "slots": { | ||
| "type": { "name": "object" }, | ||
| "default": "{}", | ||
| "additionalInfo": { "slotsApi": true } | ||
| }, | ||
| "stroke": { "type": { "name": "string" }, "default": "'currentColor'" }, | ||
| "tickFontSize": { | ||
| "type": { "name": "number" }, | ||
| "default": "12", | ||
| "deprecated": true, | ||
| "deprecationInfo": "Consider using <code>tickLabelStyle.fontSize</code> instead." | ||
| }, | ||
| "tickInterval": { | ||
| "type": { "name": "union", "description": "'auto'<br>| array<br>| func" }, | ||
| "default": "'auto'" | ||
| }, | ||
| "tickLabelInterval": { | ||
| "type": { "name": "union", "description": "'auto'<br>| func" }, | ||
| "default": "'auto'" | ||
| }, | ||
| "tickLabelPlacement": { | ||
| "type": { "name": "enum", "description": "'middle'<br>| 'tick'" }, | ||
| "default": "'middle'" | ||
| }, | ||
| "tickLabelStyle": { "type": { "name": "object" } }, | ||
| "tickMaxStep": { "type": { "name": "number" } }, | ||
| "tickMinStep": { "type": { "name": "number" } }, | ||
| "tickNumber": { "type": { "name": "number" } }, | ||
| "tickPlacement": { | ||
| "type": { | ||
| "name": "enum", | ||
| "description": "'end'<br>| 'extremities'<br>| 'middle'<br>| 'start'" | ||
| }, | ||
| "default": "'extremities'" | ||
| }, | ||
| "tickSize": { "type": { "name": "number" }, "default": "6" } | ||
| }, | ||
| "name": "ChartsXAxis", | ||
| "imports": [ | ||
| "import { ChartsXAxis } from '@mui/x-charts/ChartsXAxis';", | ||
| "import { ChartsXAxis } from '@mui/x-charts';" | ||
| ], | ||
| "classes": [ | ||
| { | ||
| "key": "bottom", | ||
| "className": "MuiChartsXAxis-bottom", | ||
| "description": "Styles applied to the bottom axis.", | ||
| "isGlobal": false | ||
| }, | ||
| { | ||
| "key": "directionX", | ||
| "className": "MuiChartsXAxis-directionX", | ||
| "description": "Styles applied to x-axes.", | ||
| "isGlobal": false | ||
| }, | ||
| { | ||
| "key": "directionY", | ||
| "className": "MuiChartsXAxis-directionY", | ||
| "description": "Styles applied to y-axes.", | ||
| "isGlobal": false | ||
| }, | ||
| { | ||
| "key": "label", | ||
| "className": "MuiChartsXAxis-label", | ||
| "description": "Styles applied to the group containing the axis label.", | ||
| "isGlobal": false | ||
| }, | ||
| { | ||
| "key": "left", | ||
| "className": "MuiChartsXAxis-left", | ||
| "description": "Styles applied to the left axis.", | ||
| "isGlobal": false | ||
| }, | ||
| { | ||
| "key": "line", | ||
| "className": "MuiChartsXAxis-line", | ||
| "description": "Styles applied to the main line element.", | ||
| "isGlobal": false | ||
| }, | ||
| { | ||
| "key": "right", | ||
| "className": "MuiChartsXAxis-right", | ||
| "description": "Styles applied to the right axis.", | ||
| "isGlobal": false | ||
| }, | ||
| { | ||
| "key": "root", | ||
| "className": "MuiChartsXAxis-root", | ||
| "description": "Styles applied to the root element.", | ||
| "isGlobal": false | ||
| }, | ||
| { | ||
| "key": "tick", | ||
| "className": "MuiChartsXAxis-tick", | ||
| "description": "Styles applied to ticks.", | ||
| "isGlobal": false | ||
| }, | ||
| { | ||
| "key": "tickContainer", | ||
| "className": "MuiChartsXAxis-tickContainer", | ||
| "description": "Styles applied to group including the tick and its label.", | ||
| "isGlobal": false | ||
| }, | ||
| { | ||
| "key": "tickLabel", | ||
| "className": "MuiChartsXAxis-tickLabel", | ||
| "description": "Styles applied to ticks label.", | ||
| "isGlobal": false | ||
| }, | ||
| { | ||
| "key": "top", | ||
| "className": "MuiChartsXAxis-top", | ||
| "description": "Styles applied to the top axis.", | ||
| "isGlobal": false | ||
| } | ||
| ], | ||
| "muiName": "MuiChartsXAxis", | ||
| "filename": "/packages/x-charts/src/ChartsXAxis/ChartsXAxis.tsx", | ||
| "inheritance": null, | ||
| "demos": "<ul><li><a href=\"/x/react-charts/axis/\">Charts - Axis</a></li></ul>", | ||
| "cssComponent": false | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| import * as React from 'react'; | ||
| import ApiPage from 'docs/src/modules/components/ApiPage'; | ||
| import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; | ||
| import jsonPageContent from './charts-y-axis.json'; | ||
|
|
||
| export default function Page(props) { | ||
| const { descriptions, pageContent } = props; | ||
| return <ApiPage descriptions={descriptions} pageContent={pageContent} />; | ||
| } | ||
|
|
||
| Page.getInitialProps = () => { | ||
| const req = require.context( | ||
| 'docsx/translations/api-docs/charts/charts-y-axis', | ||
| false, | ||
| /\.\/charts-y-axis.*.json$/, | ||
| ); | ||
| const descriptions = mapApiPageTranslations(req); | ||
|
|
||
| return { | ||
| descriptions, | ||
| pageContent: jsonPageContent, | ||
| }; | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| { | ||
| "props": { | ||
| "axisId": { "type": { "name": "union", "description": "number<br>| string" } }, | ||
| "classes": { "type": { "name": "object" }, "additionalInfo": { "cssApi": true } }, | ||
| "disableLine": { "type": { "name": "bool" }, "default": "false" }, | ||
| "disableTicks": { "type": { "name": "bool" }, "default": "false" }, | ||
| "fill": { "type": { "name": "string" }, "default": "'currentColor'" }, | ||
| "label": { "type": { "name": "string" } }, | ||
| "labelFontSize": { | ||
| "type": { "name": "number" }, | ||
| "default": "14", | ||
| "deprecated": true, | ||
| "deprecationInfo": "Consider using <code>labelStyle.fontSize</code> instead." | ||
| }, | ||
| "labelStyle": { "type": { "name": "object" } }, | ||
| "position": { "type": { "name": "enum", "description": "'left'<br>| 'right'" } }, | ||
| "slotProps": { "type": { "name": "object" }, "default": "{}" }, | ||
| "slots": { | ||
| "type": { "name": "object" }, | ||
| "default": "{}", | ||
| "additionalInfo": { "slotsApi": true } | ||
| }, | ||
| "stroke": { "type": { "name": "string" }, "default": "'currentColor'" }, | ||
| "tickFontSize": { | ||
| "type": { "name": "number" }, | ||
| "default": "12", | ||
| "deprecated": true, | ||
| "deprecationInfo": "Consider using <code>tickLabelStyle.fontSize</code> instead." | ||
| }, | ||
| "tickInterval": { | ||
| "type": { "name": "union", "description": "'auto'<br>| array<br>| func" }, | ||
| "default": "'auto'" | ||
| }, | ||
| "tickLabelInterval": { | ||
| "type": { "name": "union", "description": "'auto'<br>| func" }, | ||
| "default": "'auto'" | ||
| }, | ||
| "tickLabelPlacement": { | ||
| "type": { "name": "enum", "description": "'middle'<br>| 'tick'" }, | ||
| "default": "'middle'" | ||
| }, | ||
| "tickLabelStyle": { "type": { "name": "object" } }, | ||
| "tickMaxStep": { "type": { "name": "number" } }, | ||
| "tickMinStep": { "type": { "name": "number" } }, | ||
| "tickNumber": { "type": { "name": "number" } }, | ||
| "tickPlacement": { | ||
| "type": { | ||
| "name": "enum", | ||
| "description": "'end'<br>| 'extremities'<br>| 'middle'<br>| 'start'" | ||
| }, | ||
| "default": "'extremities'" | ||
| }, | ||
| "tickSize": { "type": { "name": "number" }, "default": "6" } | ||
| }, | ||
| "name": "ChartsYAxis", | ||
| "imports": [ | ||
| "import { ChartsYAxis } from '@mui/x-charts/ChartsYAxis';", | ||
| "import { ChartsYAxis } from '@mui/x-charts';" | ||
| ], | ||
| "classes": [ | ||
| { | ||
| "key": "bottom", | ||
| "className": "MuiChartsYAxis-bottom", | ||
| "description": "Styles applied to the bottom axis.", | ||
| "isGlobal": false | ||
| }, | ||
| { | ||
| "key": "directionX", | ||
| "className": "MuiChartsYAxis-directionX", | ||
| "description": "Styles applied to x-axes.", | ||
| "isGlobal": false | ||
| }, | ||
| { | ||
| "key": "directionY", | ||
| "className": "MuiChartsYAxis-directionY", | ||
| "description": "Styles applied to y-axes.", | ||
| "isGlobal": false | ||
| }, | ||
| { | ||
| "key": "label", | ||
| "className": "MuiChartsYAxis-label", | ||
| "description": "Styles applied to the group containing the axis label.", | ||
| "isGlobal": false | ||
| }, | ||
| { | ||
| "key": "left", | ||
| "className": "MuiChartsYAxis-left", | ||
| "description": "Styles applied to the left axis.", | ||
| "isGlobal": false | ||
| }, | ||
| { | ||
| "key": "line", | ||
| "className": "MuiChartsYAxis-line", | ||
| "description": "Styles applied to the main line element.", | ||
| "isGlobal": false | ||
| }, | ||
| { | ||
| "key": "right", | ||
| "className": "MuiChartsYAxis-right", | ||
| "description": "Styles applied to the right axis.", | ||
| "isGlobal": false | ||
| }, | ||
| { | ||
| "key": "root", | ||
| "className": "MuiChartsYAxis-root", | ||
| "description": "Styles applied to the root element.", | ||
| "isGlobal": false | ||
| }, | ||
| { | ||
| "key": "tick", | ||
| "className": "MuiChartsYAxis-tick", | ||
| "description": "Styles applied to ticks.", | ||
| "isGlobal": false | ||
| }, | ||
| { | ||
| "key": "tickContainer", | ||
| "className": "MuiChartsYAxis-tickContainer", | ||
| "description": "Styles applied to group including the tick and its label.", | ||
| "isGlobal": false | ||
| }, | ||
| { | ||
| "key": "tickLabel", | ||
| "className": "MuiChartsYAxis-tickLabel", | ||
| "description": "Styles applied to ticks label.", | ||
| "isGlobal": false | ||
| }, | ||
| { | ||
| "key": "top", | ||
| "className": "MuiChartsYAxis-top", | ||
| "description": "Styles applied to the top axis.", | ||
| "isGlobal": false | ||
| } | ||
| ], | ||
| "muiName": "MuiChartsYAxis", | ||
| "filename": "/packages/x-charts/src/ChartsYAxis/ChartsYAxis.tsx", | ||
| "inheritance": null, | ||
| "demos": "<ul><li><a href=\"/x/react-charts/axis/\">Charts - Axis</a></li></ul>", | ||
| "cssComponent": false | ||
| } |
Oops, something went wrong.