@coreui/react-pro 5.0.0-rc.0 → 5.0.0-rc.1

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

@@ -13,6 +13,7 @@ import { CFormCheck, CFormInput } from '../form'
 import { CTableHeaderCell, CTableRow } from '../table'
 import { CTableHead, CTableHeadProps } from '../table/CTableHead'
 
+import { PolymorphicRefForwardingComponent } from '../../helpers'
 import type { ColumnFilter, ColumnFilterValue, Column, Item, Sorter, SorterValue } from './types'
 import {
   getColumnKey,
@@ -26,10 +27,10 @@ import {
 } from './utils'
 
 export interface CSmartTableHeadProps extends CTableHeadProps {
+  as?: ElementType
   columnFilter?: boolean | ColumnFilter
   columnFilterState?: ColumnFilterValue
   columnSorter?: boolean | Sorter
-  component?: string | ElementType
   columns: (Column | string)[]
   handleOnCustomFilterChange?: (key: string, value: any) => void
   handleFilterOnChange?: (key: string, value: string) => void
@@ -47,205 +48,206 @@ export interface CSmartTableHeadProps extends CTableHeadProps {
   sortingIconDescending?: ReactNode
 }
 
-export const CSmartTableHead = forwardRef<HTMLTableSectionElement, CSmartTableHeadProps>(
-  (
-    {
-      columnFilter,
-      columnFilterState,
-      columnSorter,
-      component: Component = CTableHead,
-      columns,
-      handleOnCustomFilterChange,
-      handleFilterOnChange,
-      handleFilterOnInput,
-      handleSelectAllChecked,
-      handleSort,
-      items,
-      selectable,
-      selectAll,
-      selectedAll,
-      showGroups = true,
-      sorterState,
-      sortingIcon,
-      sortingIconAscending,
-      sortingIconDescending,
-      ...rest
-    },
-    ref,
-  ) => {
-    const selectAllcheckboxRef = useRef<HTMLInputElement>(null)
-    const [refresh, setRefresh] = useState(false)
+export const CSmartTableHead: PolymorphicRefForwardingComponent<'thead', CSmartTableHeadProps> =
+  forwardRef<HTMLTableSectionElement, CSmartTableHeadProps>(
+    (
+      {
+        as: Component = CTableHead,
+        columnFilter,
+        columnFilterState,
+        columnSorter,
+        columns,
+        handleOnCustomFilterChange,
+        handleFilterOnChange,
+        handleFilterOnInput,
+        handleSelectAllChecked,
+        handleSort,
+        items,
+        selectable,
+        selectAll,
+        selectedAll,
+        showGroups = true,
+        sorterState,
+        sortingIcon,
+        sortingIconAscending,
+        sortingIconDescending,
+        ...rest
+      },
+      ref,
+    ) => {
+      const selectAllcheckboxRef = useRef<HTMLInputElement>(null)
+      const [refresh, setRefresh] = useState(false)
+
+      const _columns = useMemo(() => getColumns(columns), [columns])
+      const groups = useMemo(() => getColumnGroups(columns), [columns])
 
-    const _columns = useMemo(() => getColumns(columns), [columns])
-    const groups = useMemo(() => getColumnGroups(columns), [columns])
+      useEffect(() => {
+        if (columnFilterState && Object.keys(columnFilterState).length === 0) {
+          setRefresh(true)
+        }
+      }, [columnFilterState])
 
-    useEffect(() => {
-      if (columnFilterState && Object.keys(columnFilterState).length === 0) {
+      useEffect(() => {
         setRefresh(true)
-      }
-    }, [columnFilterState])
+      }, [items])
 
-    useEffect(() => {
-      setRefresh(true)
-    }, [items])
+      useEffect(() => {
+        if (setRefresh) {
+          setRefresh(false)
+        }
+      }, [refresh])
 
-    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>
+        }
 
-    const columnSorterIcon = (column: Column | string) => {
-      if (getColumnSorterState(getColumnKey(column), sorterState) === 0) {
-        return <span className="opacity-25 float-end me-1">{sortingIcon}</span>
-      }
+        if (getColumnSorterState(getColumnKey(column), sorterState) === 'asc') {
+          return <span className="float-end me-1">{sortingIconAscending}</span>
+        }
 
-      if (getColumnSorterState(getColumnKey(column), sorterState) === 'asc') {
-        return <span className="float-end me-1">{sortingIconAscending}</span>
-      }
+        if (getColumnSorterState(getColumnKey(column), sorterState) === 'desc') {
+          return <span className="float-end me-1">{sortingIconDescending}</span>
+        }
 
-      if (getColumnSorterState(getColumnKey(column), sorterState) === 'desc') {
-        return <span className="float-end me-1">{sortingIconDescending}</span>
+        return
       }
 
-      return
-    }
-
-    return (
-      <Component {...rest} ref={ref}>
-        {showGroups &&
-          groups &&
-          groups.length > 0 &&
-          groups.map((row, index) => (
-            <CTableRow key={index}>
-              {selectable && <CTableHeaderCell></CTableHeaderCell>}
-              {row.map((cell, index) => (
+      return (
+        <Component {...rest} ref={ref}>
+          {showGroups &&
+            groups &&
+            groups.length > 0 &&
+            groups.map((row, index) => (
+              <CTableRow key={index}>
+                {selectable && <CTableHeaderCell></CTableHeaderCell>}
+                {row.map((cell, index) => (
+                  <CTableHeaderCell
+                    colSpan={cell.colspan}
+                    {...getTableHeaderCellProps(cell)}
+                    key={index}
+                  >
+                    {cell.label}
+                  </CTableHeaderCell>
+                ))}
+              </CTableRow>
+            ))}
+          <CTableRow>
+            {selectable && (
+              <CTableHeaderCell>
+                {selectAll && (
+                  <CFormCheck
+                    checked={typeof selectedAll === 'boolean' ? selectedAll : false}
+                    indeterminate={selectedAll === 'indeterminate' ? true : false}
+                    onChange={() => handleSelectAllChecked && handleSelectAllChecked()}
+                    ref={selectAllcheckboxRef}
+                  />
+                )}
+              </CTableHeaderCell>
+            )}
+            {_columns.map((column: Column | string, index: number) => {
+              const isSortable =
+                columnSorter &&
+                (typeof column === 'object'
+                  ? column.sorter === undefined
+                    ? true
+                    : column.sorter
+                  : true)
+              return (
                 <CTableHeaderCell
-                  colSpan={cell.colspan}
-                  {...getTableHeaderCellProps(cell)}
+                  {...getTableHeaderCellProps(column)}
+                  style={getTableHeaderCellStyles(column, columnSorter)}
                   key={index}
-                >
-                  {cell.label}
-                </CTableHeaderCell>
-              ))}
-            </CTableRow>
-          ))}
-        <CTableRow>
-          {selectable && (
-            <CTableHeaderCell>
-              {selectAll && (
-                <CFormCheck
-                  checked={typeof selectedAll === 'boolean' ? selectedAll : false}
-                  indeterminate={selectedAll === 'indeterminate' ? true : false}
-                  onChange={() => handleSelectAllChecked && handleSelectAllChecked()}
-                  ref={selectAllcheckboxRef}
-                />
-              )}
-            </CTableHeaderCell>
-          )}
-          {_columns.map((column: Column | string, index: number) => {
-            const isSortable =
-              columnSorter &&
-              (typeof column === 'object'
-                ? column.sorter === undefined
-                  ? true
-                  : column.sorter
-                : true)
-            return (
-              <CTableHeaderCell
-                {...getTableHeaderCellProps(column)}
-                style={getTableHeaderCellStyles(column, columnSorter)}
-                key={index}
-                {...(isSortable && {
-                  onClick: () => handleSort && handleSort(getColumnKey(column), index),
-                  onKeyDown: (event) => {
-                    if (event.key === 'Enter') {
-                      handleSort && handleSort(getColumnKey(column), index)
-                    }
+                  {...(isSortable && {
+                    onClick: () => handleSort && handleSort(getColumnKey(column), index),
+                    onKeyDown: (event) => {
+                      if (event.key === 'Enter') {
+                        handleSort && handleSort(getColumnKey(column), index)
+                      }
 
-                    if (event.key === 'ArrowUp') {
-                      event.preventDefault()
-                      handleSort && handleSort(getColumnKey(column), index, 'asc')
-                    }
+                      if (event.key === 'ArrowUp') {
+                        event.preventDefault()
+                        handleSort && handleSort(getColumnKey(column), index, 'asc')
+                      }
 
-                    if (event.key === 'ArrowDown') {
-                      event.preventDefault()
-                      handleSort && handleSort(getColumnKey(column), index, 'desc')
-                    }
-                  },
-                  tabIndex: 0,
-                })}
-              >
-                <div className="d-inline">{getColumnLabel(column)}</div>
-                {isSortable && columnSorterIcon(column)}
-              </CTableHeaderCell>
-            )
-          })}
-        </CTableRow>
-        {columnFilter && (
-          <CTableRow>
-            {selectable && <CTableHeaderCell></CTableHeaderCell>}
-            {_columns.map((column: Column | string, index: number) => {
-              return (
-                <CTableHeaderCell {...getTableHeaderCellProps(column)} key={index}>
-                  {(
-                    typeof column === 'object'
-                      ? column.filter === undefined
-                        ? true
-                        : column.filter
-                      : true
-                  ) ? (
-                    typeof column !== 'string' && typeof column.filter === 'function' ? (
-                      !refresh &&
-                      column.filter(
-                        getColumnValues(items, getColumnKey(column)),
-                        (value: any) =>
-                          handleOnCustomFilterChange &&
-                          handleOnCustomFilterChange(getColumnKey(column), value),
-                      )
-                    ) : (
-                      <CFormInput
-                        size="sm"
-                        onInput={(event) =>
-                          handleFilterOnInput &&
-                          handleFilterOnInput(
-                            getColumnKey(column),
-                            (event.target as HTMLInputElement).value,
-                          )
-                        }
-                        onChange={(event) =>
-                          handleFilterOnChange &&
-                          handleFilterOnChange(
-                            getColumnKey(column),
-                            (event.target as HTMLInputElement).value,
-                          )
-                        }
-                        value={
-                          columnFilterState && columnFilterState[getColumnKey(column)]
-                            ? columnFilterState[getColumnKey(column)]
-                            : ''
-                        }
-                        aria-label={`column name: '${getColumnLabel(column)}' filter input`}
-                      />
-                    )
-                  ) : (
-                    ''
-                  )}
+                      if (event.key === 'ArrowDown') {
+                        event.preventDefault()
+                        handleSort && handleSort(getColumnKey(column), index, 'desc')
+                      }
+                    },
+                    tabIndex: 0,
+                  })}
+                >
+                  <div className="d-inline">{getColumnLabel(column)}</div>
+                  {isSortable && columnSorterIcon(column)}
                 </CTableHeaderCell>
               )
             })}
           </CTableRow>
-        )}
-      </Component>
-    )
-  },
-)
+          {columnFilter && (
+            <CTableRow>
+              {selectable && <CTableHeaderCell></CTableHeaderCell>}
+              {_columns.map((column: Column | string, index: number) => {
+                return (
+                  <CTableHeaderCell {...getTableHeaderCellProps(column)} key={index}>
+                    {(
+                      typeof column === 'object'
+                        ? column.filter === undefined
+                          ? true
+                          : column.filter
+                        : true
+                    ) ? (
+                      typeof column !== 'string' && typeof column.filter === 'function' ? (
+                        !refresh &&
+                        column.filter(
+                          getColumnValues(items, getColumnKey(column)),
+                          (value: any) =>
+                            handleOnCustomFilterChange &&
+                            handleOnCustomFilterChange(getColumnKey(column), value),
+                        )
+                      ) : (
+                        <CFormInput
+                          size="sm"
+                          onInput={(event) =>
+                            handleFilterOnInput &&
+                            handleFilterOnInput(
+                              getColumnKey(column),
+                              (event.target as HTMLInputElement).value,
+                            )
+                          }
+                          onChange={(event) =>
+                            handleFilterOnChange &&
+                            handleFilterOnChange(
+                              getColumnKey(column),
+                              (event.target as HTMLInputElement).value,
+                            )
+                          }
+                          value={
+                            columnFilterState && columnFilterState[getColumnKey(column)]
+                              ? columnFilterState[getColumnKey(column)]
+                              : ''
+                          }
+                          aria-label={`column name: '${getColumnLabel(column)}' filter input`}
+                        />
+                      )
+                    ) : (
+                      ''
+                    )}
+                  </CTableHeaderCell>
+                )
+              })}
+            </CTableRow>
+          )}
+        </Component>
+      )
+    },
+  )
 
 CSmartTableHead.propTypes = {
+  as: PropTypes.elementType,
   columnFilter: PropTypes.oneOfType([PropTypes.bool, PropTypes.object]),
   columnFilterState: PropTypes.object,
   columnSorter: PropTypes.oneOfType([PropTypes.bool, PropTypes.object]),
-  component: PropTypes.elementType,
   children: PropTypes.node,
   columns: PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.any, PropTypes.string])).isRequired, // TODO: improve this Prop Type,
   handleFilterOnChange: PropTypes.func,

package/src/components/spinner/CSpinner.tsx

@@ -2,10 +2,15 @@ import React, { ElementType, forwardRef, HTMLAttributes } from 'react'
 import PropTypes from 'prop-types'
 import classNames from 'classnames'
 
+import { PolymorphicRefForwardingComponent } from '../../helpers'
 import { colorPropType } from '../../props'
 import type { Colors } from '../../types'
 
 export interface CSpinnerProps extends HTMLAttributes<HTMLDivElement | HTMLSpanElement> {
+  /**
+   * 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.
    */
@@ -16,10 +21,6 @@ export interface CSpinnerProps extends HTMLAttributes<HTMLDivElement | HTMLSpanE
    * @type 'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'dark' | 'light' | string
    */
   color?: Colors
-  /**
-   * Component used for the root node. Either a string to use a HTML element or a component.
-   */
-  component?: string | ElementType
   /**
    * Size the component small.
    */
@@ -34,12 +35,15 @@ export interface CSpinnerProps extends HTMLAttributes<HTMLDivElement | HTMLSpanE
   visuallyHiddenLabel?: string
 }
 
-export const CSpinner = forwardRef<HTMLDivElement | HTMLSpanElement, CSpinnerProps>(
+export const CSpinner: PolymorphicRefForwardingComponent<'div', CSpinnerProps> = forwardRef<
+  HTMLDivElement | HTMLSpanElement,
+  CSpinnerProps
+>(
   (
     {
+      as: Component = 'div',
       className,
       color,
-      component: Component = 'div',
       size,
       variant = 'border',
       visuallyHiddenLabel = 'Loading...',
@@ -68,9 +72,9 @@ export const CSpinner = forwardRef<HTMLDivElement | HTMLSpanElement, CSpinnerPro
 )
 
 CSpinner.propTypes = {
+  as: PropTypes.string,
   className: PropTypes.string,
   color: colorPropType,
-  component: PropTypes.string,
   size: PropTypes.oneOf(['sm']),
   variant: PropTypes.oneOf(['border', 'grow']),
   visuallyHiddenLabel: PropTypes.string,

package/src/components/spinner/__tests__/CSpinner.spec.tsx

@@ -10,7 +10,7 @@ test('loads and displays CSpinner component', async () => {
 
 test('CSpinner customize', async () => {
   const { container } = render(
-    <CSpinner className="bazinga" color="warning" component="h3" size="sm" variant="grow">
+    <CSpinner className="bazinga" color="warning" as="h3" size="sm" variant="grow">
       Test
     </CSpinner>,
   )

package/src/components/toast/CToastClose.tsx

@@ -6,17 +6,19 @@ import { CCloseButton, CCloseButtonProps } from '../close-button/CCloseButton'
 
 import { CToastContext } from './CToast'
 
+import { PolymorphicRefForwardingComponent } from '../../helpers'
+
 type CombineButtonProps = CCloseButtonProps & CButtonProps
 
-export interface CToastCloseProps extends CombineButtonProps {
+export interface CToastCloseProps extends Omit<CombineButtonProps, 'as'> {
   /**
    * Component used for the root node. Either a string to use a HTML element or a component.
    */
-  component?: string | ElementType
+  as?: string | ElementType
 }
 
-export const CToastClose = forwardRef<HTMLButtonElement, CToastCloseProps>(
-  ({ children, component: Component, ...rest }, ref) => {
+export const CToastClose: PolymorphicRefForwardingComponent<'button', CToastCloseProps> =
+  forwardRef<HTMLButtonElement, CToastCloseProps>(({ children, as: Component, ...rest }, ref) => {
     const { setVisible } = useContext(CToastContext)
     return Component ? (
       <Component onClick={() => setVisible(false)} {...rest} ref={ref}>
@@ -25,12 +27,11 @@ export const CToastClose = forwardRef<HTMLButtonElement, CToastCloseProps>(
     ) : (
       <CCloseButton onClick={() => setVisible(false)} {...rest} ref={ref} />
     )
-  },
-)
+  })
 
 CToastClose.propTypes = {
   ...CCloseButton.propTypes,
-  component: PropTypes.elementType,
+  as: PropTypes.elementType,
 }
 
 CToastClose.displayName = 'CToastClose'

package/src/components/tooltip/CTooltip.tsx

@@ -90,9 +90,10 @@ export const CTooltip = forwardRef<HTMLDivElement, CTooltipProps>(
     },
     ref,
   ) => {
-    const tooltipRef = useRef(null)
+    const tooltipRef = useRef<HTMLDivElement>(null)
     const togglerRef = useRef(null)
     const forkedRef = useForkedRef(ref, tooltipRef)
+    const uID = useRef(`tooltip${Math.floor(Math.random() * 1_000_000)}`)
 
     const { initPopper, destroyPopper } = usePopper()
     const [_visible, setVisible] = useState(visible)
@@ -127,16 +128,6 @@ export const CTooltip = forwardRef<HTMLDivElement, CTooltipProps>(
       setVisible(visible)
     }, [visible])
 
-    useEffect(() => {
-      if (_visible && togglerRef.current && tooltipRef.current) {
-        initPopper(togglerRef.current, tooltipRef.current, popperConfig)
-      }
-
-      return () => {
-        destroyPopper()
-      }
-    }, [_visible])
-
     const toggleVisible = (visible: boolean) => {
       if (visible) {
         setTimeout(() => setVisible(true), _delay.show)
@@ -149,6 +140,9 @@ export const CTooltip = forwardRef<HTMLDivElement, CTooltipProps>(
     return (
       <>
         {React.cloneElement(children as React.ReactElement<any>, {
+          ...(_visible && {
+            'aria-describedby': uID.current,
+          }),
           ref: togglerRef,
           ...((trigger === 'click' || trigger.includes('click')) && {
             onClick: () => toggleVisible(!_visible),
@@ -167,8 +161,22 @@ export const CTooltip = forwardRef<HTMLDivElement, CTooltipProps>(
             in={_visible}
             mountOnEnter
             nodeRef={tooltipRef}
-            onEnter={onShow}
+            onEnter={() => {
+              if (togglerRef.current && tooltipRef.current) {
+                initPopper(togglerRef.current, tooltipRef.current, popperConfig)
+              }
+
+              onShow
+            }}
+            onEntering={() => {
+              if (togglerRef.current && tooltipRef.current) {
+                tooltipRef.current.style.display = 'initial'
+              }
+            }}
             onExit={onHide}
+            onExited={() => {
+              destroyPopper()
+            }}
             timeout={{
               enter: 0,
               exit: tooltipRef.current
@@ -188,8 +196,12 @@ export const CTooltip = forwardRef<HTMLDivElement, CTooltipProps>(
                   },
                   className,
                 )}
+                id={uID.current}
                 ref={forkedRef}
                 role="tooltip"
+                style={{
+                  display: 'none',
+                }}
                 {...rest}
               >
                 <div className="tooltip-arrow"></div>

package/src/helpers/index.ts

@@ -0,0 +1,3 @@
+import { PolymorphicRefForwardingComponent } from './polymorphicComponent'
+
+export { PolymorphicRefForwardingComponent }

package/src/helpers/polymorphicComponent.ts

@@ -0,0 +1,21 @@
+import { ComponentPropsWithRef, ElementType, PropsWithChildren, ReactNode } from 'react'
+
+export type Omit<T, U> = Pick<T, Exclude<keyof T, keyof U>>
+
+export type ReplaceProps<Inner extends ElementType, P> = Omit<ComponentPropsWithRef<Inner>, P> & P
+
+export interface AsProp<As extends ElementType = ElementType> {
+  as?: As
+}
+
+export interface Props<As extends ElementType = ElementType> extends AsProp<As> {}
+
+export interface PolymorphicRefForwardingComponent<TInitial extends ElementType, P = unknown> {
+  <As extends ElementType = TInitial>(
+    props: PropsWithChildren<ReplaceProps<As, Props<As> & P>>,
+    context?: any, // eslint-disable-line @typescript-eslint/no-explicit-any
+  ): ReactNode | null
+  propTypes?: any // eslint-disable-line @typescript-eslint/no-explicit-any
+  defaultProps?: Partial<P>
+  displayName?: string
+}