@gitlab/ui 107.7.1 → 108.0.1

package/dist/components/base/search_box_by_click/search_box_by_click.js

@@ -8,7 +8,7 @@ import GlFormInputGroup from '../form/form_input_group/form_input_group';
 import __vue_normalize__ from 'vue-runtime-helpers/dist/normalize-component.js';
 
 var script = {
-  name: 'GlSearchboxByClick',
+  name: 'GlSearchBoxByClick',
   components: {
     GlClearIconButton,
     GlButton,

package/dist/components/base/search_box_by_type/search_box_by_type.js

@@ -6,7 +6,7 @@ import { translate } from '../../../utils/i18n';
 import __vue_normalize__ from 'vue-runtime-helpers/dist/normalize-component.js';
 
 var script = {
-  name: 'GlSearchboxByType',
+  name: 'GlSearchBoxByType',
   components: {
     GlClearIconButton,
     GlIcon,

package/dist/utils/utils.js

@@ -1,4 +1,5 @@
 import { isVisible } from '../vendor/bootstrap-vue/src/utils/dom';
+export { isVisible } from '../vendor/bootstrap-vue/src/utils/dom';
 import { COMMA, labelColorOptions, CONTRAST_LEVELS, focusableTags } from './constants';
 
 function debounceByAnimationFrame(fn) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitlab/ui",
-  "version": "107.7.1",
+  "version": "108.0.1",
   "description": "GitLab UI Components",
   "license": "MIT",
   "main": "dist/index.js",
@@ -173,8 +173,8 @@
     "npm-run-all": "^4.1.5",
     "patch-package": "^8.0.0",
     "pikaday": "^1.8.0",
-    "playwright": "^1.50.0",
-    "playwright-core": "^1.50.0",
+    "playwright": "^1.50.1",
+    "playwright-core": "^1.50.1",
     "postcss": "8.4.28",
     "postcss-loader": "^7.0.2",
     "postcss-scss": "4.0.4",

package/src/components/base/form/form_input/form_input.md

@@ -1 +1,306 @@
-General user input to be used in forms.
+General user input to be used in forms. Create various type inputs such as:
+`text`, `password`, `number`, `url`, `email`, `search`, `range`, `date`
+and more.
+
+```html
+<template>
+  <gl-form-input v-model="text" placeholder="Enter your name"></gl-form-input>
+</template>
+
+<script>
+  export default {
+    data() {
+      return {
+        text: ''
+      }
+    }
+  }
+</script>
+```
+
+## Input type
+
+`<gl-form-input>` defaults to a `text` input, but you can set the `type` prop
+to one of the supported native browser HTML5 types: `text`, `password`,
+`email`, `number`, `url`, `tel`, `search`, `date`, `datetime`
+`datetime-local`, `month`, `week`, `time`, `range`, or `color`.
+
+If the `type` prop is set to an input type that is not supported (see above),
+a `text` input will be rendered.
+
+**Caveats with input types:**
+
+- Not all browsers support all input types, nor do some types render in the same format across
+browser types/versions. Refer to [Can I use](https://caniuse.com/?search=input).
+- Browsers that do not support a particular type will fall back to a `text` input type
+(even though the rendered `type` attribute markup shows the requested type).
+- No testing is performed to see if the requested input type is supported by the browser.
+- Chrome lost support for `datetime` in version 26, Opera in version 15, and Safari in iOS 7.
+Instead of using `datetime`, since support should be deprecated, use `date` and
+`time` as two separate inputs.
+- `date` and `time` inputs are native browser types, and are not a custom date/time picker.
+- For date and time style inputs, where supported, the displayed value in the GUI may be
+different than what is returned by its value (i.e. ordering of year-month-date).
+- Regardless of input type, the value is **always** returned as a string representation.
+- `v-model.lazy` is not supported by `<b-form-input>` (nor any custom Vue component).
+Use the `lazy` prop instead.
+- `v-model` modifiers `.number` and `.trim` can cause unexpected cursor jumps when
+the user is typing (this is a Vue issue with `v-model` on custom components).
+_Avoid using these modifiers_. Use the `number` or `trim` props instead.
+- Older version of Firefox may not support `readonly` for `range` type inputs.
+- Input types that do not support `min`, `max` and `step` (i.e. `text`, `password`,
+`tel`, `email`, `url`, etc.) will silently ignore these values
+(although they will still be rendered on the input markup) if values are provided.
+
+**Caveats with predictive text entry and IME composition entry:**
+
+- When using predictive text auto-suggested words, the `v-model` will no update until
+the auto-suggested word is selected (or a space is typed). If an auto suggested word
+is not selected, the v-model will update with the current _displayed text_ of the input
+when the input is blurred.
+- When using IME composition (ie. Chinese, Japanese, etc.), the `v-model` will not update
+until the IME composition is completed.
+
+### Range type input
+
+Inputs with type `range` render using Bootstrap v4's `.custom-range` class. The track
+(the background) and thumb (the value) are both styled to appear the same across browsers.
+
+Range inputs have implicit values for `min` and `max` of `0` and `100` respectively.
+You may specify new values for those using the `min` and `max` props.
+
+By default, range inputs "snap" to integer values. To change this, you can specify a `step` value.
+In the example below, we double the number of steps by using step="0.5".
+
+```html
+<template>
+  <gl-form-input id="range-2" v-model="value" type="range" min="0" max="5" step="0.5"></gl-form-input>
+</template>
+
+<script>
+  export default {
+    data() {
+      return {
+        value: '2'
+      }
+    }
+  }
+</script>
+```
+
+**Note:** Range inputs (as do all input types) return their value as a string.
+You may need to convert the value to a native number by using `Number(value)`,
+`parseInt(value, 10)`, `parseFloat(value)`, or use the `number` prop.
+
+## Contextual states
+
+Generally speaking, you'll want to use a particular state for specific types of feedback:
+
+- `false` (denotes invalid state) is great for when there's a blocking or required field.
+A user must fill in this field properly to submit the form.
+- `true` (denotes valid state) is ideal for situations when you have per-field validation
+throughout a form and want to encourage a user through the rest of the fields.
+- `null` Displays no validation state (neither valid nor invalid)
+
+To apply one of the contextual state icons on `<gl-form-input>`, set the `state` prop to
+`false` (for invalid), `true` (for valid), or `null` (no validation state).
+
+> **Tip:** Use the [`<gl-form-group>`](?path=/docs/base-form-form-group--docs) component to
+> automatically generate markup for an input with label, validation message, and help text block.
+
+### ARIA `aria-invalid` attribute
+
+Specifically for assistive technologies, invalid form controls can also be assigned
+an `aria-invalid="true"` attribute.
+
+When `<gl-form-input>` has an invalid contextual state (i.e. state is `false`) you
+may also want to set the `<gl-form-input>` prop `aria-invalid` to `true`, or to
+one of the supported values:
+
+- `false`: Convey no errors detected (default)
+- `true` (or `'true'`): Convey that the value has failed validation.
+- `'grammar'` Convey that a grammatical error has been detected.
+- `'spelling'` Convey that a spelling error has been detected.
+
+If `aria-invalid` is not explicitly set and `state` is set to `false`, then the `aria-invalid`
+attribute on the input will automatically be set to `'true'`;
+
+## Formatter support
+
+`<gl-form-input>` optionally supports formatting by passing a function reference to
+the `formatter` prop.
+
+Formatting (when a formatter function is supplied) occurs when the control's native
+`input` and `change` events fire. You can use the boolean prop `lazy-formatter` to
+restrict the formatter function to being called on the control's native `blur` event.
+
+The `formatter` function receives two arguments: the raw `value` of the input element,
+and the native `event` object that triggered the format (if available).
+
+The `formatter` function should return the formatted value as a _string_.
+
+Formatting does not occur if a `formatter` is not provided.
+
+```html
+<template>
+  <div>
+    <gl-form-group
+      label="Text input with formatter (on input)"
+      label-for="input-formatter"
+      description="We will convert your name to lowercase instantly"
+      class="mb-0"
+    >
+      <gl-form-input
+        id="input-formatter"
+        v-model="text1"
+        placeholder="Enter your name"
+        :formatter="formatter"
+      ></gl-form-input>
+    </gl-form-group>
+    <p><b>Value:</b> {{ text1 }}</p>
+
+    <gl-form-group
+      label="Text input with lazy formatter (on blur)"
+      label-for="input-lazy"
+      description="This one is a little lazy!"
+      class="mb-0"
+    >
+      <gl-form-input
+        id="input-lazy"
+        v-model="text2"
+        placeholder="Enter your name"
+        lazy-formatter
+        :formatter="formatter"
+      ></gl-form-input>
+    </gl-form-group>
+    <p class="mb-0"><b>Value:</b> {{ text2 }}</p>
+  </div>
+</template>
+
+<script>
+  export default {
+    data() {
+      return {
+        text1: '',
+        text2: ''
+      }
+    },
+    methods: {
+      formatter(value) {
+        return value.toLowerCase()
+      }
+    }
+  }
+</script>
+```
+
+**Note:** When using a non-text-like input (i.e. `color`, `range`, `date`, `number`, `email` etc.),
+ensure that your formatter function returns the value in the expected format
+(`date` -> '2000-06-01', `color` -> '#ff0000', etc.) for the input type.
+The formatter **must** return the value as a _string_.
+
+**Note:** With non-lazy formatting, if the cursor is not at the end of the input value,
+the cursor may jump to the end _after_ a character is typed. You can use the provided event
+object and the `event.target` to access the native input's selection methods and properties
+to control where the insertion point is.
+
+## Readonly plain text
+
+If you want to have `<gl-form-input readonly>` elements in your form styled as plain text,
+set the `plaintext` prop (no need to set `readonly`) to remove the default form field
+styling and preserve the correct margin and padding.
+
+The `plaintext` option is not supported by input types `color` or `range`.
+
+## Disabled mousewheel events on numeric-like inputs
+
+On some browsers, scrolling the mousewheel while a numeric-like input is focused will
+increment or decrement the input's value. Therefore, mousewheel events are disabled on
+focus numeric type inputs.
+
+## `v-model` modifiers
+
+Vue does not officially support `.lazy`, `.trim`, and `.number` modifiers on the `v-model`
+of custom component based inputs, and may generate a bad user experience.
+Avoid using Vue's native modifiers.
+
+To get around this, `<gl-form-input>` has three boolean props `trim`, `number`,
+and `lazy` which emulate the native Vue `v-model` modifiers `.trim` and `.number`
+and `.lazy` respectively. The `lazy` prop will update the v-model on `change`/`blur` events.
+
+**Notes:**
+
+- The `number` prop takes precedence over the `trim` prop
+(i.e. `trim` will have no effect when `number` is set).
+- When using the `number` prop, and if the value can be parsed as a number (via `parseFloat`)
+it will return a value of type `Number` to the `v-model`, otherwise the original input value
+is returned as type `String`. This is the same behaviour as the native `.number` modifier.
+- The `trim` and `number` modifier props do not affect the value returned by the
+`input` or `change` events. These events will always return the string value of the
+content of `<textarea>` after optional formatting (which may not match the value returned
+via the `v-model` `update` event, which handles the modifiers).
+
+## Debounce support
+
+As an alternative to the `lazy` modifier prop, `<gl-form-input>` optionally supports debouncing
+user input, updating the `v-model` after a period of idle time from when the last character
+was entered by the user (or a `change` event occurs). If the user enters a new character
+(or deletes characters) before the idle timeout expires, the timeout is re-started.
+
+To enable debouncing, set the prop `debounce` to any integer greater than zero.
+The value is specified in milliseconds. Setting `debounce` to `0` will disable debouncing.
+
+Note: debouncing will _not_ occur if the `lazy` prop is set.
+
+## Autofocus
+
+When the `autofocus` prop is set, the input will be auto-focused when it is inserted
+(i.e. **mounted**) into the document, or re-activated when inside a Vue `<keep-alive>` component.
+Note that this prop **does not** set the `autofocus` attribute on the input,
+nor can it tell when the input becomes visible.
+
+## Native and custom events
+
+All native events (other than the custom `input` and `change` events) are supported,
+without the need for the `.native` modifier.
+
+The custom `update` and `change` events receive a single argument of the current `value`
+(after any formatting has been applied), and are triggered by user interaction.
+
+The custom `input` event is passed the input value, and is emitted whenever the
+`v-model` needs updating (it is emitted before `update`, `change`. and `blur` as needed).
+
+You can always access the native `input` and `change` events by using the `.native` modifier.
+
+## Exposed input properties and methods
+
+`<gl-form-input>` exposes several of the native input element's properties and methods
+on the component reference (i.e. assign a `ref` to your `<gl-form-input ref="foo" ...>`
+and use `this.$refs['foo'].propertyName` or `this.$refs['foo'].methodName(...)`).
+
+### Input properties
+
+| Property              | Notes      |
+| --------------------- | ---------- |
+| `.selectionStart`     | Read/Write |
+| `.selectionEnd`       | Read/Write |
+| `.selectionDirection` | Read/Write |
+| `.validity`           | Read only  |
+| `.validationMessage`  | Read only  |
+| `.willValidate`       | Read only  |
+
+### Input methods
+
+| Method                 | Notes                             |
+| ---------------------- | --------------------------------- |
+| `.focus()`             | Focus the input                   |
+| `.blur()`              | Remove focus from the input       |
+| `.select()`            | Selects all text within the input |
+| `.setSelectionRange()` |                                   |
+| `.setRangeText()`      |                                   |
+| `.setCustomValidity()` |                                   |
+| `.checkValidity()`     |                                   |
+| `.reportValidity()`    |                                   |
+
+Refer to <https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement> for more
+information on these methods and properties. Support will vary based on input type.