@gitlab/ui 134.9.0 → 135.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (107) hide show
  1. package/dist/components/base/accordion/accordion_item.js +1 -1
  2. package/dist/components/base/animated_icon/base_animated_icon.js +3 -0
  3. package/dist/components/base/color_mode_toggle/color_mode_toggle.js +11 -1
  4. package/dist/components/base/filtered_search/filtered_search.js +9 -0
  5. package/dist/components/base/filtered_search/filtered_search_suggestion.js +3 -0
  6. package/dist/components/base/filtered_search/filtered_search_term.js +9 -0
  7. package/dist/components/base/filtered_search/filtered_search_token.js +15 -0
  8. package/dist/components/base/filtered_search/filtered_search_token_segment.js +27 -0
  9. package/dist/components/base/form/form_combobox/form_combobox.js +18 -0
  10. package/dist/components/base/form/form_date/form_date.js +18 -0
  11. package/dist/components/base/form/form_fields/form_field_validator.js +9 -0
  12. package/dist/components/base/form/form_fields/form_fields_loop.js +3 -0
  13. package/dist/components/base/markdown/markdown.js +3 -0
  14. package/dist/components/base/new_dropdowns/base_dropdown/base_dropdown.js +54 -0
  15. package/dist/components/base/new_dropdowns/disclosure/disclosure_dropdown_item.js +3 -0
  16. package/dist/components/base/new_dropdowns/listbox/listbox.js +3 -0
  17. package/dist/components/base/new_dropdowns/listbox/listbox_group.js +6 -0
  18. package/dist/components/base/new_dropdowns/listbox/listbox_item.js +15 -0
  19. package/dist/components/base/search_box_by_click/search_box_by_click.js +6 -0
  20. package/dist/components/base/segmented_control/segmented_control.js +6 -0
  21. package/dist/components/base/table_lite/table_lite.js +9 -0
  22. package/dist/components/base/tabs/tab/tab.js +3 -0
  23. package/dist/components/base/tabs/tabs/tabs.js +21 -0
  24. package/dist/components/base/toast/toast.js +12 -0
  25. package/dist/components/base/toggle/toggle.js +3 -0
  26. package/dist/components/base/token_selector/token_container.js +12 -0
  27. package/dist/components/base/token_selector/token_selector_dropdown.js +27 -0
  28. package/dist/components/charts/area/area.js +36 -0
  29. package/dist/components/charts/bar/bar.js +15 -0
  30. package/dist/components/charts/chart/chart.js +7 -1
  31. package/dist/components/charts/column/column.js +24 -0
  32. package/dist/components/charts/discrete_scatter/discrete_scatter.js +21 -0
  33. package/dist/components/charts/gauge/gauge.js +21 -0
  34. package/dist/components/charts/heatmap/heatmap.js +33 -0
  35. package/dist/components/charts/legend/legend.js +15 -0
  36. package/dist/components/charts/line/line.js +33 -0
  37. package/dist/components/charts/series_label/series_label.js +6 -0
  38. package/dist/components/charts/shared/tooltip/tooltip.js +6 -0
  39. package/dist/components/charts/shared/tooltip/tooltip_default_format/tooltip_default_format.js +3 -0
  40. package/dist/components/charts/single_stat/single_stat.js +30 -0
  41. package/dist/components/charts/stacked_column/stacked_column.js +55 -0
  42. package/dist/components/regions/empty_state/empty_state.js +3 -0
  43. package/dist/components/shared_components/clear_icon_button/clear_icon_button.js +6 -0
  44. package/dist/components/shared_components/close_button/close_button.js +3 -0
  45. package/dist/components/utilities/animated_number/animated_number.js +9 -0
  46. package/dist/components/utilities/intersperse/intersperse.js +6 -0
  47. package/dist/index.css +1 -1
  48. package/dist/index.css.map +1 -1
  49. package/dist/tailwind.css +1 -1
  50. package/dist/tailwind.css.map +1 -1
  51. package/dist/tokens/tokens_story.js +3 -0
  52. package/package.json +4 -3
  53. package/src/components/base/accordion/accordion_item.vue +6 -3
  54. package/src/components/base/animated_icon/base_animated_icon.vue +3 -0
  55. package/src/components/base/color_mode_toggle/color_mode_toggle.vue +11 -0
  56. package/src/components/base/filtered_search/filtered_search.vue +9 -0
  57. package/src/components/base/filtered_search/filtered_search_suggestion.vue +3 -0
  58. package/src/components/base/filtered_search/filtered_search_term.vue +9 -0
  59. package/src/components/base/filtered_search/filtered_search_token.vue +15 -0
  60. package/src/components/base/filtered_search/filtered_search_token_segment.vue +27 -0
  61. package/src/components/base/form/form_combobox/form_combobox.vue +18 -0
  62. package/src/components/base/form/form_date/form_date.vue +18 -0
  63. package/src/components/base/form/form_fields/form_field_validator.vue +9 -0
  64. package/src/components/base/form/form_fields/form_fields_loop.vue +3 -0
  65. package/src/components/base/icon/icon.figma.batch.ts +26 -0
  66. package/src/components/base/markdown/markdown.vue +3 -0
  67. package/src/components/base/new_dropdowns/base_dropdown/base_dropdown.vue +54 -0
  68. package/src/components/base/new_dropdowns/disclosure/disclosure_dropdown_item.vue +3 -0
  69. package/src/components/base/new_dropdowns/listbox/listbox.vue +3 -0
  70. package/src/components/base/new_dropdowns/listbox/listbox_group.vue +6 -0
  71. package/src/components/base/new_dropdowns/listbox/listbox_item.vue +15 -0
  72. package/src/components/base/pagination/pagination.scss +1 -0
  73. package/src/components/base/search_box_by_click/search_box_by_click.vue +6 -0
  74. package/src/components/base/segmented_control/segmented_control.vue +6 -0
  75. package/src/components/base/table_lite/table_lite.vue +9 -0
  76. package/src/components/base/tabs/tab/tab.vue +3 -0
  77. package/src/components/base/tabs/tabs/tabs.vue +21 -0
  78. package/src/components/base/toast/toast.vue +12 -0
  79. package/src/components/base/toggle/toggle.vue +3 -0
  80. package/src/components/base/token_selector/token_container.vue +12 -0
  81. package/src/components/base/token_selector/token_selector_dropdown.vue +27 -0
  82. package/src/components/charts/area/area.vue +36 -0
  83. package/src/components/charts/bar/bar.vue +15 -0
  84. package/src/components/charts/chart/chart.vue +7 -1
  85. package/src/components/charts/column/column.vue +24 -0
  86. package/src/components/charts/discrete_scatter/discrete_scatter.vue +21 -0
  87. package/src/components/charts/gauge/gauge.vue +21 -0
  88. package/src/components/charts/heatmap/heatmap.vue +33 -0
  89. package/src/components/charts/legend/legend.vue +15 -0
  90. package/src/components/charts/line/line.vue +33 -0
  91. package/src/components/charts/series_label/series_label.vue +6 -0
  92. package/src/components/charts/shared/tooltip/tooltip.vue +6 -0
  93. package/src/components/charts/shared/tooltip/tooltip_default_format/tooltip_default_format.vue +3 -0
  94. package/src/components/charts/single_stat/single_stat.vue +30 -0
  95. package/src/components/charts/stacked_column/stacked_column.vue +55 -0
  96. package/src/components/regions/empty_state/empty_state.vue +3 -0
  97. package/src/components/shared_components/clear_icon_button/clear_icon_button.vue +6 -0
  98. package/src/components/shared_components/close_button/close_button.vue +3 -0
  99. package/src/components/utilities/animated_number/animated_number.vue +9 -0
  100. package/src/components/utilities/intersperse/intersperse.vue +6 -0
  101. package/src/tokens/build/figma/mode.dark.json +35 -18
  102. package/src/tokens/build/figma/mode.json +35 -18
  103. package/src/tokens/build/json/tokens.dark.json +70 -36
  104. package/src/tokens/build/json/tokens.json +70 -36
  105. package/src/tokens/contextual/toggle.tokens.json +34 -17
  106. package/src/tokens/semantic/highlight.tokens.json +1 -1
  107. package/src/tokens/tokens_story.vue +3 -0
