@coreui/vue-pro 5.0.0-alpha.0 → 5.0.0-alpha.1

package/src/components/dropdown/utils.ts

@@ -0,0 +1,71 @@
+import type { Placement } from '@popperjs/core'
+import type { Placements } from '../../types'
+import type { Alignments } from './types'
+
+export const getAlignmentClassNames = (alignment: object | string) => {
+  const classNames: string[] = []
+  if (typeof alignment === 'object') {
+    Object.keys(alignment).map((key) => {
+      classNames.push(`dropdown-menu${key === 'xs' ? '' : `-${key}`}-${alignment[key]}`)
+    })
+  }
+
+  if (typeof alignment === 'string') {
+    classNames.push(`dropdown-menu-${alignment}`)
+  }
+
+  return classNames
+}
+
+export const getNextActiveElement = (
+  list: HTMLElement[],
+  activeElement: HTMLElement,
+  shouldGetNext: boolean,
+  isCycleAllowed: boolean,
+) => {
+  const listLength = list.length
+  let index = list.indexOf(activeElement)
+
+  if (index === -1) {
+    return !shouldGetNext && isCycleAllowed ? list[listLength - 1] : list[0]
+  }
+
+  index += shouldGetNext ? 1 : -1
+
+  if (isCycleAllowed) {
+    index = (index + listLength) % listLength
+  }
+
+  return list[Math.max(0, Math.min(index, listLength - 1))]
+}
+
+export const getPlacement = (
+  placement: Placement,
+  direction: string | undefined,
+  alignment: Alignments | string | undefined,
+  isRTL: boolean,
+): Placements => {
+  let _placement = placement
+
+  if (direction === 'dropup') {
+    _placement = isRTL ? 'top-end' : 'top-start'
+  }
+
+  if (direction === 'dropup-center') {
+    _placement = 'top'
+  }
+
+  if (direction === 'dropend') {
+    _placement = isRTL ? 'left-start' : 'right-start'
+  }
+
+  if (direction === 'dropstart') {
+    _placement = isRTL ? 'right-start' : 'left-start'
+  }
+
+  if (alignment === 'end') {
+    _placement = isRTL ? 'bottom-start' : 'bottom-end'
+  }
+
+  return _placement
+}

package/src/components/form/CFormCheck.ts

