Skip to content

Commit 5c9876d

Browse files
authored
chore: Edits to api docs (#54)
1 parent 8fea316 commit 5c9876d

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -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\` (optional, ReactNode) - Content displayed when the chart data is empty.
239+
* \`noMatch\` (optional, ReactNode) - Content displayed when there is no data to display due to the built-in filtering.
240+
* \`loading\` (optional, ReactNode) - 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, ReactNode) - 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
@@ -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\` (optional, ReactNode) - Content displayed when the chart data is empty.
763+
* \`noMatch\` (optional, ReactNode) - Content displayed when there is no data to display due to the built-in filtering.
764+
* \`loading\` (optional, ReactNode) - 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, ReactNode) - 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

src/core/interfaces.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -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` (optional, ReactNode) - Content displayed when the chart data is empty.
77+
* * `noMatch` (optional, ReactNode) - Content displayed when there is no data to display due to the built-in filtering.
78+
* * `loading` (optional, ReactNode) - 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, ReactNode) - 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

0 commit comments

Comments
 (0)