@coreui/react-pro 5.10.0 → 5.12.0

package/src/components/popover/CPopover.tsx

@@ -9,6 +9,7 @@ import React, {
 } from 'react'
 import classNames from 'classnames'
 import PropTypes from 'prop-types'
+import type { Options } from '@popperjs/core'
 
 import { CConditionalPortal } from '../conditional-portal'
 import { useForkedRef, usePopper } from '../../hooks'
@@ -18,65 +19,132 @@ import { executeAfterTransition, getRTLPlacement } from '../../utils'
 
 export interface CPopoverProps extends Omit<HTMLAttributes<HTMLDivElement>, 'title' | 'content'> {
   /**
-   * Apply a CSS fade transition to the popover.
+   * Adds a fade transition animation to the React Popover.
    *
    * @since 4.9.0
    */
   animation?: boolean
+
   /**
-   * A string of all className you want applied to the component.
+   * Custom class name(s) for additional styling.
    */
   className?: string
+
   /**
-   * Appends the react popover to a specific element. You can pass an HTML element or function that returns a single element. By default `document.body`.
+   * Defines the container element to which the React Popover is appended.
+   * Accepts:
+   * - A DOM element (`HTMLElement` or `DocumentFragment`)
+   * - A function that returns a single element
+   * - `null` (defaults to `document.body`)
+   *
+   * @example
+   * <CPopover container={document.getElementById('my-container')}>...</CPopover>
    *
+   * @default document.body
    * @since 4.11.0
    */
   container?: DocumentFragment | Element | (() => DocumentFragment | Element | null) | null
+
   /**
-   * Content node for your component.
+   * Main content of the React Popover. It can be a string or any valid React node.
    */
   content: ReactNode | string
+
   /**
-   * Offset of the popover relative to its target.
-   */
-  offset?: [number, number]
-  /**
-   * The delay for displaying and hiding the popover (in milliseconds). When a numerical value is provided, the delay applies to both the hide and show actions. The object structure for specifying the delay is as follows: delay: `{ 'show': 500, 'hide': 100 }`.
+   * Delay (in milliseconds) before showing or hiding the React Popover.
+   * - If a number is provided, that delay applies to both "show" and "hide".
+   * - If an object is provided, use separate values for "show" and "hide".
+   *
+   * @example
+   * // Delays 300ms on both show and hide
+   * <CPopover delay={300}>...</CPopover>
+   *
+   * // Delays 500ms on show and 100ms on hide
+   * <CPopover delay={{ show: 500, hide: 100 }}>...</CPopover>
    *
    * @since 4.9.0
    */
   delay?: number | { show: number; hide: number }
+
   /**
-   * Specify the desired order of fallback placements by providing a list of placements as an array. The placements should be prioritized based on preference.
+   * Specifies the fallback placements when the preferred `placement` cannot be met.
    *
+   * @type 'top', 'right', 'bottom', 'left' | ('top', 'right', 'bottom', 'left')[]
    * @since 4.9.0
    */
   fallbackPlacements?: Placements | Placements[]
+
   /**
-   * Callback fired when the component requests to be hidden.
+   * Offset of the React Popover relative to its toggle element, in the form `[x, y]`.
+   *
+   * @example
+   * // Offset the menu 0px in X and 10px in Y direction
+   * <CPopover offset={[0, 10]}>...</CPopover>
+   *
+   * // Offset the menu 5px in both X and Y direction
+   * <CPopover offset={[5, 5]}>...</CPopover>
+   */
+  offset?: [number, number]
+
+  /**
+   * Invoked when the React Popover is about to hide.
    */
   onHide?: () => void
+
   /**
-   * Callback fired when the component requests to be shown.
+   * Invoked when the React Popover is about to show.
    */
   onShow?: () => void
+
   /**
-   * Title node for your component.
+   * Placement of the React Popover. Popper.js may override this based on available space.
    */
-  title?: ReactNode | string
+  placement?: 'auto' | 'top' | 'right' | 'bottom' | 'left'
+
   /**
-   * Sets which event handlers you’d like provided to your toggle prop. You can specify one trigger or an array of them.
+   * Allows customization of the Popper.js configuration for the React Popover.
+   * Can be an object or a function returning a modified configuration.
+   * [Learn more](https://popper.js.org/docs/v2/constructors/#options)
+   *
+   * @example
+   * <CPopover
+   *   popperConfig={(defaultConfig) => ({
+   *     ...defaultConfig,
+   *     strategy: 'fixed',
+   *     modifiers: [
+   *       ...defaultConfig.modifiers,
+   *       { name: 'computeStyles', options: { adaptive: false } },
+   *     ],
+   *   })}
+   * >...</CPopover>
    *
-   * @type 'hover' | 'focus' | 'click'
+   * @since 5.5.0
    */
-  trigger?: Triggers | Triggers[]
+  popperConfig?: Partial<Options> | ((defaultPopperConfig: Partial<Options>) => Partial<Options>)
+
   /**
-   * Describes the placement of your component after Popper.js has applied all the modifiers that may have flipped or altered the originally provided placement property.
+   * Title for the React Popover header. Can be a string or any valid React node.
    */
-  placement?: 'auto' | 'top' | 'right' | 'bottom' | 'left'
+  title?: ReactNode | string
+
   /**
-   * Toggle the visibility of popover component.
+   * Determines which events trigger the visibility of the React Popover. Can be a single trigger or an array of triggers.
+   *
+   * @example
+   * // Hover-only popover
+   * <CPopover trigger="hover">...</CPopover>
+   *
+   * // Hover + click combined
+   * <CPopover trigger={['hover', 'click']}>...</CPopover>
+   *
+   * @type 'hover' | 'focus' | 'click' | ('hover' | 'focus' | 'click')[]
+   */
+  trigger?: Triggers | Triggers[]
+
+  /**
+   * Controls the visibility of the React Popover.
+   * - `true` shows the popover.
+   * - `false` hides the popover.
    */
   visible?: boolean
 }
