@gitlab/ui 62.5.1 → 62.6.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [62.6.0](https://gitlab.com/gitlab-org/gitlab-ui/compare/v62.5.2...v62.6.0) (2023-05-02)
+
+
+### Features
+
+* Add gl-form-fields component ([a17bcb6](https://gitlab.com/gitlab-org/gitlab-ui/commit/a17bcb6c8db0444dcd7f5bd799fe681891dbdcc9))
+
+## [62.5.2](https://gitlab.com/gitlab-org/gitlab-ui/compare/v62.5.1...v62.5.2) (2023-05-01)
+
+
+### Bug Fixes
+
+* **GlToggle:** set aria-disabled attribute ([a899eb7](https://gitlab.com/gitlab-org/gitlab-ui/commit/a899eb7acd23d089ddb43c3bcd66a0aae7fe3c6f))
+
 ## [62.5.1](https://gitlab.com/gitlab-org/gitlab-ui/compare/v62.5.0...v62.5.1) (2023-04-28)
 
 

package/dist/components/base/form/form_fields/form_field_validator.js

@@ -0,0 +1,93 @@
+import __vue_normalize__ from 'vue-runtime-helpers/dist/normalize-component.js';
+
+/**
+ * FormFieldValidator
+ *
+ * This is an internal component which is used to watch on specific field/value
+ * pairs and emits changes to `invalidFeedback`.
+ *
+ * **why:** Without this separate component, *any* change to *any* value
+ * was causing *all* validators to run. A separate renderless component
+ * helps us isolate this logic *and* react only to what we need to.
+ */
+var script = {
+  name: 'GlFormFieldValidator',
+  props: {
+    value: {
+      required: true,
+      // ESLint requires "validator" or "type". Any kind of value is valid.
+      validator: () => true
+    },
+    validators: {
+      type: Array,
+      required: false,
+      default: () => []
+    },
+    shouldValidate: {
+      type: Boolean,
+      required: false,
+      default: false
+    }
+  },
+  computed: {
+    invalidFeedback() {
+      if (!this.shouldValidate) {
+        return '';
+      }
+      const result = this.validators.reduce((acc, validateFn) => {
+        // If we already have an invalid message, let's just use that one.
+        if (acc) {
+          return acc;
+        }
+        return validateFn(this.value);
+      }, '');
+
+      // Force falsey string for type consistency.
+      return result || '';
+    }
+  },
+  watch: {
+    invalidFeedback(newVal) {
+      this.$emit('update', newVal);
+    }
+  },
+  render() {
+    return null;
+  }
+};
+
+/* script */
+const __vue_script__ = script;
+
+/* template */
+
+  /* style */
+  const __vue_inject_styles__ = undefined;
+  /* scoped */
+  const __vue_scope_id__ = undefined;
+  /* module identifier */
+  const __vue_module_identifier__ = undefined;
+  /* functional template */
+  const __vue_is_functional_template__ = undefined;
+  /* style inject */
+  
+  /* style inject SSR */
+  
+  /* style inject shadow dom */
+  
+
+  
+  const __vue_component__ = __vue_normalize__(
+    {},
+    __vue_inject_styles__,
+    __vue_script__,
+    __vue_scope_id__,
+    __vue_is_functional_template__,
+    __vue_module_identifier__,
+    false,
+    undefined,
+    undefined,
+    undefined
+  );
+
+export default __vue_component__;

package/dist/components/base/form/form_fields/form_fields.js

@@ -0,0 +1,213 @@
+import isFunction from 'lodash/isFunction';
+import mapValues from 'lodash/mapValues';
+import uniqueId from 'lodash/uniqueId';
+import GlFormGroup from '../form_group/form_group';
+import GlFormInput from '../form_input/form_input';
+import GlFormFieldValidator from './form_field_validator';
+import __vue_normalize__ from 'vue-runtime-helpers/dist/normalize-component.js';
+
+var script = {
+  name: 'GlFormFields',
+  components: {
+    GlFormGroup,
+    GlFormInput,
+    GlFormFieldValidator
+  },
+  model: {
+    prop: 'values',
+    event: 'input'
+  },
+  props: {
+    /**
+     * Object of keys to FieldDefinitions.
+     * The shape of the keys will be the same for `values` and what's emitted by the `input` event.
+     *
+     * @typedef {object} FieldDefinition
+     * @template TValue=string
+     * @property {string} label - Label text to show for this field.
+     * @property {undefined | Object} inputAttrs - Properties that are passed to the actual input for this field.
+     * @property {undefined | function(string): TValue} mapValue - Function that maps the inputted string value to the field's actual value (e.g. a Number).
+     * @property {undefined | Array<function(TValue): string | undefined>=} validators - Collection of validator functions.
+     *
+     * @type {{ [key: string]: FieldDefinition }}
+     */
+    fields: {
+      type: Object,
+      required: true
+    },
+    /**
+     * The current value for each field, by key.
+     * Keys should match between `values` and `fields`.
+     */
+    values: {
+      type: Object,
+      required: true
+    },
+    /**
+     * The id of the form element to handle "submit" listening.
+     */
+    formId: {
+      type: String,
+      required: true
+    }
+  },
+  data() {
+    return {
+      fieldDirtyStatuses: {},
+      fieldValidations: {}
+    };
+  },
+  computed: {
+    formElement() {
+      return document.getElementById(this.formId);
+    },
+    fieldValidationProps() {
+      return mapValues(this.fields, (_, fieldName) => {
+        const invalidFeedback = this.fieldValidations[fieldName] || '';
+        return {
+          invalidFeedback,
+          state: invalidFeedback ? false : null
+        };
+      });
+    },
+    fieldValues() {
+      return mapValues(this.fields, (_, fieldName) => {
+        if (fieldName in this.values) {
+          return this.values[fieldName];
+        }
+        return this.getMappedValue(fieldName, undefined);
+      });
+    },
+    fieldNames() {
+      return Object.keys(this.fields);
+    },
+    fieldsToRender() {
+      return mapValues(this.fields, (field, fieldName) => {
+        const id = uniqueId('gl-form-field-');
+        const scopedSlotName = `input(${fieldName})`;
+        const hasScopedSlot = this.$scopedSlots[scopedSlotName];
+        const scopedSlotAttrs = hasScopedSlot && {
+          value: this.fieldValues[fieldName],
+          input: val => this.onFieldInput(fieldName, val),
+          blur: () => this.onFieldBlur(fieldName),
+          validation: this.fieldValidationProps[fieldName],
+          id
+        };
+        return {
+          ...field,
+          id,
+          label: field.label || fieldName,
+          scopedSlotName,
+          scopedSlotAttrs
+        };
+      });
+    }
+  },
+  mounted() {
+    var _this$formElement;
+    // why: We emit initial values as a convenience so that `v-model="values"` can be easily initialized.
+    this.$emit('input', this.fieldValues);
+    (_this$formElement = this.formElement) === null || _this$formElement === void 0 ? void 0 : _this$formElement.addEventListener('submit', this.onFormSubmission);
+  },
+  destroyed() {
+    var _this$formElement2;
+    (_this$formElement2 = this.formElement) === null || _this$formElement2 === void 0 ? void 0 : _this$formElement2.removeEventListener('submit', this.onFormSubmission);
+  },
+  methods: {
+    setFieldDirty(fieldName) {
+      this.$set(this.fieldDirtyStatuses, fieldName, true);
+    },
+    setAllFieldsDirty() {
+      this.fieldNames.forEach(fieldName => this.setFieldDirty(fieldName));
+    },
+    hasAllFieldsValid() {
+      // note: Only check "fieldNames" since "fields" could have changed since the life of "fieldValidations"
+      return this.fieldNames.every(fieldName => !this.fieldValidations[fieldName]);
+    },
+    async checkBeforeSubmission() {
+      this.setAllFieldsDirty();
+      await this.$nextTick();
+      return this.hasAllFieldsValid();
+    },
+    getMappedValue(fieldName, val) {
+      const field = this.fields[fieldName];
+      if (isFunction(field === null || field === void 0 ? void 0 : field.mapValue)) {
+        return field.mapValue(val);
+      }
+      return val;
+    },
+    onFieldValidationUpdate(fieldName, invalidFeedback) {
+      this.$set(this.fieldValidations, fieldName, invalidFeedback);
+    },
+    onFieldBlur(fieldName) {
+      this.setFieldDirty(fieldName);
+    },
+    onFieldInput(fieldName, inputValue) {
+      const val = this.getMappedValue(fieldName, inputValue);
+
+      /**
+       * Emitted when any of the form values change. Used by `v-model`.
+       */
+      this.$emit('input', {
+        ...this.values,
+        [fieldName]: val
+      });
+
+      /**
+       * Emitted when a form input emits the `input` event.
+       */
+      this.$emit('input-field', {
+        name: fieldName,
+        value: val
+      });
+    },
+    async onFormSubmission(e) {
+      e.preventDefault();
+      const isValid = await this.checkBeforeSubmission();
+      if (isValid) {
+        /**
+         * Emitted when the form is submitted and all of the form fields are valid.
+         */
+        this.$emit('submit', e);
+      }
+    }
+  }
+};
+
+/* script */
+const __vue_script__ = script;
+
+/* template */
+var __vue_render__ = function () {var _vm=this;var _h=_vm.$createElement;var _c=_vm._self._c||_h;return _c('div',_vm._l((_vm.fieldsToRender),function(field,fieldName){return _c('gl-form-group',{key:fieldName,attrs:{"label":field.label,"label-for":field.id,"invalid-feedback":_vm.fieldValidationProps[fieldName].invalidFeedback,"state":_vm.fieldValidationProps[fieldName].state}},[_c('gl-form-field-validator',{attrs:{"value":_vm.fieldValues[fieldName],"validators":field.validators,"should-validate":_vm.fieldDirtyStatuses[fieldName]},on:{"update":function($event){return _vm.onFieldValidationUpdate(fieldName, $event)}}}),_vm._v(" "),(field.scopedSlotAttrs)?[_vm._t(field.scopedSlotName,null,null,field.scopedSlotAttrs)]:[_c('gl-form-input',_vm._b({attrs:{"id":field.id,"value":_vm.fieldValues[fieldName],"state":_vm.fieldValidationProps[fieldName].state},on:{"input":function($event){return _vm.onFieldInput(fieldName, $event)},"blur":function($event){return _vm.onFieldBlur(fieldName)}}},'gl-form-input',field.inputAttrs,false))]],2)}),1)};
+var __vue_staticRenderFns__ = [];
+
+  /* style */
+  const __vue_inject_styles__ = undefined;
+  /* scoped */
+  const __vue_scope_id__ = undefined;
+  /* module identifier */
+  const __vue_module_identifier__ = undefined;
+  /* functional template */
+  const __vue_is_functional_template__ = false;
+  /* style inject */
+  
+  /* style inject SSR */
+  
+  /* style inject shadow dom */
+  
+
+  
+  const __vue_component__ = __vue_normalize__(
+    { render: __vue_render__, staticRenderFns: __vue_staticRenderFns__ },
+    __vue_inject_styles__,
+    __vue_script__,
+    __vue_scope_id__,
+    __vue_is_functional_template__,
+    __vue_module_identifier__,
+    false,
+    undefined,
+    undefined,
+    undefined
+  );
+
+export default __vue_component__;

package/dist/components/base/form/form_fields/mappers.js

@@ -0,0 +1,13 @@
+// This contains core mapping behavior (like mapping to native JavaScript types)
+// and**should not** contain domain-specific mappers.
+//
+// ```
+// // Good
+// export const mapToBoolean = ...
+//
+// // Bad
+// export const mapToApolloCacheWidget = ...
+// ```
+const mapToNumber = x => Number(x || 0);
+
+export { mapToNumber };

package/dist/components/base/form/form_fields/validators.js

@@ -0,0 +1,16 @@
+// This contains core validating behavior and **should not** contain
+// domain-specific validations.
+//
+// Look to what's allowed in HTML attributes as a good basis for what belongs here
+//
+// ```
+// // Good
+// export const required = ...
+//
+// // Bad
+// export const projectPathIsUnique = ...
+// ```
+const factory = (failMessage, isValid) => val => !isValid(val) ? failMessage : '';
+const required = failMessage => factory(failMessage, val => val !== '' && val !== null && val !== undefined);
+
+export { factory, required };

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

@@ -145,7 +145,7 @@ var __vue_render__ = function () {var _vm=this;var _h=_vm.$createElement;var _c=
       'gl-toggle': true,
       'is-checked': _vm.value,
       'is-disabled': _vm.disabled,
-    },attrs:{"role":"switch","aria-checked":_vm.isChecked,"aria-labelledby":_vm.labelId,"aria-describedby":_vm.helpId,"type":"button"},on:{"click":function($event){$event.preventDefault();return _vm.toggleFeature.apply(null, arguments)}}},[(_vm.isLoading)?_c('gl-loading-icon',{staticClass:"toggle-loading",attrs:{"color":"light"}}):_c('span',{class:{ 'toggle-icon': true, disabled: _vm.disabled }},[_c('gl-icon',{attrs:{"name":_vm.icon,"size":16}})],1)],1),_vm._v(" "),(_vm.shouldRenderHelp)?_c('span',{staticClass:"gl-help-label",attrs:{"id":_vm.helpId,"data-testid":"toggle-help"}},[_vm._t("help",function(){return [_vm._v(_vm._s(_vm.help))]})],2):_vm._e()])};
+    },attrs:{"role":"switch","aria-checked":_vm.isChecked,"aria-labelledby":_vm.labelId,"aria-describedby":_vm.helpId,"aria-disabled":_vm.disabled,"type":"button"},on:{"click":function($event){$event.preventDefault();return _vm.toggleFeature.apply(null, arguments)}}},[(_vm.isLoading)?_c('gl-loading-icon',{staticClass:"toggle-loading",attrs:{"color":"light"}}):_c('span',{class:{ 'toggle-icon': true, disabled: _vm.disabled }},[_c('gl-icon',{attrs:{"name":_vm.icon,"size":16}})],1)],1),_vm._v(" "),(_vm.shouldRenderHelp)?_c('span',{staticClass:"gl-help-label",attrs:{"id":_vm.helpId,"data-testid":"toggle-help"}},[_vm._t("help",function(){return [_vm._v(_vm._s(_vm.help))]})],2):_vm._e()])};
 var __vue_staticRenderFns__ = [];
 
   /* style */

