Skip to content

Commit 6ad075e

Browse files
committed
resolved pr feedback
1 parent 4cfdd6c commit 6ad075e

File tree

2 files changed

+24
-24
lines changed

2 files changed

+24
-24
lines changed

src/__tests__/__snapshots__/documenter.test.ts.snap

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ minimum width, the horizontal scrollbar is automatically added.",
120120
"type": "boolean",
121121
},
122122
{
123-
"description": "The Highcharts instance, that can be obtained using \`import Highcharts from "highcharts"\`.
123+
"description": "The Highcharts instance, which can be obtained using \`import Highcharts from "highcharts"\`.
124124
Supported Highcharts versions: 12.",
125125
"name": "highcharts",
126126
"optional": false,
@@ -235,11 +235,11 @@ This property corresponds to [chart.inverted](https://api.highcharts.com/highcha
235235
{
236236
"description": "Defines options to represent empty, no-match, loading, and error state of the chart, including:
237237
* \`statusType\` (optional, "finished" | "loading" | "error") - Specifies the current status of loading data.
238-
* \`empty\` (slot) - Content, displayed when the chart data is empty.
239-
* \`no-match\` (slot) - Content, displayed when there is no data to display due to the built-in filtering.
240-
* \`loading\` (optional, slot) - Content, displayed when \`statusType="loading"\`. If omitted, the default loading state
238+
* \`empty\` (slot) - Content displayed when the chart data is empty.
239+
* \`no-match\` (slot) - Content displayed when there is no data to display due to the built-in filtering.
240+
* \`loading\` (optional, slot) - Content displayed when \`statusType="loading"\`. If omitted, the default loading state
241241
is shown, using \`i18n.loadingText\` or built-in i18n.
242-
* \`error\` (optional, slot) - Content, displayed when \`statusType="error"\`. If omitted, the default error state
242+
* \`error\` (optional, slot) - Content displayed when \`statusType="error"\`. If omitted, the default error state
243243
is shown, using \`i18n.errorText\` and \`i18n.recoveryText\` (when \`onRecoveryClick\` is provided), or built-in i18n.
244244
* \`onRecoveryClick\` (optional, function) - Called when the user clicks the recovery button that appears when using default error
245245
state, and only if \`onRecoveryClick\` is provided. Use this to enable the user to retry a failed request or provide another option
@@ -523,7 +523,7 @@ applies to the tooltip points values.",
523523
],
524524
"regions": [
525525
{
526-
"description": "Custom content that renders when \`highcharts\` is null. It renders a spinner if not defined.",
526+
"description": "Custom content that renders when \`highcharts=null\`. It renders a spinner if not defined.",
527527
"isDefault": false,
528528
"name": "fallback",
529529
},
@@ -645,7 +645,7 @@ minimum width, the horizontal scrollbar is automatically added.",
645645
"type": "boolean",
646646
},
647647
{
648-
"description": "The Highcharts instance, that can be obtained using \`import Highcharts from "highcharts"\`.
648+
"description": "The Highcharts instance, which can be obtained using \`import Highcharts from "highcharts"\`.
649649
Supported Highcharts versions: 12.",
650650
"name": "highcharts",
651651
"optional": false,
@@ -759,11 +759,11 @@ Supported Highcharts versions: 12.",
759759
{
760760
"description": "Defines options to represent empty, no-match, loading, and error state of the chart, including:
761761
* \`statusType\` (optional, "finished" | "loading" | "error") - Specifies the current status of loading data.
762-
* \`empty\` (slot) - Content, displayed when the chart data is empty.
763-
* \`no-match\` (slot) - Content, displayed when there is no data to display due to the built-in filtering.
764-
* \`loading\` (optional, slot) - Content, displayed when \`statusType="loading"\`. If omitted, the default loading state
762+
* \`empty\` (slot) - Content displayed when the chart data is empty.
763+
* \`no-match\` (slot) - Content displayed when there is no data to display due to the built-in filtering.
764+
* \`loading\` (optional, slot) - Content displayed when \`statusType="loading"\`. If omitted, the default loading state
765765
is shown, using \`i18n.loadingText\` or built-in i18n.
766-
* \`error\` (optional, slot) - Content, displayed when \`statusType="error"\`. If omitted, the default error state
766+
* \`error\` (optional, slot) - Content displayed when \`statusType="error"\`. If omitted, the default error state
767767
is shown, using \`i18n.errorText\` and \`i18n.recoveryText\` (when \`onRecoveryClick\` is provided), or built-in i18n.
768768
* \`onRecoveryClick\` (optional, function) - Called when the user clicks the recovery button that appears when using default error
769769
state, and only if \`onRecoveryClick\` is provided. Use this to enable the user to retry a failed request or provide another option
@@ -922,7 +922,7 @@ If a segment doesn't have an ID, its name is used. When using this property, man
922922
],
923923
"regions": [
924924
{
925-
"description": "Custom content that renders when \`highcharts\` is null. It renders a spinner if not defined.",
925+
"description": "Custom content that renders when \`highcharts=null\`. It renders a spinner if not defined.",
926926
"isDefault": false,
927927
"name": "fallback",
928928
},

src/core/interfaces.ts

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ import { NonCancelableEventHandler } from "../internal/events";
1515
*/
1616
export interface BaseChartOptions {
1717
/**
18-
* The Highcharts instance, that can be obtained using `import Highcharts from "highcharts"`.
18+
* The Highcharts instance, which can be obtained using `import Highcharts from "highcharts"`.
1919
* Supported Highcharts versions: 12.
2020
*/
2121
highcharts: null | object;
2222

2323
/**
24-
* Custom content that renders when `highcharts` is null. It renders a spinner if not defined.
24+
* Custom content that renders when `highcharts=null`. It renders a spinner if not defined.
2525
*/
2626
fallback?: React.ReactNode;
2727

@@ -73,11 +73,11 @@ export interface BaseChartOptions {
7373
/**
7474
* Defines options to represent empty, no-match, loading, and error state of the chart, including:
7575
* * `statusType` (optional, "finished" | "loading" | "error") - Specifies the current status of loading data.
76-
* * `empty` (slot) - Content, displayed when the chart data is empty.
77-
* * `no-match` (slot) - Content, displayed when there is no data to display due to the built-in filtering.
78-
* * `loading` (optional, slot) - Content, displayed when `statusType="loading"`. If omitted, the default loading state
76+
* * `empty` (slot) - Content displayed when the chart data is empty.
77+
* * `no-match` (slot) - Content displayed when there is no data to display due to the built-in filtering.
78+
* * `loading` (optional, slot) - Content displayed when `statusType="loading"`. If omitted, the default loading state
7979
* is shown, using `i18n.loadingText` or built-in i18n.
80-
* * `error` (optional, slot) - Content, displayed when `statusType="error"`. If omitted, the default error state
80+
* * `error` (optional, slot) - Content displayed when `statusType="error"`. If omitted, the default error state
8181
* is shown, using `i18n.errorText` and `i18n.recoveryText` (when `onRecoveryClick` is provided), or built-in i18n.
8282
* * `onRecoveryClick` (optional, function) - Called when the user clicks the recovery button that appears when using default error
8383
* state, and only if `onRecoveryClick` is provided. Use this to enable the user to retry a failed request or provide another option
@@ -126,14 +126,14 @@ export interface WithCartesianI18nStrings {
126126
* @i18n
127127
*
128128
* Available properties:
129-
* * `loadingText` (optional, string) - Text, displayed when the chart is loading, i.e. when `noData.statusType` is set to `"loading".
130-
* * `errorText` (optional, string) - Text, displayed when the chart is in error state, i.e. when `noData.statusType` is set to `"error".
129+
* * `loadingText` (optional, string) - Text, displayed when the chart is loading, i.e. when `noData.statusType` is set to "loading".
130+
* * `errorText` (optional, string) - Text, displayed when the chart is in error state, i.e. when `noData.statusType` is set to "error".
131131
* * `recoveryText` (optional, string) - Text for the recovery button, displayed next to the error text.
132132
* * `seriesFilterLabel` (optional, string) - Text for the visible label of the default series filter.
133133
* * `seriesFilterPlaceholder` (optional, string) - Text for the default series filter placeholder.
134134
* * `seriesFilterSelectedAriaLabel` (optional, string) - ARIA label of the default series filter which is appended to any option that is selected.
135135
* * `legendAriaLabel` (optional, string) - ARIA label that is associated with the legend in case there is no visible `legend.title` defined.
136-
* * `detailPopoverDismissAriaLabel` (optional, string) - ARIA label for details popover dismiss button.
136+
* * `detailPopoverDismissAriaLabel` (optional, string) - ARIA label for the details popover dismiss button.
137137
* * `chartAccessibleDescription` (optional, string) - Accessible description of the chart plot area, e.g. "interactive chart".
138138
* * `xAxisAccessibleDescription` (optional, string) - Accessible description of the x axis, e.g. "x axis".
139139
* * `yAxisAccessibleDescription` (optional, string) - Accessible description of the y axis, e.g. "y axis".
@@ -147,14 +147,14 @@ export interface WithPieI18nStrings {
147147
* @i18n
148148
*
149149
* Available properties:
150-
* * `loadingText` (optional, string) - Text, displayed when the chart is loading, i.e. when `noData.statusType` is set to `"loading".
151-
* * `errorText` (optional, string) - Text, displayed when the chart is in error state, i.e. when `noData.statusType` is set to `"error".
150+
* * `loadingText` (optional, string) - Text, displayed when the chart is loading, i.e. when `noData.statusType` is set to "loading".
151+
* * `errorText` (optional, string) - Text, displayed when the chart is in error state, i.e. when `noData.statusType` is set to "error".
152152
* * `recoveryText` (optional, string) - Text for the recovery button, displayed next to the error text.
153153
* * `seriesFilterLabel` (optional, string) - Text for the visible label of the default series filter.
154154
* * `seriesFilterPlaceholder` (optional, string) - Text for the default series filter placeholder.
155155
* * `seriesFilterSelectedAriaLabel` (optional, string) - ARIA label of the default series filter which is appended to any option that is selected.
156156
* * `legendAriaLabel` (optional, string) - ARIA label that is associated with the legend in case there is no visible `legend.title` defined.
157-
* * `detailPopoverDismissAriaLabel` (optional, string) - ARIA label for details popover dismiss button.
157+
* * `detailPopoverDismissAriaLabel` (optional, string) - ARIA label for the details popover dismiss button.
158158
* * `chartAccessibleDescription` (optional, string) - Accessible description of the chart plot area, e.g. "interactive chart".
159159
* * `segmentAccessibleDescription` (optional, string) - Accessible description of the segment.
160160
*/

0 commit comments

Comments
 (0)