Skip to content

Commit

Permalink
[charts] Fix docs/translations/errors typos (#12941)
Browse files Browse the repository at this point in the history
  • Loading branch information
JCQuintas authored Apr 29, 2024
1 parent c0b6932 commit f1114f0
Show file tree
Hide file tree
Showing 50 changed files with 94 additions and 94 deletions.
2 changes: 1 addition & 1 deletion docs/pages/x/api/charts/area-element.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
{
"key": "highlighted",
"className": "MuiAreaElement-highlighted",
"description": "Styles applied to the root element when higlighted.",
"description": "Styles applied to the root element when highlighted.",
"isGlobal": false
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/x/api/charts/charts-axis.json
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
{
"key": "tickContainer",
"className": "MuiChartsAxis-tickContainer",
"description": "Styles applied to group ingruding the tick and its label.",
"description": "Styles applied to group including the tick and its label.",
"isGlobal": false
},
{
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/x/api/charts/gauge.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
{
"key": "referenceArc",
"className": "MuiGauge-referenceArc",
"description": "Styles applied to the arc diplaying the range of available values.",
"description": "Styles applied to the arc displaying the range of available values.",
"isGlobal": false
},
{
Expand All @@ -51,7 +51,7 @@
{
"key": "valueArc",
"className": "MuiGauge-valueArc",
"description": "Styles applied to the arc diplaying the value.",
"description": "Styles applied to the arc displaying the value.",
"isGlobal": false
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/x/api/charts/line-element.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
{
"key": "highlighted",
"className": "MuiLineElement-highlighted",
"description": "Styles applied to the root element when higlighted.",
"description": "Styles applied to the root element when highlighted.",
"isGlobal": false
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/x/api/charts/mark-element.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
{
"key": "highlighted",
"className": "MuiMarkElement-highlighted",
"description": "Styles applied to the root element when higlighted.",
"description": "Styles applied to the root element when highlighted.",
"isGlobal": false
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/x/api/charts/pie-arc-label.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
{
"key": "highlighted",
"className": "MuiPieArcLabel-highlighted",
"description": "Styles applied to the root element when higlighted.",
"description": "Styles applied to the root element when highlighted.",
"isGlobal": false
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/x/api/charts/pie-arc.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
{
"key": "highlighted",
"className": "MuiPieArc-highlighted",
"description": "Styles applied to the root element when higlighted.",
"description": "Styles applied to the root element when highlighted.",
"isGlobal": false
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"highlighted": {
"description": "Styles applied to {{nodeName}} when {{conditions}}.",
"nodeName": "the root element",
"conditions": "higlighted"
"conditions": "highlighted"
},
"root": { "description": "Styles applied to the root element." }
},
Expand Down
2 changes: 1 addition & 1 deletion docs/translations/api-docs/charts/bar-series-type.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"type": { "description": "" },
"color": { "description": "" },
"data": { "description": "Data associated to each bar." },
"dataKey": { "description": "The key used to retrive data from the dataset." },
"dataKey": { "description": "The key used to retrieve data from the dataset." },
"highlightScope": { "description": "" },
"id": { "description": "" },
"label": { "description": "" },
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"tick": { "description": "Styles applied to {{nodeName}}.", "nodeName": "ticks" },
"tickContainer": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "group ingruding the tick and its label"
"nodeName": "group including the tick and its label"
},
"tickLabel": { "description": "Styles applied to {{nodeName}}.", "nodeName": "ticks label" },
"top": { "description": "Styles applied to {{nodeName}}.", "nodeName": "the top axis" }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"labelStyle": { "description": "The style applied to the label." },
"lineStyle": { "description": "The style applied to the line." },
"spacing": {
"description": "Additional space arround the label in px. Can be a number or an object <code>{ x, y }</code> to distinguish space with the reference line and space with axes."
"description": "Additional space around the label in px. Can be a number or an object <code>{ x, y }</code> to distinguish space with the reference line and space with axes."
},
"x": {
"description": "The x value associated with the reference line. If defined the reference line will be vertical."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
"componentDescription": "",
"propDescriptions": {
"axisContent": {
"description": "Component to override the tooltip content when triger is set to &#39;axis&#39;."
"description": "Component to override the tooltip content when trigger is set to &#39;axis&#39;."
},
"classes": { "description": "Override or extend the styles applied to the component." },
"itemContent": {
"description": "Component to override the tooltip content when triger is set to &#39;item&#39;."
"description": "Component to override the tooltip content when trigger is set to &#39;item&#39;."
},
"slotProps": { "description": "The props used for each component slot." },
"slots": { "description": "Overridable component slots." },
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"description": "The height of the chart in px. If not defined, it takes the height of the parent element."
},
"innerRadius": {
"description": "The radius between circle center and the begining of the arc. Can be a number (in px) or a string with a percentage such as &#39;50%&#39;. The &#39;100%&#39; is the maximal radius that fit into the drawing area."
"description": "The radius between circle center and the beginning of the arc. Can be a number (in px) or a string with a percentage such as &#39;50%&#39;. The &#39;100%&#39; is the maximal radius that fit into the drawing area."
},
"margin": {
"description": "The margin between the SVG and the drawing area. It&#39;s used for leaving some space for extra information such as the x- and y-axis or legend. Accepts an object with the optional properties: <code>top</code>, <code>bottom</code>, <code>left</code>, and <code>right</code>."
Expand Down
6 changes: 3 additions & 3 deletions docs/translations/api-docs/charts/gauge/gauge.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"description": "The height of the chart in px. If not defined, it takes the height of the parent element."
},
"innerRadius": {
"description": "The radius between circle center and the begining of the arc. Can be a number (in px) or a string with a percentage such as &#39;50%&#39;. The &#39;100%&#39; is the maximal radius that fit into the drawing area."
"description": "The radius between circle center and the beginning of the arc. Can be a number (in px) or a string with a percentage such as &#39;50%&#39;. The &#39;100%&#39; is the maximal radius that fit into the drawing area."
},
"margin": {
"description": "The margin between the SVG and the drawing area. It&#39;s used for leaving some space for extra information such as the x- and y-axis or legend. Accepts an object with the optional properties: <code>top</code>, <code>bottom</code>, <code>left</code>, and <code>right</code>."
Expand All @@ -39,12 +39,12 @@
"classDescriptions": {
"referenceArc": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the arc diplaying the range of available values"
"nodeName": "the arc displaying the range of available values"
},
"root": { "description": "Styles applied to the root element." },
"valueArc": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the arc diplaying the value"
"nodeName": "the arc displaying the value"
},
"valueText": { "description": "Styles applied to {{nodeName}}.", "nodeName": "the value text" }
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"highlighted": {
"description": "Styles applied to {{nodeName}} when {{conditions}}.",
"nodeName": "the root element",
"conditions": "higlighted"
"conditions": "highlighted"
},
"root": { "description": "Styles applied to the root element." }
},
Expand Down
2 changes: 1 addition & 1 deletion docs/translations/api-docs/charts/line-series-type.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
},
"curve": { "description": "" },
"data": { "description": "Data associated to the line." },
"dataKey": { "description": "The key used to retrive data from the dataset." },
"dataKey": { "description": "The key used to retrieve data from the dataset." },
"disableHighlight": {
"description": "Do not render the line highlight item if set to <code>true</code>."
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"highlighted": {
"description": "Styles applied to {{nodeName}} when {{conditions}}.",
"nodeName": "the root element",
"conditions": "higlighted"
"conditions": "highlighted"
},
"root": { "description": "Styles applied to the root element." }
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@
"cornerRadius": {
"description": "The radius applied to arc corners (similar to border radius)."
},
"faded": { "description": "Override the arc attibutes when it is faded." },
"highlighted": { "description": "Override the arc attibutes when it is highlighted." },
"faded": { "description": "Override the arc attributes when it is faded." },
"highlighted": { "description": "Override the arc attributes when it is highlighted." },
"innerRadius": {
"description": "The radius between circle center and the begining of the arc."
"description": "The radius between circle center and the beginning of the arc."
},
"outerRadius": { "description": "The radius between circle center and the end of the arc." },
"paddingAngle": { "description": "The padding angle (deg) between two arcs." },
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"highlighted": {
"description": "Styles applied to {{nodeName}} when {{conditions}}.",
"nodeName": "the root element",
"conditions": "higlighted"
"conditions": "highlighted"
},
"root": { "description": "Styles applied to the root element." }
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@
"cornerRadius": {
"description": "The radius applied to arc corners (similar to border radius)."
},
"faded": { "description": "Override the arc attibutes when it is faded." },
"highlighted": { "description": "Override the arc attibutes when it is highlighted." },
"faded": { "description": "Override the arc attributes when it is faded." },
"highlighted": { "description": "Override the arc attributes when it is highlighted." },
"innerRadius": {
"description": "The radius between circle center and the begining of the arc."
"description": "The radius between circle center and the beginning of the arc."
},
"onItemClick": {
"description": "Callback fired when a pie item is clicked.",
Expand Down
2 changes: 1 addition & 1 deletion docs/translations/api-docs/charts/pie-arc/pie-arc.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"highlighted": {
"description": "Styles applied to {{nodeName}} when {{conditions}}.",
"nodeName": "the root element",
"conditions": "higlighted"
"conditions": "highlighted"
},
"root": { "description": "Styles applied to the root element." }
}
Expand Down
6 changes: 3 additions & 3 deletions docs/translations/api-docs/charts/pie-series-type.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@
"description": "The y coordinate of the pie center.<br />Can be a number (in px) or a string with a percentage such as &#39;50%&#39;.<br />The &#39;100%&#39; is the height the drawing area."
},
"endAngle": { "description": "The end angle (deg) of the last item." },
"faded": { "description": "Override the arc attibutes when it is faded." },
"highlighted": { "description": "Override the arc attibutes when it is highlighted." },
"faded": { "description": "Override the arc attributes when it is faded." },
"highlighted": { "description": "Override the arc attributes when it is highlighted." },
"highlightScope": { "description": "" },
"id": { "description": "" },
"innerRadius": {
"description": "The radius between circle center and the begining of the arc.<br />Can be a number (in px) or a string with a percentage such as &#39;50%&#39;.<br />The &#39;100%&#39; is the maximal radius that fit into the drawing area."
"description": "The radius between circle center and the beginning of the arc.<br />Can be a number (in px) or a string with a percentage such as &#39;50%&#39;.<br />The &#39;100%&#39; is the maximal radius that fit into the drawing area."
},
"outerRadius": {
"description": "The radius between circle center and the end of the arc.<br />Can be a number (in px) or a string with a percentage such as &#39;50%&#39;.<br />The &#39;100%&#39; is the maximal radius that fit into the drawing area."
Expand Down
12 changes: 6 additions & 6 deletions packages/x-charts/src/BarChart/BarPlot.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ const useAggregatedData = (): CompletedBarData[] => {
xAxisKey === DEFAULT_X_AXIS_KEY
? 'The first `xAxis`'
: `The x-axis with id "${xAxisKey}"`
} shoud be of type "band" to display the bar series of id "${seriesId}".`,
} should be of type "band" to display the bar series of id "${seriesId}".`,
);
}
if (xAxis[xAxisKey].data === undefined) {
Expand All @@ -117,7 +117,7 @@ const useAggregatedData = (): CompletedBarData[] => {
xAxisKey === DEFAULT_X_AXIS_KEY
? 'The first `xAxis`'
: `The x-axis with id "${xAxisKey}"`
} shoud have data property.`,
} should have data property.`,
);
}
baseScaleConfig = xAxisConfig as AxisDefaultized<'band'>;
Expand All @@ -127,7 +127,7 @@ const useAggregatedData = (): CompletedBarData[] => {
yAxisKey === DEFAULT_Y_AXIS_KEY
? 'The first `yAxis`'
: `The y-axis with id "${yAxisKey}"`
} shoud be a continuous type to display the bar series of id "${seriesId}".`,
} should be a continuous type to display the bar series of id "${seriesId}".`,
);
}
} else {
Expand All @@ -137,7 +137,7 @@ const useAggregatedData = (): CompletedBarData[] => {
yAxisKey === DEFAULT_Y_AXIS_KEY
? 'The first `yAxis`'
: `The y-axis with id "${yAxisKey}"`
} shoud be of type "band" to display the bar series of id "${seriesId}".`,
} should be of type "band" to display the bar series of id "${seriesId}".`,
);
}