package/dist/index.js

@@ -37,6 +37,7 @@ export { default as GlFormRadioGroup } from './components/base/form/form_radio_g
 export { default as GlFormSelect } from './components/base/form/form_select/form_select';
 export { default as GlFormTextarea } from './components/base/form/form_textarea/form_textarea';
 export { default as GlFormGroup } from './components/base/form/form_group/form_group';
+export { default as GlFormFields } from './components/base/form/form_fields/form_fields';
 export { default as GlSearchBoxByType } from './components/base/search_box_by_type/search_box_by_type';
 export { default as GlSearchBoxByClick } from './components/base/search_box_by_click/search_box_by_click';
 export { default as GlDropdownItem } from './components/base/dropdown/dropdown_item';

package/dist/utils.js

@@ -1 +1,5 @@
 export { GlBreakpointInstance, breakpoints } from './utils/breakpoints';
+import * as validators from './components/base/form/form_fields/validators';
+export { validators as formValidators };
+import * as mappers from './components/base/form/form_fields/mappers';
+export { mappers as formMappers };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitlab/ui",
-  "version": "62.5.1",
+  "version": "62.6.0",
   "description": "GitLab UI Components",
   "license": "MIT",
   "main": "dist/index.js",
@@ -83,8 +83,8 @@
   },
   "devDependencies": {
     "@arkweid/lefthook": "0.7.7",
-    "@babel/core": "^7.21.4",
-    "@babel/preset-env": "^7.21.4",
+    "@babel/core": "^7.21.5",
+    "@babel/preset-env": "^7.21.5",
     "@babel/preset-react": "^7.18.6",
     "@gitlab/eslint-plugin": "19.0.0",
     "@gitlab/fonts": "^1.2.0",
@@ -116,9 +116,9 @@
     "babel-loader": "^8.0.5",
     "babel-plugin-require-context-hook": "^1.0.0",
     "bootstrap": "4.6.2",
-    "cypress": "12.10.0",
+    "cypress": "12.11.0",
     "emoji-regex": "^10.0.0",
-    "eslint": "8.38.0",
+    "eslint": "8.39.0",
     "eslint-import-resolver-jest": "3.0.2",
     "eslint-plugin-cypress": "2.13.2",
     "eslint-plugin-storybook": "0.6.11",

package/src/components/base/form/form_fields/form_field_validator.spec.js

@@ -0,0 +1,51 @@
+import { mount } from '@vue/test-utils';
+import GlFormFieldValidator from './form_field_validator.vue';
+import { required } from './validators';
+
+const TEST_VALUE = 'root';
+const TEST_MESSAGE = 'this is a required field';
+
+describe('GlFormFieldValidators', () => {
+  let wrapper;
+
+  const createWrapper = (props = {}) => {
+    wrapper = mount(GlFormFieldValidator, {
+      propsData: {
+        value: TEST_VALUE,
+        validators: [required(TEST_MESSAGE)],
+        shouldValidate: true,
+        ...props,
+      },
+    });
+  };
+  it('should call validators with value prop', () => {
+    const validators = [jest.fn(), jest.fn(), jest.fn()];
+
+    createWrapper({ validators });
+
+    validators.forEach((validator) => expect(validator).toHaveBeenCalledWith(TEST_VALUE));
+  });
+  it('should not call validators when told not to', () => {
+    const validators = [jest.fn(), jest.fn(), jest.fn()];
+
+    createWrapper({ validators, shouldValidate: false });
+
+    validators.forEach((validator) => expect(validator).not.toHaveBeenCalledWith(TEST_VALUE));
+  });
+
+  it('should not render anything ever forever', () => {
+    createWrapper();
+
+    expect(wrapper.html()).toBe('');
+  });
+
+  it('should emit update with result of validator', async () => {
+    createWrapper();
+
+    expect(wrapper.emitted('update')).toBeUndefined();
+
+    await wrapper.setProps({ value: '' });
+
+    expect(wrapper.emitted('update')).toEqual([[TEST_MESSAGE]]);
+  });
+});

package/src/components/base/form/form_fields/form_field_validator.vue

@@ -0,0 +1,59 @@
+<script>
+/**
+ * FormFieldValidator
+ *
+ * This is an internal component which is used to watch on specific field/value
+ * pairs and emits changes to `invalidFeedback`.
+ *
+ * **why:** Without this separate component, *any* change to *any* value
+ * was causing *all* validators to run. A separate renderless component
+ * helps us isolate this logic *and* react only to what we need to.
+ */
+export default {
+  name: 'GlFormFieldValidator',
+  props: {
+    value: {
+      required: true,
+      // ESLint requires "validator" or "type". Any kind of value is valid.
+      validator: () => true,
+    },
+    validators: {
+      type: Array,
+      required: false,
+      default: () => [],
+    },
+    shouldValidate: {
+      type: Boolean,
+      required: false,
+      default: false,
+    },
+  },
+  computed: {
+    invalidFeedback() {
+      if (!this.shouldValidate) {
+        return '';
+      }
+
+      const result = this.validators.reduce((acc, validateFn) => {
+        // If we already have an invalid message, let's just use that one.
+        if (acc) {
+          return acc;
+        }
+
+        return validateFn(this.value);
+      }, '');
+
+      // Force falsey string for type consistency.
+      return result || '';
+    },
+  },
+  watch: {
+    invalidFeedback(newVal) {
+      this.$emit('update', newVal);
+    },
+  },
+  render() {
+    return null;
+  },
+};
+</script>

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

@@ -0,0 +1,28 @@
+## Usage
+
+`GlFormFields` provides form builder functionality for ease of building simple
+forms out of other GitLab UI form components.
+
+For a code example, look at the story. It covers usage of `mapValue`, `validators`,
+custom form elements, and `inputAttrs`.
+
+## Fields type
+
+Each value of `fields` prop is expected to be a `FieldDefinition`. See below for the shape of this type:
+
+```ts
+interface FieldDefinition<TValue> {
+  // Label text to show for this field.
+  label: string;
+
+  // Collection of validator functions
+  validators?: Array<(value: TValue) => string | undefined>;
+
+  // Function that maps the inputted string value to the field's actual value
+  // (e.g. a Number).
+  mapValue?: (input: string) => TValue;
+
+  // Properties that are passed to the actual input for this field.
+  inputAttrs?: {};
+}
+```