@gitlab/ui 115.9.0 → 115.9.1

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

@@ -1,306 +0,0 @@
-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.

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

@@ -1,23 +0,0 @@
-`GlFormRadio` components can be used directly, or via a `GlFormRadioGroup`.
-
-Below is an example which demonstrates the direct approach. For examples using
-`GlFormRadioGroup`, see the documentation for that component.
-
-```html
-<script>
-  export default {
-    data() {
-      return {
-        selected: 'yes',
-      };
-    },
-  };
-</script>
-
-<template>
-  <div>
-    <gl-form-radio v-model="selected" value="yes">Yes</gl-form-radio>
-    <gl-form-radio v-model="selected" value="no">No</gl-form-radio>
-  </div>
-</template>
-```

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

@@ -1,63 +0,0 @@
-The `GlFormRadioGroup` component provides an alternative and sometimes more
-compact way of setting up a group of `GlFormRadio` components.
-
-## Usage
-
-`GlFormRadioGroup` can be used in a few ways to build a group of `GlFormRadio`
-components: implicitly, explicitly, or a mix of both.
-
-Below is an example which demonstrates all three approaches, written such that
-all of them produce the same visual result.
-
-```html
-<script>
-export default {
-  data() {
-    return {
-      selected: 'one',
-      options: [
-        {
-          value: 'one',
-          text: 'One',
-        },
-        {
-          value: 'two',
-          text: 'Two',
-        },
-        {
-          value: 'three',
-          text: 'Three',
-        },
-      ],
-    };
-  },
-};
-</script>
-
-<template>
-  <div>
-    <!-- Implicit -->
-    <gl-form-radio-group v-model="selected" :options="options" name="implicit" />
-
-    <!-- Explicit -->
-    <gl-form-radio-group v-model="selected" name="explicit">
-      <gl-form-radio value="one">One</gl-form-radio>
-      <gl-form-radio value="two">Two</gl-form-radio>
-      <gl-form-radio value="three">Three</gl-form-radio>
-    </gl-form-radio-group>
-
-    <!-- Mixed -->
-    <gl-form-radio-group v-model="selected" :options="[options[1]]" name="mixed">
-      <template #first>
-        <gl-form-radio value="one">One</gl-form-radio>
-      </template>
-      <gl-form-radio value="three">Three</gl-form-radio>
-    </gl-form-radio-group>
-  </div>
-</template>
-```
-
-## Stacked
-
-By default, the GitLab Design guide mandates the `<gl-form-radio-group>` be `stacked` by default and
-is non-changeable at this time.

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

@@ -1 +0,0 @@
-Form select component used to select from group of options in a form.

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