Expand All @@ -147,7 +147,7 @@ const useAggregatedData = (): CompletedBarData[] => {
yAxisKey === DEFAULT_Y_AXIS_KEY
? 'The first `yAxis`'
: `The y-axis with id "${yAxisKey}"`
} shoud have data property.`,
} should have data property.`,
);
}
baseScaleConfig = yAxisConfig as AxisDefaultized<'band'>;
Expand All @@ -157,7 +157,7 @@ const useAggregatedData = (): CompletedBarData[] => {
xAxisKey === DEFAULT_X_AXIS_KEY
? 'The first `xAxis`'
: `The x-axis with id "${xAxisKey}"`
} shoud be a continuous type to display the bar series of id "${seriesId}".`,
} should be a continuous type to display the bar series of id "${seriesId}".`,
);
}
}
Expand Down
2 changes: 1 addition & 1 deletion packages/x-charts/src/ChartsAxis/axisClasses.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export interface ChartsAxisClasses {
root: string;
/** Styles applied to the main line element. */
line: string;
/** Styles applied to group ingruding the tick and its label. */
/** Styles applied to group including the tick and its label. */
tickContainer: string;
/** Styles applied to ticks. */
tick: string;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ ChartsReferenceLine.propTypes = {
*/
lineStyle: PropTypes.object,
/**
* Additional space arround the label in px.
* Additional space around the label in px.
* Can be a number or an object `{ x, y }` to distinguish space with the reference line and space with axes.
* @default 5
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/x-charts/src/ChartsReferenceLine/common.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export type CommonChartsReferenceLineProps = {
*/
label?: string;
/**
* Additional space arround the label in px.
* Additional space around the label in px.
* Can be a number or an object `{ x, y }` to distinguish space with the reference line and space with axes.
* @default 5
*/
Expand Down
8 changes: 4 additions & 4 deletions packages/x-charts/src/ChartsTooltip/ChartsTooltip.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -62,12 +62,12 @@ export type ChartsTooltipProps = {
*/
trigger?: TriggerOptions;
/**
* Component to override the tooltip content when triger is set to 'item'.
* Component to override the tooltip content when trigger is set to 'item'.
* @deprecated Use slots.itemContent instead
*/
itemContent?: React.ElementType<ChartsItemContentProps<any>>;
/**
* Component to override the tooltip content when triger is set to 'axis'.
* Component to override the tooltip content when trigger is set to 'axis'.
* @deprecated Use slots.axisContent instead
*/
axisContent?: React.ElementType<ChartsAxisContentProps>;
Expand Down Expand Up @@ -189,7 +189,7 @@ ChartsTooltip.propTypes = {
// | To update them edit the TypeScript types and run "yarn proptypes" |
// ----------------------------------------------------------------------
/**
* Component to override the tooltip content when triger is set to 'axis'.
* Component to override the tooltip content when trigger is set to 'axis'.
* @deprecated Use slots.axisContent instead
*/
axisContent: PropTypes.elementType,
Expand All @@ -198,7 +198,7 @@ ChartsTooltip.propTypes = {
*/
classes: PropTypes.object,
/**
* Component to override the tooltip content when triger is set to 'item'.
* Component to override the tooltip content when trigger is set to 'item'.
* @deprecated Use slots.itemContent instead
*/
itemContent: PropTypes.elementType,
Expand Down
2 changes: 1 addition & 1 deletion packages/x-charts/src/Gauge/Gauge.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Gauge.propTypes = {
*/
height: PropTypes.number,
/**
* The radius between circle center and the begining of the arc.
* The radius between circle center and the beginning of the arc.
* Can be a number (in px) or a string with a percentage such as '50%'.
* The '100%' is the maximal radius that fit into the drawing area.
* @default '80%'
Expand Down
2 changes: 1 addition & 1 deletion packages/x-charts/src/Gauge/GaugeContainer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ GaugeContainer.propTypes = {
*/
height: PropTypes.number,
/**
* The radius between circle center and the begining of the arc.
* The radius between circle center and the beginning of the arc.
* Can be a number (in px) or a string with a percentage such as '50%'.
* The '100%' is the maximal radius that fit into the drawing area.
* @default '80%'
Expand Down
Loading

0 comments on commit f1114f0

Please sign in to comment.