@gitlab/ui 124.4.1 → 124.4.2

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.
@@ -9,11 +9,17 @@ var script = {
9
9
  event: 'input'
10
10
  },
11
11
  props: {
12
+ /**
13
+ * Controls the visibility state of the collapse.
14
+ */
12
15
  visible: {
13
16
  type: Boolean,
14
17
  default: false,
15
18
  required: false
16
19
  },
20
+ /**
21
+ * HTML tag to use for the collapse container element.
22
+ */
17
23
  tag: {
18
24
  type: String,
19
25
  required: false,
@@ -10,21 +10,33 @@ var script = {
10
10
  },
11
11
  inheritAttrs: false,
12
12
  props: {
13
+ /**
14
+ * Additional CSS class(es) to apply to the label element.
15
+ */
13
16
  labelClass: {
14
17
  type: [String, Array, Object],
15
18
  required: false,
16
19
  default: null
17
20
  },
21
+ /**
22
+ * Descriptive text to display below the label.
23
+ */
18
24
  labelDescription: {
19
25
  type: String,
20
26
  required: false,
21
27
  default: ''
22
28
  },
29
+ /**
30
+ * When true, displays optional text next to the label.
31
+ */
23
32
  optional: {
24
33
  type: Boolean,
25
34
  required: false,
26
35
  default: false
27
36
  },
37
+ /**
38
+ * Text to display when the field is optional.
39
+ */
28
40
  optionalText: {
29
41
  type: String,
30
42
  required: false,
@@ -11,7 +11,7 @@ var script = {
11
11
  inheritAttrs: false,
12
12
  props: {
13
13
  /**
14
- * Maximum width of the Select
14
+ * Width of the select element.
15
15
  */
16
16
  width: {
17
17
  type: [String, Object],
@@ -22,11 +22,17 @@ var script = {
22
22
  return widths.every(width => Object.values(formInputWidths).includes(width));
23
23
  }
24
24
  },
25
+ /**
26
+ * Additional CSS class(es) to apply to the select element.
27
+ */
25
28
  selectClass: {
26
29
  type: [String, Object, Array],
27
30
  required: false,
28
31
  default: ''
29
32
  },
33
+ /**
34
+ * Number of visible options in the select dropdown. When greater than 1, displays as a scrollable list box.
35
+ */
30
36
  selectSize: {
31
37
  type: Number,
32
38
  required: false,
@@ -23,11 +23,17 @@ var script = {
23
23
  required: false,
24
24
  default: ''
25
25
  },
26
+ /**
27
+ * When true, prevents the textarea from being resized by the user (hides the resize handle).
28
+ */
26
29
  noResize: {
27
30
  type: Boolean,
28
31
  required: false,
29
32
  default: true
30
33
  },
34
+ /**
35
+ * When true, emits a submit event when Ctrl+Enter or Cmd+Enter is pressed.
36
+ */
31
37
  submitOnEnter: {
32
38
  type: Boolean,
33
39
  required: false,
@@ -42,13 +48,16 @@ var script = {
42
48
  default: null
43
49
  },
44
50
  /**
45
- * Classes for textarea component when `characterCountLimit` is set.
51
+ * Additional CSS class(es) to apply to the textarea element.
46
52
  */
47
53
  textareaClasses: {
48
54
  type: [String, Object, Array],
49
55
  required: false,
50
56
  default: null
51
57
  },
58
+ /**
59
+ * Number of visible text rows in the textarea.
60
+ */
52
61
  rows: {
53
62
  type: [Number, String],
54
63
  required: false,
@@ -22,6 +22,9 @@ var script = {
22
22
  event: 'input'
23
23
  },
24
24
  props: {
25
+ /**
26
+ * The current page number. Must be greater than 0.
27
+ */
25
28
  value: {
26
29
  type: Number,
27
30
  required: false,