@@ -17,7 +17,7 @@ const CFormCheck = defineComponent({
     /**
      * Use in conjunction with the v-model directive to specify the value that should be assigned to the bound variable when the checkbox is in the `false` state.
      *
-     * @since 4.9.0
+     * @since 4.10.0
      */
     falseValue: String,
     /**
@@ -90,7 +90,7 @@ const CFormCheck = defineComponent({
     /**
      * Use in conjunction with the v-model directive to specify the value that should be assigned to the bound variable when the checkbox is in the `true` state.
      *
-     * @since 4.9.0
+     * @since 4.10.0
      */
     trueValue: String,
     /**
@@ -189,7 +189,7 @@ const CFormCheck = defineComponent({
     const formControl = () => {
       return h('input', {
         ...attrs,
-        ...(props.modelValue && props.value && { checked: isChecked.value }),
+        ...((props.modelValue || props.value) && { checked: isChecked.value }),
         class: inputClassName,
         id: props.id,
         indeterminate: props.indeterminate,
@@ -259,4 +259,4 @@ const CFormCheck = defineComponent({
   },
 })
 
-export { CFormCheck }
+export { CFormCheck }

package/src/components/modal/CModal.ts

@@ -51,6 +51,15 @@ const CModal = defineComponent({
      * A string of all className you want applied to the modal content component.
      */
     contentClassName: String,
+    /**
+     * Puts the focus on the modal when shown.
+     *
+     * @since v5.0.0-alpha.1
+     */
+    focus: {
+      type: Boolean,
+      default: true,
+    },
     /**
      * Set modal to covers the entire user viewport
      *
@@ -124,6 +133,7 @@ const CModal = defineComponent({
     'show',
   ],
   setup(props, { slots, attrs, emit }) {
+    const activeElementRef = ref()
     const modalRef = ref()
     const modalContentRef = ref()
     const visible = ref(props.visible)
@@ -136,6 +146,7 @@ const CModal = defineComponent({
     )
 
     const handleEnter = (el: RendererElement, done: () => void) => {
+      activeElementRef.value = document.activeElement as HTMLElement | null
       executeAfterTransition(() => done(), el as HTMLElement)
       document.body.classList.add('modal-open')
       document.body.style.overflow = 'hidden'
@@ -148,6 +159,7 @@ const CModal = defineComponent({
     }
 
     const handleAfterEnter = () => {
+      props.focus && modalRef.value?.focus()
       window.addEventListener('mousedown', handleMouseDown)
       window.addEventListener('keyup', handleKeyUp)
     }
@@ -166,6 +178,7 @@ const CModal = defineComponent({
     }
 
     const handleAfterLeave = (el: RendererElement) => {
+      activeElementRef.value?.focus()
       window.removeEventListener('mousedown', handleMouseDown)
       window.removeEventListener('keyup', handleKeyUp)
       el.style.display = 'none'
@@ -217,6 +230,7 @@ const CModal = defineComponent({
       h(
         'div',
         {
+          ...attrs,
           class: [
             'modal',
             {
@@ -224,6 +238,7 @@ const CModal = defineComponent({
             },
             attrs.class,
           ],
+          ...(visible.value ? { 'aria-modal': true, role: 'dialog' } : { 'aria-hidden': 'true' }),
           ref: modalRef,
         },
         h(
@@ -240,7 +255,6 @@ const CModal = defineComponent({
                 [`modal-${props.size}`]: props.size,
               },
             ],
-            role: 'dialog',
           },
           h(
             'div',

package/src/components/multi-select/CMultiSelect.ts

@@ -298,7 +298,7 @@ const CMultiSelect = defineComponent({
       if (
         props.allowCreateOptions &&
         filteredOptions.value.some(
-          (option) => option.text && option.text.toLowerCase() === searchValue.value.toLowerCase(),
+          (option) => option.label && option.label.toLowerCase() === searchValue.value.toLowerCase(),
         )
       ) {
         return false
@@ -425,7 +425,7 @@ const CMultiSelect = defineComponent({
           selected.value = [
             ...selected.value,
             filteredOptions.value.find(
-              (option) => String(option.text).toLowerCase() === searchValue.value.toLowerCase(),
+              (option) => String(option.label).toLowerCase() === searchValue.value.toLowerCase(),
             ) as Option,
           ]
         }
@@ -458,7 +458,7 @@ const CMultiSelect = defineComponent({
 
     const handleOptionClick = (option: Option) => {
       if (!props.multiple) {
-        selected.value = [{ value: option.value, text: option.text }] as SelectedOption[]
+        selected.value = [option] as SelectedOption[]
         visible.value = false
 
         if (searchRef.value) {
@@ -483,10 +483,7 @@ const CMultiSelect = defineComponent({
       if (selected.value.some((_option) => _option.value === option.value)) {
         selected.value = selected.value.filter((_option) => _option.value !== option.value)
       } else {
-        selected.value = [
-          ...selected.value,
-          { value: option.value, text: option.text },
-        ] as SelectedOption[]
+        selected.value = [...selected.value, option] as SelectedOption[]
       }
     }
 
@@ -592,7 +589,7 @@ const CMultiSelect = defineComponent({
                                   }),
                                 ...(selected.value.length > 0 &&
                                   !props.multiple && {
-                                    placeholder: selected.value.map((option) => option.text)[0],
+                                    placeholder: selected.value.map((option) => option.label)[0],
                                   }),
 
                                 ...(props.multiple &&

package/src/components/multi-select/CMultiSelectOptions.ts

@@ -94,7 +94,7 @@ const CMultiSelectOptions = defineComponent({
                   },
                   props.scopedSlots && props.scopedSlots['options']
                     ? h(props.scopedSlots['options'], { option: option })
-                    : option.text,
+                    : option.label,
                 )
               : [
                   h(

package/src/components/multi-select/CMultiSelectSelection.ts

@@ -59,7 +59,7 @@ const CMultiSelectSelection = defineComponent({
             props.selected.map((option: Option) => {
               if (props.selectionType === 'tags') {
                 return h('span', { class: 'form-multi-select-tag' }, [
-                  option.text,
+                  option.label,
                   !option.disabled &&
                     h('button', {
                       class: 'form-multi-select-tag-delete',
@@ -73,9 +73,9 @@ const CMultiSelectSelection = defineComponent({
           props.multiple &&
             props.selectionType === 'text' &&
             props.selected.map((option, index) =>
-              h('span', `${option.text}${index === props.selected.length - 1 ? '' : ','}\xA0`),
+              h('span', `${option.label}${index === props.selected.length - 1 ? '' : ','}\xA0`),
             ),
-          !props.multiple && !props.search && props.selected.map((option) => option.text)[0],
+          !props.multiple && !props.search && props.selected.map((option) => option.label)[0],
           slots.default && slots.default(),
         ],
       )

package/src/components/multi-select/types.ts

@@ -2,7 +2,7 @@ export type Option = {
   custom?: boolean
   disabled?: boolean
   selected?: boolean
-  text: string // TODO: change to label in v5
+  label: string
   value: number | string
   [key: string]: number | string | any
 }
@@ -15,7 +15,7 @@ export type OptionsGroup = {
 
 export type SelectedOption = {
   disabled?: boolean
-  text: string
+  label: string
   value: number | string
   [key: string]: number | string | any
 }

package/src/components/multi-select/utils.ts

@@ -1,7 +1,7 @@
 import type { Option, OptionsGroup, SelectedOption } from './types'
 
-export const createOption = (text: string, options: (Option | OptionsGroup)[]) => {
-  const value = text.toLowerCase().replace(/\s/g, '-')
+export const createOption = (label: string, options: (Option | OptionsGroup)[]) => {
+  const value = label.toLowerCase().replace(/\s/g, '-')
   let uniqueValue = value
   let i = 1
 
@@ -13,7 +13,7 @@ export const createOption = (text: string, options: (Option | OptionsGroup)[]) =
   return [
     {
       value: uniqueValue,
-      text,
+      label,
       custom: true,
     },
   ]
@@ -28,10 +28,10 @@ export const filterOptionsList = (search: string, _options: (Option | OptionsGro
         option.options &&
         option.options.filter(
           (option: Option) =>
-            option.text && option.text.toLowerCase().includes(search.toLowerCase()),
+            option.label && option.label.toLowerCase().includes(search.toLowerCase()),
         )
       if (
-        (option.text && option.text.toLowerCase().includes(search.toLowerCase())) ||
+        (option.label && option.label.toLowerCase().includes(search.toLowerCase())) ||
         (options && options.length > 0)
       ) {
         optionsList.push(Object.assign({}, option, options && options.length > 0 && { options }))

package/src/components/navbar/CNavbar.ts

@@ -74,13 +74,13 @@ const CNavbar = defineComponent({
             'navbar',
             {
               [`bg-${props.color}`]: props.color,
-              [`navbar-${props.colorScheme}`]: props.colorScheme,
               [typeof props.expand === 'boolean'
                 ? 'navbar-expand'
                 : `navbar-expand-${props.expand}`]: props.expand,
             },
             props.placement,
           ],
+          ...(props.colorScheme && { 'data-coreui-theme': props.colorScheme }),
         },
         props.container
           ? h(

package/src/components/offcanvas/COffcanvas.ts

@@ -26,6 +26,10 @@ const COffcanvas = defineComponent({
         return false
       },
     },
+    /**
+     * Sets a darker color scheme.
+     */
+    dark: Boolean,
     /**
      * Closes the offcanvas when escape key is pressed.
      */
@@ -159,6 +163,7 @@ const COffcanvas = defineComponent({
       h(
         Transition,
         {
+          appear: visible.value,
           css: false,
           onEnter: (el, done) => handleEnter(el, done),
           onAfterEnter: () => handleAfterEnter(),
@@ -182,6 +187,7 @@ const COffcanvas = defineComponent({
                 ref: offcanvasRef,
                 role: 'dialog',
                 tabindex: -1,
+                ...(props.dark && { 'data-coreui-theme': 'dark' }),
               },
               slots.default && slots.default(),
             ),

package/src/components/picker/CPicker.ts

@@ -159,7 +159,7 @@ const CPicker = defineComponent({
                 /**
                  * @slot Location for the footer element.
                  */
-                slots.footer && slots.footer(),
+                props.footer && slots.footer && slots.footer(),
               ]),
             ],
           )

package/src/components/progress/CProgress.ts

@@ -1,25 +1,61 @@
-import { defineComponent, h } from 'vue'
+import { defineComponent, h, inject } from 'vue'
 
 import { CProgressBar } from './CProgressBar'
+import { Color } from '../../props'
 
 const CProgress = defineComponent({
   name: 'CProgress',
   props: {
+    /**
+     * Use to animate the stripes right to left via CSS3 animations.
+     */
+    animated: Boolean,
+    /**
+     * Sets the color context of the component to one of CoreUI’s themed colors.
+     *
+     * @values 'primary', 'secondary', 'success', 'danger', 'warning', 'info', 'dark', 'light'
+     */
+    color: Color,
     /**
      * Sets the height of the component. If you set that value the inner `<CProgressBar>` will automatically resize accordingly.
      */
     height: Number,
+    /**
+     * A string of all className you want applied to the <CProgressBar/> component.
+     *
+     * @since 5.0.0-alpha.1
+     */
+    progressBarClassName: String,
     /**
      * Makes progress bar thinner.
      */
     thin: Boolean,
+    /**
+     * The percent to progress the ProgressBar.
+     */
+    value: {
+      type: Number,
+      default: 0,
+    },
+    /**
+     * Set the progress bar variant to optional striped.
+     *
+     * @values 'striped'
+     */
+    variant: {
+      type: String,
+      validator: (value: string) => {
+        return value === 'striped'
+      },
+    },
     /**
      * Change the default color to white.
      */
     white: Boolean,
-    ...CProgressBar.props,
   },
   setup(props, { slots }) {
+    const stacked = inject('stacked', false) as boolean
+
     return () =>
       h(
         'div',
@@ -31,20 +67,42 @@ const CProgress = defineComponent({
               'progress-white': props.white,
             },
           ],
-          ...(props.height, { style: `height: ${props.height}px` }),
+          style: {
+            ...(props.height ? { height: `${props.height}px` } : {}),
+            ...(stacked ? { width: `${props.value}%` } : {}),
+          },
+          ...(props.value !== undefined && {
+            role: 'progressbar',
+            'aria-valuenow': props.value,
+            'aria-valuemin': 0,
+            'aria-valuemax': 100,
+          }),
         },
-        props.value
-          ? h(
+        // @ts-expect-error name is defined in component
+        slots.default && slots.default().some((vnode) => vnode.type.name === 'CProgressBar')
+          ? slots.default().map((vnode) => {
+              // @ts-expect-error name is defined in component
+              if (vnode.type.name === 'CProgressBar') {
+                return h(vnode, {
+                  ...(props.animated && { animated: props.animated }),
+                  ...(props.color && { color: props.color }),
+                  ...(props.value && { value: props.value }),
+                  ...(props.variant && { variant: props.variant }),
+                })
+              }
+              return vnode
+            })
+          : h(
               CProgressBar,
               {
-                value: props.value,
+                ...(props.progressBarClassName && { class: props.progressBarClassName }),
                 animated: props.animated,
                 color: props.color,
+                value: props.value,
                 variant: props.variant,
               },
-              slots.default && slots.default(),
-            )
-          : slots.default && slots.default(),
+              () => slots.default && slots.default(),
+            ),
       )
   },
 })

package/src/components/progress/CProgressBar.ts

@@ -1,4 +1,4 @@
-import { defineComponent, h } from 'vue'
+import { defineComponent, h, inject } from 'vue'
 
 import { Color } from '../../props'
 
@@ -35,6 +35,8 @@ const CProgressBar = defineComponent({
     },
   },
   setup(props, { slots }) {
+    const stacked = inject('stacked', false) as boolean
+
     return () =>
       h(
         'div',
@@ -47,11 +49,7 @@ const CProgressBar = defineComponent({
               ['progress-bar-animated']: props.animated,
             },
           ],
-          role: 'progressbar',
-          style: `width: ${props.value}%`,
-          'aria-valuenow': props.value,
-          'aria-valuemin': '0',
-          'aria-valuemax': '100',
+          ...(!stacked && { style: { width: `${props.value}%` } }),
         },
         slots.default && slots.default(),
       )

package/src/components/progress/CProgressStacked.ts

@@ -0,0 +1,19 @@
+import { defineComponent, h, provide } from 'vue'
+
+const CProgressStacked = defineComponent({
+  name: 'CProgressStacked',
+  props: {},
+  setup(_, { slots }) {
+    provide('stacked', true)
+    return () =>
+      h(
+        'div',
+        {
+          class: 'progress-stacked',
+        },
+        slots.default && slots.default(),
+      )
+  },
+})
+
+export { CProgressStacked }

package/src/components/progress/index.ts

@@ -1,12 +1,14 @@
 import { App } from 'vue'
 import { CProgress } from './CProgress'
 import { CProgressBar } from './CProgressBar'
+import { CProgressStacked } from './CProgressStacked'
 
 const CProgressPlugin = {
   install: (app: App): void => {
     app.component(CProgress.name, CProgress)
     app.component(CProgressBar.name, CProgressBar)
+    app.component(CProgressStacked.name, CProgressStacked)
   },
 }
 
-export { CProgressPlugin, CProgress, CProgressBar }
+export { CProgressPlugin, CProgress, CProgressBar, CProgressStacked }

package/src/components/sidebar/CSidebar.ts

@@ -187,7 +187,7 @@ const CSidebar = defineComponent({
       ),
       mobile.value &&
         h(CBackdrop, {
-          class: 'sidebar-backdrop d-none',
+          class: 'sidebar-backdrop',
           visible: props.visible,
           onClick: () => handleHide(),
         }),

package/src/components/smart-pagination/CSmartPagination.ts

@@ -140,11 +140,26 @@ const CSmartPagination = defineComponent({
     const limit = ref(props.limit)
     const pages = ref(props.pages)
 
-    watch(props, () => {
-      activePage.value = props.activePage
-      limit.value = props.limit
-      pages.value = props.pages
-    })
+    watch(
+      () => props.activePage,
+      () => {
+        activePage.value = props.activePage
+      },
+    )
+
+    watch(
+      () => props.limit,
+      () => {
+        limit.value = props.limit
+      },
+    )
+
+    watch(
+      () => props.pages,
+      () => {
+        pages.value = props.pages
+      },
+    )
 
     const showDots = computed(() => {
       return props.dots && limit.value > 4 && limit.value < pages.value