@@ -9,6 +9,9 @@ var script = {
9
9
  },
10
10
  inheritAttrs: false,
11
11
  props: {
12
+ /**
13
+ * Additional CSS classes to apply to the table element.
14
+ */
12
15
  tableClass,
13
16
  /**
14
17
  * Array of items displayed in the table as rows.
@@ -18,11 +21,17 @@ var script = {
18
21
  required: false,
19
22
  default: () => []
20
23
  },
24
+ /**
25
+ * Array of field definitions for table columns.
26
+ */
21
27
  fields: {
22
28
  type: Array,
23
29
  required: false,
24
30
  default: null
25
31
  },
32
+ /**
33
+ * When true, makes the table header sticky.
34
+ */
26
35
  stickyHeader: {
27
36
  type: Boolean,
28
37
  default: false,
@@ -13,6 +13,9 @@ var script = {
13
13
  },
14
14
  inheritAttrs: false,
15
15
  props: {
16
+ /**
17
+ * Additional CSS classes to apply to the tab title link.
18
+ */
16
19
  titleLinkClass: {
17
20
  type: [String, Array, Object],
18
21
  required: false,
@@ -12,34 +12,52 @@ var script = {
12
12
  },
13
13
  inheritAttrs: false,
14
14
  props: {
15
+ /**
16
+ * Configuration for the primary action button in the tabs.
17
+ */
15
18
  actionPrimary: {
16
19
  type: Object,
17
20
  required: false,
18
21
  default: null,
19
22
  validator: obj => validatorHelper(obj)
20
23
  },
24
+ /**
25
+ * Configuration for the secondary action button in the tabs.
26
+ */
21
27
  actionSecondary: {
22
28
  type: Object,
23
29
  required: false,
24
30
  default: null,
25
31
  validator: obj => validatorHelper(obj)
26
32
  },
33
+ /**
34
+ * Configuration for the tertiary action button in the tabs.
35
+ */
27
36
  actionTertiary: {
28
37
  type: Object,
29
38
  required: false,
30
39
  default: null,
31
40
  validator: obj => validatorHelper(obj)
32
41
  },
42
+ /**
43
+ * Additional CSS classes to apply to the tab content area.
44
+ */
33
45
  contentClass: {
34
46
  type: [String, Array, Object],
35
47
  required: false,
36
48
  default: null
37
49
  },
50
+ /**
51
+ * Additional CSS classes to apply to the tab navigation.
52
+ */
38
53
  navClass: {
39
54
  type: [String, Array, Object],
40
55
  required: false,
41
56
  default: null
42
57
  },
58
+ /**
59
+ * When true, makes the tabs stretch to fill the available width.
60
+ */
43
61
  justified: {
44
62
  type: Boolean,
45
63
  required: false,
@@ -61,6 +79,9 @@ var script = {
61
79
  required: false,
62
80
  default: 'tab'
63
81
  },
82
+ /**
83
+ * The currently active tab value.
84
+ */
64
85
  value: {
65
86
  type: Number,
66
87
  required: false,
@@ -10,19 +10,31 @@ var script = {
10
10
  CloseButton
11
11
  },
12
12
  props: {
13
+ /**
14
+ * Unique identifier for the toast notification.
15
+ */
13
16
  toastId: {
14
17
  type: String,
15
18
  required: true
16
19
  },
20
+ /**
21
+ * The message text to display in the toast.
22
+ */
17
23
  message: {
18
24
  type: String,
19
25
  required: true
20
26
  },
27
+ /**
28
+ * Action button configuration for the toast.
29
+ */
21
30
  action: {
22
31
  type: Object,
23
32
  required: false,
24
33
  default: null
25
34
  },
35
+ /**
36
+ * Delay in milliseconds before auto-hiding the toast.
37
+ */
26
38
  autoHideDelay: {
27
39
  type: Number,
28
40
  required: false,
@@ -16,6 +16,9 @@ var script = {
16
16
  event: 'change'
17
17
  },
18
18
  props: {
19
+ /**
20
+ * The name attribute for the hidden input element.
21
+ */
19
22
  name: {
20
23
  type: String,
21
24
  required: false,
@@ -10,21 +10,33 @@ var script = {
10
10
  GlButton
11
11
  },
12
12
  props: {
13
+ /**
14
+ * Array of token objects to display.
15
+ */
13
16
  tokens: {
14
17
  type: Array,
15
18
  // All tokens need to have an `id` key
16
19
  validator: tokensValidator,
17
20
  required: true
18
21
  },
22
+ /**
23
+ * Function to register focus handling on tokens.
24
+ */
19
25
  registerFocusOnToken: {
20
26
  type: Function,
21
27
  required: true
22
28
  },
29
+ /**
30
+ * When true, renders tokens in a non-interactive view-only mode.
31
+ */
23
32
  viewOnly: {
24
33
  type: Boolean,
25
34
  required: false,
26
35
  default: false
27
36
  },
37
+ /**
38
+ * When true, shows a button to clear all tokens.
39
+ */
28
40
  showClearAllButton: {
29
41
  type: Boolean,
30
42
  required: false,
@@ -9,42 +9,69 @@ var script = {
9
9
  GlDropdownItem
10
10
  },
11
11
  props: {
12
+ /**
13
+ * When true, shows the dropdown.
14
+ */
12
15
  show: {
13
16
  type: Boolean,
14
17
  required: true
15
18
  },
19
+ /**
20
+ * Additional CSS classes for the dropdown menu.
21
+ */
16
22
  menuClass: {
17
23
  type: [String, Array, Object],
18
24
  required: false,
19
25
  default: ''
20
26
  },
27
+ /**
28
+ * When true, shows a loading state in the dropdown.
29
+ */
21
30
  loading: {
22
31
  type: Boolean,
23
32
  required: false,
24
33
  default: false
25
34
  },
35
+ /**
36
+ * Array of items to display in the dropdown.
37
+ */
26
38
  dropdownItems: {
27
39
  type: Array,
28
40
  // All items need to have an `id` key
29
41
  validator: tokensValidator,
30
42
  required: true
31
43
  },
44
+ /**
45
+ * Current text in the search input.
46
+ */
32
47
  inputText: {
33
48
  type: String,
34
49
  required: true
35
50
  },
51
+ /**
52
+ * When true, allows user-defined tokens to be added.
53
+ */
36
54
  userDefinedTokenCanBeAdded: {
37
55
  type: Boolean,
38
56
  required: true
39
57
  },
58
+ /**
59
+ * Unique identifier for the component.
60
+ */
40
61
  componentId: {
41
62
  type: String,
42
63
  required: true
43
64
  },
65
+ /**
66
+ * Function to register event handlers for the dropdown.
67
+ */
44
68
  registerDropdownEventHandlers: {
45
69
  type: Function,
46
70
  required: true
47
71
  },
72
+ /**
73
+ * Function to register reset of focused dropdown item.
74
+ */
48
75
  registerResetFocusedDropdownItem: {
49
76
  type: Function,
50
77
  required: true
@@ -33,30 +33,48 @@ var script = {
33
33
  },
34
34
  inheritAttrs: false,
35
35
  props: {
36
+ /**
37
+ * The chart data series to render.
38
+ */
36
39
  data: {
37
40
  type: Array,
38
41
  required: true
39
42
  },
43
+ /**
44
+ * Additional ECharts option overrides.
45
+ */
40
46
  option: {
41
47
  type: Object,
42
48
  required: false,
43
49
  default: () => ({})
44
50
  },
51
+ /**
52
+ * Array of threshold line configurations.
53
+ */
45
54
  thresholds: {
46
55
  type: Array,
47
56
  required: false,
48
57
  default: () => []
49
58
  },
59
+ /**
60
+ * Array of annotation configurations.
61
+ */
50
62
  annotations: {
51
63
  type: Array,
52
64
  required: false,
53
65
  default: () => []
54
66
  },
67
+ /**
68
+ * When true, includes average and maximum values in the legend.
69
+ */
55
70
  includeLegendAvgMax: {
56
71
  type: Boolean,
57
72
  required: false,
58
73
  default: true
59
74
  },
75
+ /**
76
+ * Custom function to format annotation tooltip text.
77
+ */
60
78
  formatAnnotationsTooltipText: {
61
79
  type: Function,
62
80
  required: false,
@@ -73,26 +91,41 @@ var script = {
73
91
  required: false,
74
92
  default: null
75
93
  },
94
+ /**
95
+ * Custom text for the average value in the legend.
96
+ */
76
97
  legendAverageText: {
77
98
  type: String,
78
99
  required: false,
79
100
  default: LEGEND_AVERAGE_TEXT
80
101
  },
102
+ /**
103
+ * Custom text for the maximum value in the legend.
104
+ */
81
105
  legendMaxText: {
82
106
  type: String,
83
107
  required: false,
84
108
  default: LEGEND_MAX_TEXT
85
109
  },
110
+ /**
111
+ * Custom text for the minimum value in the legend.
112
+ */
86
113
  legendMinText: {
87
114
  type: String,
88
115
  required: false,
89
116
  default: LEGEND_MIN_TEXT
90
117
  },
118
+ /**
119
+ * Custom text for the current value in the legend.
120
+ */
91
121
  legendCurrentText: {
92
122
  type: String,
93
123
  required: false,
94
124
  default: LEGEND_CURRENT_TEXT
95
125
  },
126
+ /**
127
+ * Layout configuration for the legend.
128
+ */
96
129
  legendLayout: {
97
130
  type: String,
98
131
  required: false,
@@ -109,6 +142,9 @@ var script = {
109
142
  required: false,
110
143
  default: null
111
144
  },
145
+ /**
146
+ * Series information for the legend.
147
+ */
112
148
  legendSeriesInfo: {
113
149
  type: Array,
114
150
  required: false,
@@ -62,23 +62,38 @@ var script = {
62
62
  },
63
63
  inheritAttrs: false,
64
64
  props: {
65
+ /**
66
+ * The chart data series to render.
67
+ */
65
68
  data: {
66
69
  type: Object,
67
70
  required: true
68
71
  },
72
+ /**
73
+ * Additional ECharts option overrides.
74
+ */
69
75
  option: {
70
76
  type: Object,
71
77
  required: false,
72
78
  default: () => ({})
73
79
  },
80
+ /**
81
+ * Title text for the Y axis.
82
+ */
74
83
  yAxisTitle: {
75
84
  type: String,
76
85
  required: true
77
86
  },
87
+ /**
88
+ * Title text for the X axis.
89
+ */
78
90
  xAxisTitle: {
79
91
  type: String,
80
92
  required: true
81
93
  },
94
+ /**
95
+ * Type of the X axis (e.g., 'category', 'value').
96
+ */
82
97
  xAxisType: {
83
98
  type: String,
84
99
  required: false,
@@ -25,6 +25,9 @@ var script = {
25
25
  type: Object,
26
26
  required: true
27
27
  },
28
+ /**
29
+ * Width of the chart in pixels. Set to "auto" to use the width of the container.
30
+ */
28
31
  width: {
29
32
  type: [Number, String],
30
33
  required: false,
@@ -32,7 +35,7 @@ var script = {
32
35
  validator: sizeValidator
33
36
  },
34
37
  /**
35
- * Sets the chart's height in pixels. Set to `"auto"` to use the height of the container.
38
+ * Height of the chart in pixels. Set to "auto" to use the height of the container.
36
39
  */
37
40
  height: {
38
41
  type: [Number, String],
@@ -61,6 +64,9 @@ var script = {
61
64
  return validRenderers.includes(renderer);
62
65
  }
63
66
  },
67
+ /**
68
+ * When true, the chart automatically resizes to fit its container.
69
+ */
64
70
  responsive: {
65
71
  type: Boolean,
66
72
  required: false,
@@ -21,39 +21,63 @@ var script = {
21
21
  },
22
22
  inheritAttrs: false,
23
23
  props: {
24
+ /**
25
+ * Array of bar series data.
26
+ */
24
27
  bars: {
25
28
  type: Array,
26
29
  required: false,
27
30
  default: () => []
28
31
  },
32
+ /**
33
+ * Array of line series data.
34
+ */
29
35
  lines: {
30
36
  type: Array,
31
37
  required: false,
32
38
  default: () => []
33
39
  },
40
+ /**
41
+ * Secondary data series for the chart.
42
+ */
34
43
  secondaryData: {
35
44
  type: Array,
36
45
  required: false,
37
46
  default: () => []
38
47
  },
48
+ /**
49
+ * Additional ECharts option overrides.
50
+ */
39
51
  option: {
40
52
  type: Object,
41
53
  required: false,
42
54
  default: () => ({})
43
55
  },
56
+ /**
57
+ * Title text for the Y axis.
58
+ */
44
59
  yAxisTitle: {
45
60
  type: String,
46
61
  required: true
47
62
  },
63
+ /**
64
+ * Title text for the secondary data axis.
65
+ */
48
66
  secondaryDataTitle: {
49
67
  type: String,
50
68
  required: false,
51
69
  default: ''
52
70
  },
71
+ /**
72
+ * Title text for the X axis.
73
+ */
53
74
  xAxisTitle: {
54
75
  type: String,
55
76
  required: true
56
77
  },
78
+ /**
79
+ * Type of the X axis (e.g., 'category', 'value').
80
+ */
57
81
  xAxisType: {
58
82
  type: String,
59
83
  required: true,
@@ -65,33 +65,54 @@ var script = {
65
65
  },
66
66
  inheritAttrs: false,
67
67
  props: {
68
+ /**
69
+ * The chart data series to render.
70
+ */
68
71
  data: {
69
72
  type: Array,
70
73
  required: true
71
74
  },
75
+ /**
76
+ * Additional ECharts option overrides.
77
+ */
72
78
  option: {
73
79
  type: Object,
74
80
  required: false,
75
81
  default: () => ({})
76
82
  },
83
+ /**
84
+ * Title text for the Y axis.
85
+ */
77
86
  yAxisTitle: {
78
87
  type: String,
79
88
  required: true
80
89
  },
90
+ /**
91
+ * Title text for the X axis.
92
+ */
81
93
  xAxisTitle: {
82
94
  type: String,
83
95
  required: true
84
96
  },
97
+ /**
98
+ * Size of the scatter symbols.
99
+ */
85
100
  symbolSize: {
86
101
  type: Number,
87
102
  required: false,
88
103
  default: 8
89
104
  },
105
+ /**
106
+ * Custom function to format tooltip text.
107
+ */
90
108
  formatTooltipText: {
91
109
  type: Function,
92
110
  required: false,
93
111
  default: null
94
112
  },
113
+ /**
114
+ * When true, disables the tooltip.
115
+ */
95
116
  disableTooltip: {
96
117
  type: Boolean,
97
118
  required: false,
@@ -60,20 +60,32 @@ var script = {
60
60
  Chart
61
61
  },
62
62
  props: {
63
+ /**
64
+ * The current gauge value.
65
+ */
63
66
  value: {
64
67
  type: Number,
65
68
  required: true
66
69
  },
70
+ /**
71
+ * Minimum value of the gauge scale.
72
+ */
67
73
  min: {
68
74
  type: Number,
69
75
  required: false,
70
76
  default: 0
71
77
  },
78
+ /**
79
+ * Maximum value of the gauge scale.
80
+ */
72
81
  max: {
73
82
  type: Number,
74
83
  required: false,
75
84
  default: 100
76
85
  },
86
+ /**
87
+ * Array of threshold configurations for coloring the gauge.
88
+ */
77
89
  thresholds: {
78
90
  type: Array,
79
91
  required: false,
@@ -82,16 +94,25 @@ var script = {
82
94
  return value !== null && value !== void 0 && value.length ? value.every(item => Number.isFinite(item)) : true;
83
95
  }
84
96
  },
97
+ /**
98
+ * Text label to display on the gauge.
99
+ */
85
100
  text: {
86
101
  type: String,
87
102
  required: false,
88
103
  default: ''
89
104
  },
105
+ /**
106
+ * Number of split segments on the gauge scale.
107
+ */
90
108
  splitNumber: {
91
109
  type: Number,
92
110
  required: false,
93
111
  default: 10
94
112
  },
113
+ /**
114
+ * Additional ECharts option overrides.
115
+ */
95
116
  option: {
96
117
  type: Object,
97
118
  required: false,
@@ -96,50 +96,80 @@ var script = {
96
96
  TooltipDefaultFormat
97
97
  },
98
98
  props: {
99
+ /**
100
+ * Additional ECharts option overrides.
101
+ */
99
102
  option: {
100
103
  type: Object,
101
104
  required: false,
102
105
  default: () => ({})
103
106
  },
107
+ /**
108
+ * The heatmap data series to render.
109
+ */
104
110
  dataSeries: {
105
111
  type: Array,
106
112
  required: true
107
113
  },
114
+ /**
115
+ * Labels for the X axis categories.
116
+ */
108
117
  xAxisLabels: {
109
118
  type: Array,
110
119
  required: false,
111
120
  default: () => []
112
121
  },
122
+ /**
123
+ * Labels for the Y axis categories.
124
+ */
113
125
  yAxisLabels: {
114
126
  type: Array,
115
127
  required: false,
116
128
  default: () => []
117
129
  },
130
+ /**
131
+ * Name/label for the X axis.
132
+ */
118
133
  xAxisName: {
119
134
  type: String,
120
135
  required: false,
121
136
  default: ''
122
137
  },
138
+ /**
139
+ * Name/label for the Y axis.
140
+ */
123
141
  yAxisName: {
124
142
  type: String,
125
143
  required: false,
126
144
  default: ''
127
145
  },
146
+ /**
147
+ * Custom function to format tooltip text.
148
+ */
128
149
  formatTooltipText: {
129
150
  type: Function,
130
151
  required: false,
131
152
  default: null
132
153
  },
154
+ /**
155
+ * Custom text for the average value in the legend.
156
+ */
133
157
  legendAverageText: {
134
158
  type: String,
135
159
  required: false,
136
160
  default: 'Avg'
137
161
  },
162
+ /**
163
+ * Custom text for the maximum value in the legend.
164
+ */
138
165
  legendMaxText: {
139
166
  type: String,
140
167
  required: false,
141
168
  default: 'Max'
142
169
  },
170
+ /**
171
+ * When true, the chart automatically resizes to fit its container.
172
+ */
143
173
  responsive: {
144
174
  type: Boolean,
145
175
  required: false,
@@ -153,6 +183,9 @@ var script = {
153
183
  required: false,
154
184
  default: null
155
185
  },
186
+ /**
187
+ * When true, enables the tooltip on hover.
188
+ */
156
189
  showTooltip: {
157
190
  type: Boolean,
158
191
  default: true,