@@ -95,12 +163,13 @@ export const CPopover = forwardRef<HTMLDivElement, CPopoverProps>(
       onHide,
       onShow,
       placement = 'top',
+      popperConfig,
       title,
       trigger = 'click',
       visible,
       ...rest
     },
-    ref,
+    ref
   ) => {
     const popoverRef = useRef<HTMLDivElement>(null)
     const togglerRef = useRef(null)
@@ -114,30 +183,20 @@ export const CPopover = forwardRef<HTMLDivElement, CPopoverProps>(
 
     const _delay = typeof delay === 'number' ? { show: delay, hide: delay } : delay
 
-    const popperConfig = {
+    const defaultPopperConfig: Partial<Options> = {
       modifiers: [
-        {
-          name: 'arrow',
-          options: {
-            element: '.popover-arrow',
-          },
-        },
-        {
-          name: 'flip',
-          options: {
-            fallbackPlacements: fallbackPlacements,
-          },
-        },
-        {
-          name: 'offset',
-          options: {
-            offset: offset,
-          },
-        },
+        { name: 'arrow', options: { element: '.popover-arrow' } },
+        { name: 'flip', options: { fallbackPlacements } },
+        { name: 'offset', options: { offset } },
       ],
       placement: getRTLPlacement(placement, togglerRef.current),
     }
 
+    const computedPopperConfig: Partial<Options> = {
+      ...defaultPopperConfig,
+      ...(typeof popperConfig === 'function' ? popperConfig(defaultPopperConfig) : popperConfig),
+    }
+
     useEffect(() => {
       if (visible) {
         handleShow()
@@ -149,7 +208,7 @@ export const CPopover = forwardRef<HTMLDivElement, CPopoverProps>(
 
     useEffect(() => {
       if (mounted && togglerRef.current && popoverRef.current) {
-        initPopper(togglerRef.current, popoverRef.current, popperConfig)
+        initPopper(togglerRef.current, popoverRef.current, computedPopperConfig)
         setTimeout(() => {
           setVisible(true)
         }, _delay.show)
@@ -215,7 +274,7 @@ export const CPopover = forwardRef<HTMLDivElement, CPopoverProps>(
                   fade: animation,
                   show: _visible,
                 },
-                className,
+                className
               )}
               id={id}
               ref={forkedRef}
@@ -230,7 +289,7 @@ export const CPopover = forwardRef<HTMLDivElement, CPopoverProps>(
         </CConditionalPortal>
       </>
     )
-  },
+  }
 )
 
 CPopover.propTypes = {
@@ -251,6 +310,7 @@ CPopover.propTypes = {
   onHide: PropTypes.func,
   onShow: PropTypes.func,
   placement: PropTypes.oneOf(['auto', 'top', 'right', 'bottom', 'left']),
+  popperConfig: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
   title: PropTypes.oneOfType([PropTypes.string, PropTypes.node]),
   trigger: triggerPropType,
   visible: PropTypes.bool,

package/src/components/popover/__tests__/CPopover.spec.tsx

@@ -31,7 +31,7 @@ test('CPopover customize', async () => {
   expect(container).toMatchSnapshot()
   let arrLength = container.getElementsByClassName('popover').length
   expect(arrLength).toBe(1)
-  arrLength = container.getElementsByClassName('bs-popover-end').length
+  arrLength = container.getElementsByClassName('bs-popover-auto').length
   expect(arrLength).toBe(1)
   arrLength = container.getElementsByClassName('popover-arrow').length
   expect(arrLength).toBe(1)

package/src/components/popover/__tests__/__snapshots__/CPopover.spec.tsx.snap

@@ -3,15 +3,14 @@
 exports[`CPopover customize 1`] = `
 <body>
   <button
-    aria-describedby="popover744956"
     class="btn btn-primary"
     type="button"
   >
     Test
   </button>
   <div
-    class="popover bs-popover-auto fade show"
-    id="popover744956"
+    class="popover bs-popover-auto fade"
+    id="popover:r1:"
     role="tooltip"
     style="position: absolute; left: 0px; top: 0px; margin: 0px;"
   >

package/src/components/progress/CProgress.tsx

@@ -17,7 +17,7 @@ export interface CProgressProps
    */
   height?: number
   /**
-   * A string of all className you want applied to the <CProgressBar/> component.
+   * A string of all className you want applied to the `<CProgressBar/>` component.
    *
    * @since 4.9.0
    */

package/src/components/range-slider/CRangeSlider.tsx

@@ -207,7 +207,12 @@ export const CRangeSlider = forwardRef<HTMLDivElement, CRangeSliderProps>(
     }
 
     const handleInputsContainerMouseDown = (event: React.MouseEvent<HTMLDivElement>) => {
-      if (trackRef.current === null || event.button !== 0) {
+      if (trackRef.current === null || event.button !== 0 || disabled) {
+        return
+      }
+
+      const target = event.target as HTMLDivElement | HTMLInputElement
+      if (!(target instanceof HTMLInputElement) && target !== trackRef.current) {
         return
       }
 
@@ -237,7 +242,7 @@ export const CRangeSlider = forwardRef<HTMLDivElement, CRangeSliderProps>(
     }
 
     const handleMouseMove = (event: MouseEvent) => {
-      if (!isDragging || trackRef.current === null) {
+      if (!isDragging || trackRef.current === null || disabled) {
         return
       }
 

package/src/components/sidebar/CSidebar.tsx

@@ -1,4 +1,4 @@
-import React, { forwardRef, HTMLAttributes, useEffect, useRef, useState } from 'react'
+import React, { ElementType, forwardRef, HTMLAttributes, useEffect, useRef, useState } from 'react'
 import { createPortal } from 'react-dom'
 import PropTypes from 'prop-types'
 import classNames from 'classnames'
@@ -7,8 +7,13 @@ import { CBackdrop } from '../backdrop'
 
 import { isInViewport } from '../../utils'
 import { useForkedRef } from '../../hooks'
+import { PolymorphicRefForwardingComponent } from '../../helpers'
 
 export interface CSidebarProps extends HTMLAttributes<HTMLDivElement> {
+  /**
+   * Component used for the root node. Either a string to use a HTML element or a component.
+   */
+  as?: ElementType
   /**
    * A string of all className you want applied to the component.
    */
@@ -65,10 +70,14 @@ export interface CSidebarProps extends HTMLAttributes<HTMLDivElement> {
 const isOnMobile = (element: HTMLDivElement) =>
   Boolean(getComputedStyle(element).getPropertyValue('--cui-is-mobile'))
 
-export const CSidebar = forwardRef<HTMLDivElement, CSidebarProps>(
+export const CSidebar: PolymorphicRefForwardingComponent<'div', CSidebarProps> = forwardRef<
+  HTMLDivElement,
+  CSidebarProps
+>(
   (
     {
       children,
+      as: Component = 'div',
       className,
       colorScheme,
       narrow,
@@ -183,7 +192,7 @@ export const CSidebar = forwardRef<HTMLDivElement, CSidebarProps>(
 
     return (
       <>
-        <div
+        <Component
           className={classNames(
             'sidebar',
             {
@@ -203,7 +212,7 @@ export const CSidebar = forwardRef<HTMLDivElement, CSidebarProps>(
           ref={forkedRef}
         >
           {children}
-        </div>
+        </Component>
         {typeof window !== 'undefined' &&
           mobile &&
           createPortal(
@@ -216,6 +225,7 @@ export const CSidebar = forwardRef<HTMLDivElement, CSidebarProps>(
 )
 
 CSidebar.propTypes = {
+  as: PropTypes.elementType,
   children: PropTypes.node,
   className: PropTypes.string,
   colorScheme: PropTypes.oneOf(['dark', 'light']),
@@ -231,4 +241,4 @@ CSidebar.propTypes = {
   visible: PropTypes.bool,
 }
 
-CSidebar.displayName = 'CSidebar'
+CSidebar.displayName = 'CSidebar'

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

@@ -26,27 +26,19 @@ export interface CSmartPaginationProps extends HTMLAttributes<HTMLUListElement>
    */
   doubleArrows?: boolean
   /**
-   * The content of 'firstButton' button.
-   *
-   * @default '<React.Fragment>&laquo;</React.Fragment>''
+   * The content of `firstButton` button.
    */
   firstButton?: ReactNode | string
   /**
-   * The content of 'previousButton' button.
-   *
-   * @default '<React.Fragment>&lsaquo;</React.Fragment>'
+   * The content of `previousButton` button.
    */
   previousButton?: ReactNode | string
   /**
-   * The content of 'nextButton' button.
-   *
-   * @default '<React.Fragment>&rsaquo;</React.Fragment>''
+   * The content of `nextButton` button.
    */
   nextButton?: ReactNode | string
   /**
-   * The content of 'lastButton' button.
-   *
-   * @default '<React.Fragment>&raquo;</React.Fragment>'
+   * The content of `lastButton` button.
    */
   lastButton?: ReactNode | string
   /**

package/src/components/smart-table/CSmartTableHead.tsx

@@ -1,12 +1,4 @@
-import React, {
-  ElementType,
-  forwardRef,
-  ReactNode,
-  useEffect,
-  useMemo,
-  useRef,
-  useState,
-} from 'react'
+import React, { ElementType, forwardRef, ReactNode, useMemo, useRef } from 'react'
 import PropTypes from 'prop-types'
 
 import { CFormCheck, CFormInput } from '../form'
@@ -76,27 +68,9 @@ export const CSmartTableHead: PolymorphicRefForwardingComponent<'thead', CSmartT
       ref,
     ) => {
       const selectAllcheckboxRef = useRef<HTMLInputElement>(null)
-      const [refresh, setRefresh] = useState(false)
-
       const _columns = useMemo(() => getColumns(columns), [columns])
       const groups = useMemo(() => getColumnGroups(columns), [columns])
 
-      useEffect(() => {
-        if (columnFilterState && Object.keys(columnFilterState).length === 0) {
-          setRefresh(true)
-        }
-      }, [columnFilterState])
-
-      useEffect(() => {
-        setRefresh(true)
-      }, [items])
-
-      useEffect(() => {
-        if (setRefresh) {
-          setRefresh(false)
-        }
-      }, [refresh])
-
       const columnSorterIcon = (column: Column | string) => {
         if (getColumnSorterState(getColumnKey(column), sorterState) === 0) {
           return <span className="opacity-25 float-end me-1">{sortingIcon}</span>
@@ -161,18 +135,18 @@ export const CSmartTableHead: PolymorphicRefForwardingComponent<'thead', CSmartT
                   {...(isSortable && {
                     onClick: () => handleSort && handleSort(getColumnKey(column), index),
                     onKeyDown: (event) => {
-                      if (event.key === 'Enter') {
-                        handleSort && handleSort(getColumnKey(column), index)
+                      if (event.key === 'Enter' && handleSort) {
+                        handleSort(getColumnKey(column), index)
                       }
 
-                      if (event.key === 'ArrowUp') {
+                      if (event.key === 'ArrowUp' && handleSort) {
                         event.preventDefault()
-                        handleSort && handleSort(getColumnKey(column), index, 'asc')
+                        handleSort(getColumnKey(column), index, 'asc')
                       }
 
-                      if (event.key === 'ArrowDown') {
+                      if (event.key === 'ArrowDown' && handleSort) {
                         event.preventDefault()
-                        handleSort && handleSort(getColumnKey(column), index, 'desc')
+                        handleSort(getColumnKey(column), index, 'desc')
                       }
                     },
                     tabIndex: 0,
@@ -198,12 +172,14 @@ export const CSmartTableHead: PolymorphicRefForwardingComponent<'thead', CSmartT
                         : true
                     ) ? (
                       typeof column !== 'string' && typeof column.filter === 'function' ? (
-                        !refresh &&
                         column.filter(
                           getColumnValues(items, getColumnKey(column)),
                           (value: any) =>
                             handleOnCustomFilterChange &&
                             handleOnCustomFilterChange(getColumnKey(column), value),
+                          columnFilterState && columnFilterState[getColumnKey(column)]
+                            ? columnFilterState[getColumnKey(column)]
+                            : undefined
                         )
                       ) : (
                         <CFormInput

package/src/components/smart-table/types.ts

@@ -6,7 +6,13 @@ import { CTableRowProps } from '../table/CTableRow'
 
 export type Column = {
   children?: Column[]
-  filter?: boolean | ((values: any[], onChange: (value: any) => void) => ReactNode)
+  filter?:
+    | boolean
+    | ((
+        values: any[],
+        onChange: (value: any) => void,
+        state: ColumnFilterValue | undefined
+      ) => ReactNode)
   group?: string
   key: string
   label?: string

package/src/components/time-picker/CTimePicker.tsx

@@ -19,7 +19,7 @@ import {
 } from './utils'
 
 import { Colors } from '../../types'
-import type { LocalizedTimePartials } from './types'
+import type { AmPm, LocalizedTimePartials } from './types'
 import { useDebouncedCallback } from '../../hooks'
 
 export interface CTimePickerProps
@@ -139,7 +139,7 @@ export interface CTimePickerProps
    *
    * @since 4.8.0
    */
-  seconds?: boolean | number[] | ((second: number) => number[])
+  seconds?: boolean | number[] | ((second: number) => boolean)
   /**
    * Size the component small or large.
    */
@@ -208,7 +208,7 @@ export const CTimePicker = forwardRef<HTMLDivElement | HTMLLIElement, CTimePicke
     const [date, setDate] = useState<Date | null>(convertTimeToDate(time))
     const [initialDate, setInitialDate] = useState<Date | null>(null)
     const [isValid, setIsValid] = useState(valid ?? (invalid === true ? false : undefined))
-    const [_ampm, setAmPm] = useState<'am' | 'pm'>(date ? getAmPm(new Date(date), locale) : 'am')
+    const [_ampm, setAmPm] = useState<AmPm>(date ? getAmPm(new Date(date), locale) : 'am')
     const [_visible, setVisible] = useState(visible)
 
     const [localizedTimePartials, setLocalizedTimePartials] = useState<LocalizedTimePartials>({

package/src/components/time-picker/types.ts

@@ -1,3 +1,10 @@
+export type AmPm = 'am' | 'pm'
+
+export type FormattedPartial = {
+  value: number
+  label: string
+}
+
 export type LocalizedTimePartials = {
   listOfHours: {
     value: number

package/src/components/time-picker/utils.ts

@@ -1,4 +1,4 @@
-import type { LocalizedTimePartials } from './types'
+import type { AmPm, FormattedPartial, LocalizedTimePartials } from './types'
 
 /**
  * Converts a 12-hour time format to a 24-hour time format.
@@ -6,7 +6,7 @@ import type { LocalizedTimePartials } from './types'
  * @param {number} hour The hour to be converted.
  * @returns {number} The hour in 24-hour format.
  */
-export const convert12hTo24h = (abbr: 'am' | 'pm', hour: number) => {
+export const convert12hTo24h = (abbr: AmPm, hour: number): number => {
   if (abbr === 'am' && hour === 12) {
     return 0
   }
@@ -27,14 +27,14 @@ export const convert12hTo24h = (abbr: 'am' | 'pm', hour: number) => {
  * @param {number} hour The hour to be converted.
  * @returns {number} The hour in 12-hour format.
  */
-export const convert24hTo12h = (hour: number) => hour % 12 || 12
+export const convert24hTo12h = (hour: number): number => hour % 12 || 12
 
 /**
  * Converts a time input into a Date object.
  * @param {Date | string | null | undefined} time The time input to be converted.
  * @returns {Date | null} The converted Date object or null if the input is falsy.
  */
-export const convertTimeToDate = (time: Date | string | null | undefined) =>
+export const convertTimeToDate = (time: Date | string | null | undefined): Date | null =>
   time ? (time instanceof Date ? time : new Date(`1970-01-01 ${time}`)) : null
 
 /**
@@ -43,7 +43,7 @@ export const convertTimeToDate = (time: Date | string | null | undefined) =>
  * @param {string} locale The locale to use for formatting.
  * @returns {string} 'am' or 'pm' based on the given date and locale.
  */
-export const getAmPm = (date: Date, locale: string) => {
+export const getAmPm = (date: Date, locale: string): AmPm => {
   if (date.toLocaleTimeString(locale).includes('AM')) {
     return 'am'
   }
@@ -66,7 +66,7 @@ export const formatTimePartials = (
   values: number[],
   locale: string,
   partial: 'hour' | 'minute' | 'second',
-) => {
+): FormattedPartial[] => {
   const date = new Date()
 
   const formatter = new Intl.DateTimeFormat(locale, {
@@ -155,7 +155,7 @@ export const getSelectedHour = (
   date: Date | null,
   locale: string,
   ampm: 'auto' | boolean = 'auto',
-) =>
+): number | string =>
   date
     ? ((ampm === 'auto' && isAmPm(locale)) || ampm === true
       ? convert24hTo12h(date.getHours())
@@ -167,21 +167,23 @@ export const getSelectedHour = (
  * @param {Date | null} date The date object from which to extract the minutes. If null, the function returns an empty string.
  * @returns {string | number} The minutes from the date or an empty string if the date is null.
  */
-export const getSelectedMinutes = (date: Date | null) => (date ? date.getMinutes() : '')
+export const getSelectedMinutes = (date: Date | null): number | string =>
+  date ? date.getMinutes() : ''
 
 /**
  * Gets the selected seconds from a date object.
  * @param {Date | null} date The date object from which to extract the seconds. If null, the function returns an empty string.
  * @returns {string | number} The seconds from the date or an empty string if the date is null.
  */
-export const getSelectedSeconds = (date: Date | null) => (date ? date.getSeconds() : '')
+export const getSelectedSeconds = (date: Date | null): number | string =>
+  date ? date.getSeconds() : ''
 
 /**
  * Determines if the given locale uses AM/PM format.
  * @param {string} locale The locale to check.
  * @returns {boolean} True if the locale uses AM/PM format, otherwise false.
  */
-export const isAmPm = (locale: string) =>
+export const isAmPm = (locale: string): boolean =>
   ['am', 'AM', 'pm', 'PM'].some((el) => new Date().toLocaleString(locale).includes(el))
 
 /**
@@ -189,7 +191,7 @@ export const isAmPm = (locale: string) =>
  * @param {string} time The time string to validate.
  * @returns {boolean} True if the string is a valid time, otherwise false.
  */
-export const isValidTime = (time: string) => {
-  const d = new Date(`1970-01-01 ${time}`)
-  return d instanceof Date && d.getTime()
+export const isValidTime = (time: string): boolean => {
+  const d = new Date(`1970-01-01T${time}`)
+  return d instanceof Date && !Number.isNaN(d.getTime())
 }