@@ -1,3 +0,0 @@
-**Note:** This needs a `v-model` property to work correctly.
-See [this issue](https://github.com/bootstrap-vue/bootstrap-vue/issues/1915) on Bootstrap Vue for
-more information.

package/src/components/base/icon/icon.md

@@ -1,27 +0,0 @@
-## Usage
-
-The Icon component can be used to render any svg within the @gitlab/svgs icon sprites.
-
-### Accessibility
-
-`gl-icon` icons are hidden from screen readers by default, as usages of icons are commonly decorative.
-
-If the icon is not decorative, add an `aria-label` attribute to `gl-icon` to give it an accessible name.
-This label is read out by screen readers.
-
-If the icon is clickable, use `gl-button` instead of `gl-icon` because a clickable element should
-semantically be a button.
-
-```html
-<!-- icon, which is hidden from screen readers by default  -->
-<gl-icon name="rocket" />
-
-<!-- icon, which has an accessible name "Confidential issue" that is read out by screen readers -->
-<gl-icon name="eye-slash" :aria-label="__('Confidential issue')" />
-
-<!-- clickable icon, which is borderless and padding-less -->
-<gl-button icon="close" category="tertiary" class="!gl-p-0" aria-label="Close" />
-```
-
-For more information about icons within GitLab, visit the
-[GitLab accessibility guidelines](https://docs.gitlab.com/ee/development/fe_guide/accessibility#icons).

package/src/components/base/infinite_scroll/infinite_scroll.md

@@ -1,104 +0,0 @@
-## Usage
-
-The infinite scroll component wraps around a results list and emits a message
-(`bottomReached`) when the bottom of the viewport is reached, which should trigger
-a re-fetching. The `gl-infinite-scroll` component expects its parent component to
-manage the re-fetching.
-
-Additionally it emits a `topReached` message when the top of the viewport is reached, which
-can be useful to load items on top of the available data. If only `topReached` is present, the
-viewport will be scrolled to the bottom the first time this component is mounted.
-
-## Public methods
-
-Useful public methods you can call via `$refs`:
-
-- `.scrollUp()`: Scrolls to the top of the container.
-- `.scrollDown()`: Scrolls to the bottom of the container.
-- `.scrollTo({ top, behavior })`: Scrolls to a number of pixels
-  along the Y axis of the container. The scrolling behavior can also be specified,
-  as per MDN spec (<https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollTo>)
-
-## Implementation Example
-
-This is how a full implementation would look like with paginated results from GitLab's
-`projects` API.
-
-In the component's state, initialize a `pageInfo` object:
-
-```js
-pageInfo: {
-  currentPage: 0,
-  nextPage: 0,
-  totalPages: 0,
-  totalResults: 0,
-}
-```
-
-When fetching for the first time, set the state with the header
-information in the mutations:
-
-```html
-Vue.set(state.pageInfo, 'currentPage', parseInt(headers['X-Page'], 10));
-Vue.set(state.pageInfo, 'nextPage', parseInt(headers['X-Next-Page'], 10));
-Vue.set(state.pageInfo, 'totalPages', parseInt(headers['X-Total-Pages'], 10));
-Vue.set(state.pageInfo, 'totalResults', parseInt(headers['X-Total'], 10));
-```
-
-_Note: There is a function you can use for parsing integers in headers in
-GitLab called `parseIntPagination` in `common/utils.js`_
-
-Every time `bottomReached` happens, update the state in your mutations:
-
-```js
-state.searchResults = state.searchResults.concat(results.data);
-Vue.set(state.pageInfo, 'nextPage', parseInt(headers['X-Next-Page'],10));
-Vue.set(state.pageInfo, 'totalPages', parseInt(headers['X-Total-Pages'],10));
-```
-
-Use the state to fetch the next page in the actions. In this case, the `Projects`
-API allows us to send in a `page` parameter to fetch a certain page from the
-list of results.
-
-```js
-export const fetchNextPage = ({ state, dispatch }) => {
-  if(state.pageInfo.currentPage < state.pageInfo.totalPages) {
-    Api.projects(searchQuery, { page: state.pageInfo.nextPage })
-      ...
-  }
-};
-```
-
-```html
-<script>
-exportDefault {
-  components: {
-    GlInfiniteScroll,
-  },
-  computed: {
-    ...mapState([
-      'pageInfo',
-      'searchResults',
-    ]),
-  },
-  methods: {
-    ...mapActions([
-      'fetchNextPage',
-    ]),
-    bottomReached() {
-      this.fetchNextPage();
-    },
-  },
-}
-</script>
-<template>
-  <gl-infinite-scroll
-    @bottomReached="bottomReached"
-    :max-list-height="400"
-    :fetched-items="searchResults.length"
-    :total-items="totalResults"
-  >
-    ...Results in a list, another component, etc ....
-  </gl-infinite-scroll>
-</template>
-```

package/src/components/base/keyset_pagination/keyset_pagination.md

@@ -1,49 +0,0 @@
-Pagination is used to help users parse a large number of items on a page,
-whenever there are too many results to show at once. Pagination breaks up
-results into several pages with controls for navigating forward and backward, or
-to a specific page.
-
-## Usage
-
-The simplest way to use `GlKeysetPagination` with a paginated GraphQL response
-is to `v-bind` to the
-[`PageInfo`](https://docs.gitlab.com/ee/api/graphql/reference/#pageinfo) type
-returned by the endpoint:
-
-```html
-<gl-keyset-pagination v-bind="pageInfo" />
-```
-
-This is possible because the default field names of the `PageInfo` type align
-with the `props` of this component.
-
-## Dos and don'ts
-
-**✅ Do** provide the `prevText` and `nextText` props with translatable strings.
-The default strings ("Prev" and "Next") are hardcoded in this component and
-can't be translated.
-
-Example:
-
-```html
-<gl-keyset-pagination v-bind="pageInfo" :prev-text="__('Prev')" :next-text="__('Next')" />
-```
-
-**✅ Do** use this component for paginating GraphQL requests[^1] (or any
-endpoint that uses keyset pagination).
-
-**❌ Don't** use this component for paginating REST requests[^1] (or any
-endpoint that uses offset pagination).
-
-For offset pagination, use the [`GlPagination`
-component](/?path=/story/base-pagination--default) instead.
-
-For more information on the difference between offset and keyset pagination see
-[our documentation on GraphQL
-pagination](https://docs.gitlab.com/ee/development/graphql_guide/pagination.html).
-
-[^1]: There's no intrinsic reason why GraphQL endpoints can't support offset pagination (in fact, [the official documentation](https://graphql.org/learn/pagination/#pagination-and-edges) shows an example offset pagination implementation) or why REST endpoints can't support keyset pagination. This is simply how we've chosen to implement our REST and GraphQL endpoints at GitLab.
-
-## Pajamas reference
-
-<https://design.gitlab.com/components/pagination>

package/src/components/base/label/label.md

@@ -1,15 +0,0 @@
-Labels are editable objects that allow users to manually categorize other objects, like issues,
-merge requests, and epics. They have a name, description, and a customizable background color.
-They provide a quick way to recognize which categories the labeled object belongs to.
-
-## Using the component
-
-```js
-<gl-label
-  background-color="#D9C2EE"
-  title="Label content"
-  description="Some content"
-  tooltipPlacement="top"
-  target="http://some.url"
-/>
-```