@gitlab/ui 134.9.0 → 135.0.0

package/dist/components/base/tabs/tabs/tabs.js

@@ -12,34 +12,52 @@ var script = {
   },
   inheritAttrs: false,
   props: {
+    /**
+     * Configuration for the primary action button in the tabs.
+     */
     actionPrimary: {
       type: Object,
       required: false,
       default: null,
       validator: obj => validatorHelper(obj)
     },
+    /**
+     * Configuration for the secondary action button in the tabs.
+     */
     actionSecondary: {
       type: Object,
       required: false,
       default: null,
       validator: obj => validatorHelper(obj)
     },
+    /**
+     * Configuration for the tertiary action button in the tabs.
+     */
     actionTertiary: {
       type: Object,
       required: false,
       default: null,
       validator: obj => validatorHelper(obj)
     },
+    /**
+     * Additional CSS classes to apply to the tab content area.
+     */
     contentClass: {
       type: [String, Array, Object],
       required: false,
       default: null
     },
+    /**
+     * Additional CSS classes to apply to the tab navigation.
+     */
     navClass: {
       type: [String, Array, Object],
       required: false,
       default: null
     },
+    /**
+     * When true, makes the tabs stretch to fill the available width.
+     */
     justified: {
       type: Boolean,
       required: false,
@@ -61,6 +79,9 @@ var script = {
       required: false,
       default: 'tab'
     },
+    /**
+     * The currently active tab value.
+     */
     value: {
       type: Number,
       required: false,

package/dist/components/base/toast/toast.js

@@ -10,19 +10,31 @@ var script = {
     CloseButton
   },
   props: {
+    /**
+     * Unique identifier for the toast notification.
+     */
     toastId: {
       type: String,
       required: true
     },
+    /**
+     * The message text to display in the toast.
+     */
     message: {
       type: String,
       required: true
     },
+    /**
+     * Action button configuration for the toast.
+     */
     action: {
       type: Object,
       required: false,
       default: null
     },
+    /**
+     * Delay in milliseconds before auto-hiding the toast.
+     */
     autoHideDelay: {
       type: Number,
       required: false,

package/dist/components/base/toggle/toggle.js

@@ -16,6 +16,9 @@ var script = {
     event: 'change'
   },
   props: {
+    /**
+     * The name attribute for the hidden input element.
+     */
     name: {
       type: String,
       required: false,

package/dist/components/base/token_selector/token_container.js

@@ -10,21 +10,33 @@ var script = {
     GlButton
   },
   props: {
+    /**
+     * Array of token objects to display.
+     */
     tokens: {
       type: Array,
       // All tokens need to have an `id` key
       validator: tokensValidator,
       required: true
     },
+    /**
+     * Function to register focus handling on tokens.
+     */
     registerFocusOnToken: {
       type: Function,
       required: true
     },
+    /**
+     * When true, renders tokens in a non-interactive view-only mode.
+     */
     viewOnly: {
       type: Boolean,
       required: false,
       default: false
     },
+    /**
+     * When true, shows a button to clear all tokens.
+     */
     showClearAllButton: {
       type: Boolean,
       required: false,

package/dist/components/base/token_selector/token_selector_dropdown.js

@@ -9,42 +9,69 @@ var script = {
     GlDropdownItem
   },
   props: {
+    /**
+     * When true, shows the dropdown.
+     */
     show: {
       type: Boolean,
       required: true
     },
+    /**
+     * Additional CSS classes for the dropdown menu.
+     */
     menuClass: {
       type: [String, Array, Object],
       required: false,
       default: ''
     },
+    /**
+     * When true, shows a loading state in the dropdown.
+     */
     loading: {
       type: Boolean,
       required: false,
       default: false
     },
+    /**
+     * Array of items to display in the dropdown.
+     */
     dropdownItems: {
       type: Array,
       // All items need to have an `id` key
       validator: tokensValidator,
       required: true
     },
+    /**
+     * Current text in the search input.
+     */
     inputText: {
       type: String,
       required: true
     },
+    /**
+     * When true, allows user-defined tokens to be added.
+     */
     userDefinedTokenCanBeAdded: {
       type: Boolean,
       required: true
     },
+    /**
+     * Unique identifier for the component.
+     */
     componentId: {
       type: String,
       required: true
     },
+    /**
+     * Function to register event handlers for the dropdown.
+     */
     registerDropdownEventHandlers: {
       type: Function,
       required: true
     },
+    /**
+     * Function to register reset of focused dropdown item.
+     */
     registerResetFocusedDropdownItem: {
       type: Function,
       required: true

package/dist/components/charts/area/area.js

@@ -33,30 +33,48 @@ var script = {
   },
   inheritAttrs: false,
   props: {
+    /**
+     * The chart data series to render.
+     */
     data: {
       type: Array,
       required: true
     },
+    /**
+     * Additional ECharts option overrides.
+     */
     option: {
       type: Object,
       required: false,
       default: () => ({})
     },
+    /**
+     * Array of threshold line configurations.
+     */
     thresholds: {
       type: Array,
       required: false,
       default: () => []
     },
+    /**
+     * Array of annotation configurations.
+     */
     annotations: {
       type: Array,
       required: false,
       default: () => []
     },
+    /**
+     * When true, includes average and maximum values in the legend.
+     */
     includeLegendAvgMax: {
       type: Boolean,
       required: false,
       default: true
     },
+    /**
+     * Custom function to format annotation tooltip text.
+     */
     formatAnnotationsTooltipText: {
       type: Function,
       required: false,
@@ -73,26 +91,41 @@ var script = {
       required: false,
       default: null
     },
+    /**
+     * Custom text for the average value in the legend.
+     */
     legendAverageText: {
       type: String,
       required: false,
       default: LEGEND_AVERAGE_TEXT
     },
+    /**
+     * Custom text for the maximum value in the legend.
+     */
     legendMaxText: {
       type: String,
       required: false,
       default: LEGEND_MAX_TEXT
     },
+    /**
+     * Custom text for the minimum value in the legend.
+     */
     legendMinText: {
       type: String,
       required: false,
       default: LEGEND_MIN_TEXT
     },
+    /**
+     * Custom text for the current value in the legend.
+     */
     legendCurrentText: {
       type: String,
       required: false,
       default: LEGEND_CURRENT_TEXT
     },
+    /**
+     * Layout configuration for the legend.
+     */
     legendLayout: {
       type: String,
       required: false,
@@ -109,6 +142,9 @@ var script = {
       required: false,
       default: null
     },
+    /**
+     * Series information for the legend.
+     */
     legendSeriesInfo: {
       type: Array,
       required: false,

package/dist/components/charts/bar/bar.js

@@ -62,23 +62,38 @@ var script = {
   },
   inheritAttrs: false,
   props: {
+    /**
+     * The chart data series to render.
+     */
     data: {
       type: Object,
       required: true
     },
+    /**
+     * Additional ECharts option overrides.
+     */
     option: {
       type: Object,
       required: false,
       default: () => ({})
     },
+    /**
+     * Title text for the Y axis.
+     */
     yAxisTitle: {
       type: String,
       required: true
     },
+    /**
+     * Title text for the X axis.
+     */
     xAxisTitle: {
       type: String,
       required: true
     },
+    /**
+     * Type of the X axis (e.g., 'category', 'value').
+     */
     xAxisType: {
       type: String,
       required: false,

package/dist/components/charts/chart/chart.js

@@ -25,6 +25,9 @@ var script = {
       type: Object,
       required: true
     },
+    /**
+     * Width of the chart in pixels. Set to "auto" to use the width of the container.
+     */
     width: {
       type: [Number, String],
       required: false,
@@ -32,7 +35,7 @@ var script = {
       validator: sizeValidator
     },
     /**
-     * Sets the chart's height in pixels. Set to `"auto"` to use the height of the container.
+     * Height of the chart in pixels. Set to "auto" to use the height of the container.
      */
     height: {
       type: [Number, String],
@@ -61,6 +64,9 @@ var script = {
         return validRenderers.includes(renderer);
       }
     },
+    /**
+     * When true, the chart automatically resizes to fit its container.
+     */
     responsive: {
       type: Boolean,
       required: false,

package/dist/components/charts/column/column.js

@@ -21,39 +21,63 @@ var script = {
   },
   inheritAttrs: false,
   props: {
+    /**
+     * Array of bar series data.
+     */
     bars: {
       type: Array,
       required: false,
       default: () => []
     },
+    /**
+     * Array of line series data.
+     */
     lines: {
       type: Array,
       required: false,
       default: () => []
     },
+    /**
+     * Secondary data series for the chart.
+     */
     secondaryData: {
       type: Array,
       required: false,
       default: () => []
     },
+    /**
+     * Additional ECharts option overrides.
+     */
     option: {
       type: Object,
       required: false,
       default: () => ({})
     },
+    /**
+     * Title text for the Y axis.
+     */
     yAxisTitle: {
       type: String,
       required: true
     },
+    /**
+     * Title text for the secondary data axis.
+     */
     secondaryDataTitle: {
       type: String,
       required: false,
       default: ''
     },
+    /**
+     * Title text for the X axis.
+     */
     xAxisTitle: {
       type: String,
       required: true
     },
+    /**
+     * Type of the X axis (e.g., 'category', 'value').
+     */
     xAxisType: {
       type: String,
       required: true,

package/dist/components/charts/discrete_scatter/discrete_scatter.js

@@ -65,33 +65,54 @@ var script = {
   },
   inheritAttrs: false,
   props: {
+    /**
+     * The chart data series to render.
+     */
     data: {
       type: Array,
       required: true
     },
+    /**
+     * Additional ECharts option overrides.
+     */
     option: {
       type: Object,
       required: false,
       default: () => ({})
     },
+    /**
+     * Title text for the Y axis.
+     */
     yAxisTitle: {
       type: String,
       required: true
     },
+    /**
+     * Title text for the X axis.
+     */
     xAxisTitle: {
       type: String,
       required: true
     },
+    /**
+     * Size of the scatter symbols.
+     */
     symbolSize: {
       type: Number,
       required: false,
       default: 8
     },
+    /**
+     * Custom function to format tooltip text.
+     */
     formatTooltipText: {
       type: Function,
       required: false,
       default: null
     },
+    /**
+     * When true, disables the tooltip.
+     */
     disableTooltip: {
       type: Boolean,
       required: false,

package/dist/components/charts/gauge/gauge.js

@@ -60,20 +60,32 @@ var script = {
     Chart
   },
   props: {
+    /**
+     * The current gauge value.
+     */
     value: {
       type: Number,
       required: true
     },
+    /**
+     * Minimum value of the gauge scale.
+     */
     min: {
       type: Number,
       required: false,
       default: 0
     },
+    /**
+     * Maximum value of the gauge scale.
+     */
     max: {
       type: Number,
       required: false,
       default: 100
     },
+    /**
+     * Array of threshold configurations for coloring the gauge.
+     */
     thresholds: {
       type: Array,
       required: false,
@@ -82,16 +94,25 @@ var script = {
         return value !== null && value !== void 0 && value.length ? value.every(item => Number.isFinite(item)) : true;
       }
     },
+    /**
+     * Text label to display on the gauge.
+     */
     text: {
       type: String,
       required: false,
       default: ''
     },
+    /**
+     * Number of split segments on the gauge scale.
+     */
     splitNumber: {
       type: Number,
       required: false,
       default: 10
     },
+    /**
+     * Additional ECharts option overrides.
+     */
     option: {
       type: Object,
       required: false,

package/dist/components/charts/heatmap/heatmap.js

@@ -96,50 +96,80 @@ var script = {
     TooltipDefaultFormat
   },
   props: {
+    /**
+     * Additional ECharts option overrides.
+     */
     option: {
       type: Object,
       required: false,
       default: () => ({})
     },
+    /**
+     * The heatmap data series to render.
+     */
     dataSeries: {
       type: Array,
       required: true
     },
+    /**
+     * Labels for the X axis categories.
+     */
     xAxisLabels: {
       type: Array,
       required: false,
       default: () => []
     },
+    /**
+     * Labels for the Y axis categories.
+     */
     yAxisLabels: {
       type: Array,
       required: false,
       default: () => []
     },
+    /**
+     * Name/label for the X axis.
+     */
     xAxisName: {
       type: String,
       required: false,
       default: ''
     },
+    /**
+     * Name/label for the Y axis.
+     */
     yAxisName: {
       type: String,
       required: false,
       default: ''
     },
+    /**
+     * Custom function to format tooltip text.
+     */
     formatTooltipText: {
       type: Function,
       required: false,
       default: null
     },
+    /**
+     * Custom text for the average value in the legend.
+     */
     legendAverageText: {
       type: String,
       required: false,
       default: 'Avg'
     },
+    /**
+     * Custom text for the maximum value in the legend.
+     */
     legendMaxText: {
       type: String,
       required: false,
       default: 'Max'
     },
+    /**
+     * When true, the chart automatically resizes to fit its container.
+     */
     responsive: {
       type: Boolean,
       required: false,
@@ -153,6 +183,9 @@ var script = {
       required: false,
       default: null
     },
+    /**
+     * When true, enables the tooltip on hover.
+     */
     showTooltip: {
       type: Boolean,
       default: true,

package/dist/components/charts/legend/legend.js

@@ -62,6 +62,9 @@ var script = {
     GlTruncate
   },
   props: {
+    /**
+     * Reference to the ECharts instance.
+     */
     chart: {
       type: Object,
       required: true,
@@ -69,6 +72,9 @@ var script = {
         return Object.is(chart, echarts.getInstanceByDom(chart.getDom()));
       }
     },
+    /**
+     * Array of series information for the legend.
+     */
     seriesInfo: {
       type: Array,
       required: true,
@@ -76,6 +82,9 @@ var script = {
         return seriesInfo.every(series => series.type && series.name && series.color);
       }
     },
+    /**
+     * Text style configuration for the legend labels.
+     */
     textStyle: {
       type: Object,
       required: false,
@@ -89,11 +98,17 @@ var script = {
       required: false,
       default: LEGEND_AVERAGE_TEXT
     },
+    /**
+     * Custom text for the current value label.
+     */
     currentText: {
       type: String,
       required: false,
       default: LEGEND_CURRENT_TEXT
     },
+    /**
+     * Custom text for the minimum value label.
+     */
     minText: {
       type: String,
       required: false,