Skip to content

Commit 959890b

Browse files
author
ckifer
committed
fix: reword x/yAxisId for Grid
1 parent e11d6d0 commit 959890b

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

src/docs/api/CartesianGrid.ts

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -165,19 +165,21 @@ export default {
165165
defaultVal: 0,
166166
isOptional: true,
167167
desc: {
168-
'en-US': 'The id of x-axis which you would like to add grid lines for. Required if xAxisId is set on XAxis.',
168+
'en-US': `The id of x-axis which you would like to add grid lines for. Must match if xAxisId is set on
169+
XAxis or a graphical component .`,
169170
},
170-
format: ['<CartesianGrid xAxisId="top" />', '<XAxis xAxisId="top" />'],
171+
format: ['<CartesianGrid xAxisId="top" />', '<XAxis xAxisId="top" />', '<Bar dataKey="temp" xAxisId="top" />'],
171172
},
172173
{
173174
name: 'yAxisId',
174175
type: 'String | Number',
175176
defaultVal: 0,
176177
isOptional: true,
177178
desc: {
178-
'en-US': 'The id of y-axis which you would like to add grid lines for. Required if yAxisId is set on YAxis.',
179+
'en-US': `The id of y-axis which you would like to add grid lines for. Must match if yAxisId is set on
180+
YAxis or a graphical component.`,
179181
},
180-
format: ['<CartesianGrid yAxisId="left" />', '<XAxis yAxisId="left" />'],
182+
format: ['<CartesianGrid yAxisId="left" />', '<YAxis yAxisId="left" />', '<Bar dataKey="temp" yAxisId="left" />'],
181183
},
182184
],
183185
parentComponents: ['AreaChart', 'BarChart', 'LineChart', 'ComposedChart', 'ScatterChart'],

0 commit comments

Comments
 (0)