chore: Minor changes to the i18n APIs (#56)

* chore: Minor changes to the i18n APIs

* minor api description change

Author: pan-kot

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

@@ -133,7 +133,7 @@ Supported Highcharts versions: 12.",
         "name": "CartesianI18nStrings",
         "properties": [
           {
-            "name": "chartAccessibleDescription",
+            "name": "chartRoleDescription",
             "optional": true,
             "type": "string",
           },
@@ -178,12 +178,12 @@ Supported Highcharts versions: 12.",
             "type": "string",
           },
           {
-            "name": "xAxisAccessibleDescription",
+            "name": "xAxisRoleDescription",
             "optional": true,
             "type": "string",
           },
           {
-            "name": "yAxisAccessibleDescription",
+            "name": "yAxisRoleDescription",
             "optional": true,
             "type": "string",
           },
@@ -313,7 +313,7 @@ This property corresponds to "normal" stacking type in Highcharts ([plotOptions.
     },
     {
       "description": "Defines tooltip options of the chart, including:
-* \`enabled\` - (optional, boolean) - Hides the tooltip.
+* \`enabled\` - (optional, boolean) - Hides the tooltip when set to false.
 * \`size\` - (optional, "small" | "medium" | "large") - Specifies max tooltip size.
 * \`placement\` - (optional, "middle" | "outside") - Specifies preferred tooltip placement.
 * \`point\` - (optional, function) - Customizes tooltip series point rendering.
@@ -658,7 +658,7 @@ Supported Highcharts versions: 12.",
         "name": "PieI18nStrings",
         "properties": [
           {
-            "name": "chartAccessibleDescription",
+            "name": "chartRoleDescription",
             "optional": true,
             "type": "string",
           },
@@ -688,7 +688,7 @@ Supported Highcharts versions: 12.",
             "type": "string",
           },
           {
-            "name": "segmentAccessibleDescription",
+            "name": "segmentRoleDescription",
             "optional": true,
             "type": "string",
           },
@@ -866,7 +866,7 @@ Supported series types:
     },
     {
       "description": "Defines tooltip options of the chart, including:
-* \`enabled\` - (optional, boolean) - Hides the tooltip.
+* \`enabled\` - (optional, boolean) - Hides the tooltip when set to false.
 * \`size\` - (optional, "small" | "medium" | "large") - Specifies max tooltip size.
 * \`details\` - (optional, function) - Provides a list of key-value pairs as tooltip's body.
 * \`header\` - (optional, function) - Renders a custom tooltip header.

src/cartesian-chart/interfaces.ts

@@ -43,7 +43,7 @@ export interface CartesianChartProps
 
   /**
    * Defines tooltip options of the chart, including:
-   * * `enabled` - (optional, boolean) - Hides the tooltip.
+   * * `enabled` - (optional, boolean) - Hides the tooltip when set to false.
    * * `size` - (optional, "small" | "medium" | "large") - Specifies max tooltip size.
    * * `placement` - (optional, "middle" | "outside") - Specifies preferred tooltip placement.
    * * `point` - (optional, function) - Customizes tooltip series point rendering.

src/core/i18n-utils.tsx

@@ -30,9 +30,9 @@ export function useChartI18n({
     chartDescription: ariaDescription,
     // We reuse existing translations as passing for now, but it is possible to introduce new i18n strings that
     // are parametrized with axes names, and more.
-    chartContainerLabel: i18n("i18nStrings.chartAriaRoleDescription", i18nStrings?.chartAccessibleDescription),
-    chartXAxisLabel: i18n("i18nStrings.xAxisAriaRoleDescription", i18nStrings?.xAxisAccessibleDescription),
-    chartYAxisLabel: i18n("i18nStrings.yAxisAriaRoleDescription", i18nStrings?.yAxisAccessibleDescription),
-    chartSegmentLabel: i18nPie("i18nStrings.segmentAriaRoleDescription", i18nStrings?.segmentAccessibleDescription),
+    chartContainerLabel: i18n("i18nStrings.chartAriaRoleDescription", i18nStrings?.chartRoleDescription),
+    chartXAxisLabel: i18n("i18nStrings.xAxisAriaRoleDescription", i18nStrings?.xAxisRoleDescription),
+    chartYAxisLabel: i18n("i18nStrings.yAxisAriaRoleDescription", i18nStrings?.yAxisRoleDescription),
+    chartSegmentLabel: i18nPie("i18nStrings.segmentAriaRoleDescription", i18nStrings?.segmentRoleDescription),
   };
 }

src/core/interfaces.ts

@@ -117,7 +117,7 @@ export interface BaseI18nStrings {
   seriesFilterSelectedAriaLabel?: string;
   legendAriaLabel?: string;
   detailPopoverDismissAriaLabel?: string;
-  chartAccessibleDescription?: string;
+  chartRoleDescription?: string;
 }
 
 export interface WithCartesianI18nStrings {
@@ -134,9 +134,9 @@ export interface WithCartesianI18nStrings {
    * * `seriesFilterSelectedAriaLabel` (optional, string) - ARIA label of the default series filter which is appended to any option that is selected.
    * * `legendAriaLabel` (optional, string) - ARIA label that is associated with the legend in case there is no visible `legend.title` defined.
    * * `detailPopoverDismissAriaLabel` (optional, string) - ARIA label for the details popover dismiss button.
-   * * `chartAccessibleDescription` (optional, string) - Accessible description of the chart plot area, e.g. "interactive chart".
-   * * `xAxisAccessibleDescription` (optional, string) - Accessible description of the x axis, e.g. "x axis".
-   * * `yAxisAccessibleDescription` (optional, string) - Accessible description of the y axis, e.g. "y axis".
+   * * `chartRoleDescription` (optional, string) - Accessible role description of the chart plot area, e.g. "interactive chart".
+   * * `xAxisRoleDescription` (optional, string) - Accessible role description of the x axis, e.g. "x axis".
+   * * `yAxisRoleDescription` (optional, string) - Accessible role description of the y axis, e.g. "y axis".
    */
   i18nStrings?: CartesianI18nStrings;
 }
@@ -155,19 +155,19 @@ export interface WithPieI18nStrings {
    * * `seriesFilterSelectedAriaLabel` (optional, string) - ARIA label of the default series filter which is appended to any option that is selected.
    * * `legendAriaLabel` (optional, string) - ARIA label that is associated with the legend in case there is no visible `legend.title` defined.
    * * `detailPopoverDismissAriaLabel` (optional, string) - ARIA label for the details popover dismiss button.
-   * * `chartAccessibleDescription` (optional, string) - Accessible description of the chart plot area, e.g. "interactive chart".
-   * * `segmentAccessibleDescription` (optional, string) - Accessible description of the segment.
+   * * `chartRoleDescription` (optional, string) - Accessible role description of the chart plot area, e.g. "interactive chart".
+   * * `segmentRoleDescription` (optional, string) - Accessible role description of the segment.
    */
   i18nStrings?: PieI18nStrings;
 }
 
 export interface CartesianI18nStrings extends BaseI18nStrings {
-  xAxisAccessibleDescription?: string;
-  yAxisAccessibleDescription?: string;
+  xAxisRoleDescription?: string;
+  yAxisRoleDescription?: string;
 }
 
 export interface PieI18nStrings extends BaseI18nStrings {
-  segmentAccessibleDescription?: string;
+  segmentRoleDescription?: string;
 }
 
 export interface BaseFilterOptions {

src/pie-chart/interfaces.ts

@@ -21,7 +21,7 @@ export interface PieChartProps extends CoreTypes.BaseChartOptions, CoreTypes.Wit
 
   /**
    * Defines tooltip options of the chart, including:
-   * * `enabled` - (optional, boolean) - Hides the tooltip.
+   * * `enabled` - (optional, boolean) - Hides the tooltip when set to false.
    * * `size` - (optional, "small" | "medium" | "large") - Specifies max tooltip size.
    * * `details` - (optional, function) - Provides a list of key-value pairs as tooltip's body.
    * * `header` - (optional, function) - Renders a custom tooltip header.