@coreui/vue-pro 4.2.0 → 4.3.0

package/src/components/form/CFormInput.ts

@@ -1,4 +1,5 @@
 import { defineComponent, h } from 'vue'
+import { CFormControlWrapper } from './CFormControlWrapper'
 
 const CFormInput = defineComponent({
   name: 'CFormInput',
@@ -10,12 +11,57 @@ const CFormInput = defineComponent({
       type: Boolean,
       required: false,
     },
+
+    // Inherited Props from CFormControlWrapper
+    /**
+     * Provide valuable, actionable feedback.
+     *
+     * @since 4.3.0
+     */
+    feedback: {
+      type: String,
+    },
+    /**
+     * Provide valuable, actionable feedback.
+     *
+     * @since 4.3.0
+     */
+    feedbackInvalid: {
+      type: String,
+    },
+    /**
+     * Provide valuable, actionable invalid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`.
+     *
+     * @since 4.3.0
+     */
+    feedbackValid: {
+      type: String,
+    },
+    /**
+     * Provide valuable, actionable valid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`.
+     *
+     * @since 4.3.0
+     */
+    floatingLabel: {
+      type: String,
+    },
+    /**
+     * The id global attribute defines an identifier (ID) that must be unique in the whole document.
+     */
+    id: {
+      type: String,
+    },
     /**
      * Set component validation state to invalid.
      */
-    invalid: {
-      type: Boolean,
-      required: false,
+    invalid: Boolean,
+    /**
+     * Add a caption for a component.
+     *
+     * @since 4.3.0
+     */
+    label: {
+      type: String,
     },
     /**
      * The default name for a value passed using v-model.
@@ -23,7 +69,6 @@ const CFormInput = defineComponent({
     modelValue: {
       type: String,
       default: undefined,
-      require: false,
     },
     /**
      * Render the component styled as plain text. Removes the default form field styling and preserve the correct margin and padding. Recommend to use only along side `readonly`.
@@ -46,12 +91,24 @@ const CFormInput = defineComponent({
      */
     size: {
       type: String,
-      default: undefined,
-      require: false,
       validator: (value: string) => {
         return ['sm', 'lg'].includes(value)
       },
     },
+    /**
+     * Add helper text to the component.
+     *
+     * @since 4.3.0
+     */
+    text: {
+      type: String,
+    },
+    /**
+     * Display validation feedback in a styled tooltip.
+     *
+     * @since 4.3.0
+     */
+    tooltipFeedback: Boolean,
     /**
      * Specifies the type of component.
      *
@@ -60,15 +117,11 @@ const CFormInput = defineComponent({
     type: {
       type: String,
       default: 'text',
-      require: false,
     },
     /**
      * Set component validation state to valid.
      */
-    valid: {
-      type: Boolean,
-      required: false,
-    },
+    valid: Boolean,
   },
   emits: [
     /**
@@ -84,12 +137,13 @@ const CFormInput = defineComponent({
      */
     'update:modelValue',
   ],
-  setup(props, { emit, slots }) {
+  setup(props, { attrs, emit, slots }) {
     const handleChange = (event: InputEvent) => {
       const target = event.target as HTMLInputElement
       emit('change', event)
       emit('update:modelValue', target.value)
     }
+
     const handleInput = (event: InputEvent) => {
       const target = event.target as HTMLInputElement
       emit('input', event)
@@ -98,25 +152,55 @@ const CFormInput = defineComponent({
 
     return () =>
       h(
-        'input',
+        CFormControlWrapper,
+        {
+          describedby: attrs['aria-describedby'],
+          feedback: props.feedback,
+          feedbackInvalid: props.feedbackInvalid,
+          feedbackValid: props.feedbackValid,
+          floatingLabel: props.floatingLabel,
+          id: props.id,
+          invalid: props.invalid,
+          label: props.label,
+          text: props.text,
+          tooltipFeedback: props.tooltipFeedback,
+          valid: props.valid,
+        },
         {
-          class: [
-            props.plainText ? 'form-control-plaintext' : 'form-control',
-            {
-              'form-control-color': props.type === 'color',
-              [`form-control-${props.size}`]: props.size,
-              'is-invalid': props.invalid,
-              'is-valid': props.valid,
-            },
-          ],
-          disabled: props.disabled,
-          onChange: (event: InputEvent) => handleChange(event),
-          onInput: (event: InputEvent) => handleInput(event),
-          readonly: props.readonly,
-          type: props.type,
-          value: props.modelValue,
+          default: () =>
+            h(
+              'input',
+              {
+                ...attrs,
+                class: [
+                  props.plainText ? 'form-control-plaintext' : 'form-control',
+                  {
+                    'form-control-color': props.type === 'color',
+                    [`form-control-${props.size}`]: props.size,
+                    'is-invalid': props.invalid,
+                    'is-valid': props.valid,
+                  },
+                  attrs.class,
+                ],
+                disabled: props.disabled,
+                onChange: (event: InputEvent) => handleChange(event),
+                onInput: (event: InputEvent) => handleInput(event),
+                readonly: props.readonly,
+                type: props.type,
+                ...(props.modelValue && { value: props.modelValue }),
+              },
+              slots.default && slots.default(),
+            ),
+          ...(slots.feedback && { feedback: () => slots.feedback && slots.feedback() }),
+          ...(slots.feedbackInvalid && {
+            feedbackInvalid: () => slots.feedbackInvalid && slots.feedbackInvalid(),
+          }),
+          ...(slots.feedbackValid && {
+            feedbackValid: () => slots.feedbackInvalid && slots.feedbackInvalid(),
+          }),
+          ...(slots.label && { label: () => slots.label && slots.label() }),
+          ...(slots.text && { text: () => slots.text && slots.text() }),
         },
-        slots.default && slots.default(),
       )
   },
 })

package/src/components/form/CFormRange.ts

@@ -1,4 +1,5 @@
 import { defineComponent, h } from 'vue'
+import { CFormLabel } from './CFormLabel'
 
 const CFormRange = defineComponent({
   name: 'CFormRange',
@@ -9,7 +10,14 @@ const CFormRange = defineComponent({
     disabled: {
       type: Boolean,
       default: undefined,
-      required: false,
+    },
+    /**
+     * Add a caption for a component.
+     *
+     * @since 4.3.0
+     */
+    label: {
+      type: String,
     },
     /**
      * Specifies the maximum value for the component.
@@ -17,7 +25,6 @@ const CFormRange = defineComponent({
     max: {
       type: Number,
       default: undefined,
-      required: false,
     },
     /**
      * Specifies the minimum value for the component.
@@ -25,7 +32,6 @@ const CFormRange = defineComponent({
     min: {
       type: Number,
       default: undefined,
-      required: false,
     },
     /**
      * The default name for a value passed using v-model.
@@ -33,14 +39,12 @@ const CFormRange = defineComponent({
     modelValue: {
       type: String,
       value: undefined,
-      required: false,
     },
     /**
      * Toggle the readonly state for the component.
      */
     readonly: {
       type: Boolean,
-      required: false,
     },
     /**
      * Specifies the interval between legal numbers in the component.
@@ -48,7 +52,6 @@ const CFormRange = defineComponent({
     steps: {
       type: Number,
       default: undefined,
-      required: false,
     },
     /**
      * The `value` attribute of component.
@@ -58,7 +61,6 @@ const CFormRange = defineComponent({
     value: {
       type: Number,
       default: undefined,
-      required: false,
     },
   },
   emits: [
@@ -71,29 +73,41 @@ const CFormRange = defineComponent({
      */
     'update:modelValue',
   ],
-  setup(props, { emit, slots }) {
+  setup(props, { attrs, emit, slots }) {
     const handleChange = (event: InputEvent) => {
       const target = event.target as HTMLInputElement
       emit('change', event)
       emit('update:modelValue', target.value)
     }
 
-    return () =>
+    return () => [
+      props.label &&
+        h(
+          CFormLabel,
+          {
+            for: attrs.id,
+          },
+          {
+            default: () => (slots.label && slots.label()) || props.label,
+          },
+        ),
       h(
         'input',
         {
+          ...attrs,
           class: 'form-range',
           disabled: props.disabled,
           max: props.max,
           min: props.min,
           onChange: (event: InputEvent) => handleChange(event),
-          steps: props.steps,
           readonly: props.readonly,
+          steps: props.steps,
           type: 'range',
           value: props.modelValue,
         },
         slots.default && slots.default(),
-      )
+      ),
+    ]
   },
 })
 

package/src/components/form/CFormSelect.ts

@@ -1,4 +1,5 @@
 import { defineComponent, h, PropType } from 'vue'
+import { CFormControlWrapper } from './CFormControlWrapper'
 
 type Option = {
   disabled?: boolean
@@ -10,6 +11,38 @@ type Option = {
 const CFormSelect = defineComponent({
   name: 'CFormSelect',
   props: {
+    /**
+     * Provide valuable, actionable feedback.
+     *
+     * @since 4.3.0
+     */
+    feedback: {
+      type: String,
+    },
+    /**
+     * Provide valuable, actionable feedback.
+     *
+     * @since 4.3.0
+     */
+    feedbackInvalid: {
+      type: String,
+    },
+    /**
+     * Provide valuable, actionable invalid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`.
+     *
+     * @since 4.3.0
+     */
+    feedbackValid: {
+      type: String,
+    },
+    /**
+     * Provide valuable, actionable valid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`.
+     *
+     * @since 4.3.0
+     */
+    floatingLabel: {
+      type: String,
+    },
     /**
      * Specifies the number of visible options in a drop-down list.
      */
@@ -18,12 +51,23 @@ const CFormSelect = defineComponent({
       default: undefined,
       required: false,
     },
+    /**
+     * The id global attribute defines an identifier (ID) that must be unique in the whole document.
+     */
+    id: {
+      type: String,
+    },
     /**
      * Set component validation state to invalid.
      */
-    invalid: {
-      type: Boolean,
-      required: false,
+    invalid: Boolean,
+    /**
+     * Add a caption for a component.
+     *
+     * @since 4.3.0
+     */
+    label: {
+      type: String,
     },
     /**
      * The default name for a value passed using v-model.
@@ -62,12 +106,23 @@ const CFormSelect = defineComponent({
       },
     },
     /**
-     * Set component validation state to valid.
+     * Add helper text to the component.
+     *
+     * @since 4.3.0
      */
-    valid: {
-      type: Boolean,
-      required: false,
+    text: {
+      type: String,
     },
+    /**
+     * Display validation feedback in a styled tooltip.
+     *
+     * @since 4.3.0
+     */
+    tooltipFeedback: Boolean,
+    /**
+     * Set component validation state to valid.
+     */
+    valid: Boolean,
   },
   emits: [
     /**
@@ -79,7 +134,7 @@ const CFormSelect = defineComponent({
      */
     'update:modelValue',
   ],
-  setup(props, { emit, slots }) {
+  setup(props, { attrs, emit, slots }) {
     const handleChange = (event: InputEvent) => {
       const target = event.target as HTMLSelectElement
       const selected = Array.from(target.options)
@@ -91,41 +146,71 @@ const CFormSelect = defineComponent({
 
     return () =>
       h(
-        'select',
+        CFormControlWrapper,
+        {
+          describedby: attrs['aria-describedby'],
+          feedback: props.feedback,
+          feedbackInvalid: props.feedbackInvalid,
+          feedbackValid: props.feedbackValid,
+          floatingLabel: props.floatingLabel,
+          id: props.id,
+          invalid: props.invalid,
+          label: props.label,
+          text: props.text,
+          tooltipFeedback: props.tooltipFeedback,
+          valid: props.valid,
+        },
         {
-          class: [
-            'form-select',
-            {
-              [`form-select-${props.size}`]: props.size,
-              'is-invalid': props.invalid,
-              'is-valid': props.valid,
-            },
-          ],
-          multiple: props.multiple,
-          onChange: (event: InputEvent) => handleChange(event),
-          size: props.htmlSize,
-          ...(props.modelValue && !props.multiple && { value: props.modelValue }),
+          default: () =>
+            h(
+              'select',
+              {
+                ...attrs,
+                class: [
+                  'form-select',
+                  {
+                    [`form-select-${props.size}`]: props.size,
+                    'is-invalid': props.invalid,
+                    'is-valid': props.valid,
+                  },
+                  attrs.class,
+                ],
+                multiple: props.multiple,
+                onChange: (event: InputEvent) => handleChange(event),
+                size: props.htmlSize,
+                ...(props.modelValue && !props.multiple && { value: props.modelValue }),
+              },
+              props.options
+                ? props.options.map((option: Option | string) => {
+                    return h(
+                      'option',
+                      {
+                        ...(typeof option === 'object' && {
+                          ...(option.disabled && { disabled: option.disabled }),
+                          ...(option.selected && { selected: option.selected }),
+                          ...(option.value && {
+                            value: option.value,
+                            ...(props.modelValue &&
+                              props.multiple &&
+                              props.modelValue.includes(option.value) && { selected: true }),
+                          }),
+                        }),
+                      },
+                      typeof option === 'string' ? option : option.label,
+                    )
+                  })
+                : slots.default && slots.default(),
+            ),
+          ...(slots.feedback && { feedback: () => slots.feedback && slots.feedback() }),
+          ...(slots.feedbackInvalid && {
+            feedbackInvalid: () => slots.feedbackInvalid && slots.feedbackInvalid(),
+          }),
+          ...(slots.feedbackValid && {
+            feedbackValid: () => slots.feedbackInvalid && slots.feedbackInvalid(),
+          }),
+          ...(slots.label && { label: () => slots.label && slots.label() }),
+          ...(slots.text && { text: () => slots.text && slots.text() }),
         },
-        props.options
-          ? props.options.map((option: Option | string) => {
-              return h(
-                'option',
-                {
-                  ...(typeof option === 'object' && {
-                    ...(option.disabled && { disabled: option.disabled }),
-                    ...(option.selected && { selected: option.selected }),
-                    ...(option.value && {
-                      value: option.value,
-                      ...(props.modelValue &&
-                        props.multiple &&
-                        props.modelValue.includes(option.value) && { selected: true }),
-                    }),
-                  }),
-                },
-                typeof option === 'string' ? option : option.label,
-              )
-            })
-          : slots.default && slots.default(),
       )
   },
 })

package/src/components/form/CFormSwitch.ts

@@ -1,4 +1,4 @@
-import { defineComponent, h, watch, ref } from 'vue'
+import { defineComponent, h } from 'vue'
 
 import { CFormLabel } from './CFormLabel'
 
@@ -11,23 +11,18 @@ const CFormSwitch = defineComponent({
      */
     id: {
       type: String,
-      default: undefined,
-      required: false,
     },
     /**
      * Set component validation state to invalid.
      */
     invalid: {
       type: Boolean,
-      required: false,
     },
     /**
      * The element represents a caption for a component.
      */
     label: {
       type: String,
-      default: undefined,
-      required: false,
     },
     /**
      * The default name for a value passed using v-model.
@@ -35,7 +30,6 @@ const CFormSwitch = defineComponent({
     modelValue: {
       type: [Boolean, String],
       value: undefined,
-      required: false,
     },
     /**
      * Size the component large or extra large. Works only with `switch`.
@@ -44,8 +38,6 @@ const CFormSwitch = defineComponent({
      */
     size: {
       type: String,
-      default: undefined,
-      required: false,
       validator: (value: string) => {
         return ['lg', 'xl'].includes(value)
       },
@@ -58,14 +50,12 @@ const CFormSwitch = defineComponent({
     type: {
       type: String,
       default: 'checkbox',
-      required: false,
     },
     /**
      * Set component validation state to valid.
      */
     valid: {
       type: Boolean,
-      required: false,
     },
   },
   emits: [
@@ -79,15 +69,6 @@ const CFormSwitch = defineComponent({
     'update:modelValue',
   ],
   setup(props, { attrs, emit }) {
-    const checked = ref(attrs.checked)
-
-    watch(
-      () => props.modelValue,
-      () => {
-        if (typeof props.modelValue === 'boolean') checked.value = props.modelValue
-      },
-    )
-
     const handleChange = (event: InputEvent) => {
       const target = event.target as HTMLInputElement
       emit('change', event)
@@ -110,7 +91,7 @@ const CFormSwitch = defineComponent({
         [
           h('input', {
             ...attrs,
-            checked: checked.value,
+            ...(props.modelValue && { checked: props.modelValue }),
             class: [
               'form-check-input',
               {