@coreui/react-pro 4.8.0-alpha.3 → 4.9.0-next.0

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

@@ -1,81 +1,28 @@
 import { HTMLAttributes, MouseEvent, ReactNode } from 'react'
+
 import { CSmartPaginationProps } from '../smart-pagination/CSmartPagination'
 import { CTableProps } from '../table/CTable'
 import { CTableBodyProps } from '../table/CTableBody'
 import { CTableFootProps } from '../table/CTableFoot'
-import { CTableHeaderCellProps } from '../table/CTableHeaderCell'
-import { CTableRowProps } from '../table/CTableRow'
 import { CTableHeadProps } from '../table/CTableHead'
 
-export interface Column {
-  filter?: boolean | ((values: any[], onChange: (value: any) => void) => ReactNode)
-  label?: string
-  key: string
-  sorter?: boolean
-  _style?: any
-  _props?: CTableHeaderCellProps
-}
-
-export interface ColumnFilter {
-  lazy?: boolean
-  external?: boolean
-}
-
-export interface ColumnFilterValue {
-  [key: string]: any
-}
-
-export interface Item {
-  [key: string]: number | string | any
-  _cellProps?: any
-  _props?: CTableRowProps
-  _selected?: boolean
-}
-
-export interface ItemInternal extends Item {
-  _id: number
-}
-
-export interface ItemsPerPageSelect {
-  external?: boolean
-  label?: string
-  values?: Array<number>
-}
-
-export interface Pagination {
-  external?: boolean
-}
-
-export interface Sorter {
-  resetable?: boolean
-  external?: boolean
-}
-
-export interface ScopedColumns {
-  [key: string]: any
-  details?: (a: Item, b: number) => ReactNode
-}
-
-export interface SorterValue {
-  column?: string
-  state?: number | string
-}
-
-export interface TableFilter {
-  lazy?: boolean
-  external?: boolean
-}
-
-export interface NoItemsView {
-  noResults?: string
-  noItems?: string
-}
+import type {
+  Column,
+  ColumnFilter,
+  ColumnFilterValue,
+  FooterItem,
+  Item,
+  ItemsPerPageSelect,
+  Pagination,
+  Sorter,
+  ScopedColumns,
+  SorterValue,
+  TableFilter,
+} from './types'
 
 export interface CSmartTableProps extends HTMLAttributes<HTMLDivElement> {
   /**
    * Sets active page. If 'pagination' prop is enabled, activePage is set only initially.
-   *
-   * @default 1
    */
   activePage?: number
   /**
@@ -85,8 +32,6 @@ export interface CSmartTableProps extends HTMLAttributes<HTMLDivElement> {
   cleaner?: boolean
   /**
    * Style table items as clickable.
-   *
-   * @type boolean
    */
   clickableRows?: boolean
   /**
@@ -94,13 +39,11 @@ export interface CSmartTableProps extends HTMLAttributes<HTMLDivElement> {
    * Column filter can be customized, by passing prop as object with additional options as keys. Available options:
    * - external (Boolean) - Disables automatic filtering inside component.
    * - lazy (Boolean) - Set to true to trigger filter updates only on change event.
-   *
-   * @type boolean | ColumnFilter
    */
   columnFilter?: boolean | ColumnFilter
   /**
    * Value of table filter. To set pass object where keys are column names and values are filter strings e.g.:
-   * { user: 'John', age: 12 }
+   * `{ user: 'John', age: 12 }`
    */
   columnFilterValue?: ColumnFilterValue
   /**
@@ -123,46 +66,49 @@ export interface CSmartTableProps extends HTMLAttributes<HTMLDivElement> {
    * Sorter can be customized, by passing prop as object with additional options as keys. Available options:
    * - external (Boolean) - Disables automatic sorting inside component.
    * - resetable (Boolean) - If set to true clicking on sorter have three states: ascending, descending and null. That means that third click on sorter will reset sorting, and restore table to original order.
-   *
-   * @type boolean | Sorter
    */
   columnSorter?: boolean | Sorter
   /**
-   * Displays table footer, which mirrors table header. (without column filter).
+   * ReactNode for passing custom CElementCover content.
+   *
+   * @since 4.9.0
    */
-  footer?: boolean
+  elementCover?: ReactNode
   /**
-   * Set to false to remove table header.
+   * If `true` Displays table footer, which mirrors table header. (without column filter).
+   * Or Array of objects or strings, where each element represents one cell in the table footer.
    *
-   * @default true
+   * Example items:
+   * `['FooterCell', 'FooterCell', 'FooterCell']`
+   * or
+   * `[{ label: 'FooterCell', _props: { color: 'success' }, ...]`
+   */
+  footer?: boolean | (FooterItem | string)[]
+  /**
+   * Set to false to remove table header.
    */
   header?: boolean
   /**
-   * Array of objects, where each object represents one item - row in table. Additionally, you can add style classes to each row by passing them by '_classes' key and to single cell by '_cellClasses'.
+   * Array of objects, where each object represents one item - row in table. Additionally, you can add style classes to each row by passing them by '_props' key and to single cell by '_cellProps'.
    *
    * Example item:
-   * { name: 'John' , age: 12, _props: { color: 'success' }, _cellProps: { age: { className: 'fw-bold'}}}
-   * For column generation description watch columns prop.
-   *
-   * @type Array<string>
+   * `{ name: 'John' , age: 12, _props: { color: 'success' }, _cellProps: { age: { className: 'fw-bold'}}}`
    */
   items?: Item[]
+  /**
+   * The total number of items. Use if you pass a portion of data from an external source to let know component what is the total number of items.
+   */
+  itemsNumber?: number
   /**
    * Number of items per site, when pagination is enabled.
-   *
-   * @default 10
    */
   itemsPerPage?: number
   /**
    * Label for items per page selector.
-   *
-   * @default 'Items per page:'
    */
   itemsPerPageLabel?: string
   /**
    * Items per page selector options.
-   *
-   * @default [5, 10, 20, 50]
    */
   itemsPerPageOptions?: number[]
   /**
@@ -178,7 +124,6 @@ export interface CSmartTableProps extends HTMLAttributes<HTMLDivElement> {
   loading?: boolean
   /**
    * ReactNode or string for passing custom noItemsLabel texts.
-   * @default 'No items found'
    */
   noItemsLabel?: string | ReactNode
   /**
@@ -201,6 +146,10 @@ export interface CSmartTableProps extends HTMLAttributes<HTMLDivElement> {
    * Row click callback.
    */
   onRowClick?: (item: Item, index: number, columnName: string, event: MouseEvent | boolean) => void
+  /**
+   * Select all callback.
+   */
+  onSelectAll?: () => void
   /**
    * Selected items change callback.
    */
@@ -218,15 +167,11 @@ export interface CSmartTableProps extends HTMLAttributes<HTMLDivElement> {
    */
   pagination?: boolean | Pagination
   /**
-   * Properties to `CSmartPagination` component.
-   *
-   * @link https://coreui.io/react/docs/components/smart-pagination#csmartpagination
+   * Properties to `CSmartPagination` component - https://coreui.io/react/docs/components/smart-pagination#csmartpagination
    */
   paginationProps?: CSmartPaginationProps
   /**
    * Scoped columns.
-   *
-   * @type scopedColumns
    */
   scopedColumns?: ScopedColumns
   /**
@@ -234,39 +179,40 @@ export interface CSmartTableProps extends HTMLAttributes<HTMLDivElement> {
    */
   selectable?: boolean
   /**
-   * State of the sorter. Name key is column name, direction can be 'asc' or 'desc'.
+   * Enables select all checkbox displayed in the header of the table.
+   *
+   * Can be customized, by passing prop as object with additional options as keys. Available options:
+   * - external (Boolean) - Disables automatic selection inside the component.
+   */
+  selectAll?: boolean | { external?: boolean }
+  /**
+   * Array of selected objects, where each object represents one item - row in table.
    *
-   * @type SorterValue
+   * Example item: `{ name: 'John' , age: 12 }`
+   */
+  selected?: Item[]
+  /**
+   * State of the sorter. Name key is column name, direction can be 'asc' or 'desc'.
    */
   sorterValue?: SorterValue
   /**
    * Sorter icon when items are unsorted.
-   *
-   * @default '<CIcon width="18" content={cilArrowTop} />
    */
   sortingIcon?: ReactNode
   /**
    * Sorter icon when items are sorted ascending.
-   *
-   * @default '<CIcon width="18" content={cilArrowTop} />
    */
   sortingIconAscending?: ReactNode
   /**
    * Sorter icon when items are sorted descending.
-   *
-   * @default '<CIcon width="18" content={cilArrowBottom} />'
    */
   sortingIconDescending?: ReactNode
   /**
-   * Properties to `CTableBody` component.
-   *
-   * @link https://coreui.io/react/docs/components/table/#ctablebody
+   * Properties to `CTableBody` component - https://coreui.io/react/docs/components/table/#ctablebody
    */
   tableBodyProps?: CTableBodyProps
   /**
-   * Properties to `CTableFoot` component.
-   *
-   * @link https://coreui.io/react/docs/components/table/#ctablefoot
+   * Properties to `CTableFoot` component - https://coreui.io/react/docs/components/table/#ctablefoot
    */
   tableFootProps?: CTableFootProps
   /**
@@ -279,31 +225,22 @@ export interface CSmartTableProps extends HTMLAttributes<HTMLDivElement> {
   tableFilter?: boolean | TableFilter
   /**
    * The element represents a caption for a component.
-   *
-   * @default 'Filter:'
    */
   tableFilterLabel?: string
   /**
    * Specifies a short hint that is visible in the search input.
-   *
-   * @default 'type string...'
    */
   tableFilterPlaceholder?: string
   /**
    * Value of table filter.
-   *
    */
   tableFilterValue?: string
   /**
-   * Properties to `CTableHead` component.
-   *
-   * @link https://coreui.io/react/docs/components/table/#ctablehead
+   * Properties to `CTableHead` component - https://coreui.io/react/docs/components/table/#ctablehead
    */
   tableHeadProps?: CTableHeadProps
   /**
-   * Properties to `CTable` component.
-   *
-   * @link https://coreui.io/react/docs/components/table/#ctable
+   * Properties to `CTable` component - https://coreui.io/react/docs/components/table/#ctable
    */
   tableProps?: CTableProps
 }

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

@@ -1,8 +1,7 @@
 import React, { forwardRef, HTMLAttributes } from 'react'
 import PropTypes from 'prop-types'
 
-import { CFormLabel } from '../form/CFormLabel'
-import { CFormSelect } from '../form/CFormSelect'
+import { CFormLabel, CFormSelect } from '../form/'
 
 interface CSmartTableItemsPerPageSelectorProps extends HTMLAttributes<HTMLSelectElement> {
   itemsPerPage?: number

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

@@ -0,0 +1,65 @@
+import { ReactNode } from 'react'
+
+import { CTableDataCellProps } from '../table/CTableDataCell'
+import { CTableHeaderCellProps } from '../table/CTableHeaderCell'
+import { CTableRowProps } from '../table/CTableRow'
+
+export type Column = {
+  filter?: boolean | ((values: any[], onChange: (value: any) => void) => ReactNode)
+  label?: string
+  key: string
+  sorter?: boolean
+  _style?: any
+  _props?: CTableHeaderCellProps
+}
+
+export type ColumnFilter = {
+  lazy?: boolean
+  external?: boolean
+}
+
+export type ColumnFilterValue = {
+  [key: string]: any
+}
+
+export type FooterItem = {
+  label?: string
+  _props?: CTableDataCellProps
+}
+
+export type Item = {
+  [key: string]: number | string | any
+  _cellProps?: any
+  _props?: CTableRowProps
+  _selected?: boolean
+}
+
+export type ItemsPerPageSelect = {
+  external?: boolean
+  label?: string
+  values?: Array<number>
+}
+
+export type Pagination = {
+  external?: boolean
+}
+
+export type Sorter = {
+  resetable?: boolean
+  external?: boolean
+}
+
+export type ScopedColumns = {
+  [key: string]: any
+  details?: (a: Item, b: number) => ReactNode
+}
+
+export type SorterValue = {
+  column?: string
+  state?: number | string
+}
+
+export type TableFilter = {
+  lazy?: boolean
+  external?: boolean
+}

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

@@ -0,0 +1,199 @@
+import type {
+  Column,
+  ColumnFilter,
+  ColumnFilterValue,
+  Item,
+  Sorter,
+  SorterValue,
+  TableFilter,
+} from './types'
+
+export const filterColumns = (
+  items: Item[],
+  columnFilter: boolean | ColumnFilter | undefined,
+  columnFilterState: ColumnFilterValue,
+  itemsDataColumns: string[],
+) => {
+  if (columnFilter && typeof columnFilter === 'object' && columnFilter.external) {
+    return items
+  }
+
+  Object.entries(columnFilterState).forEach(([key, value]) => {
+    if (value instanceof Function) {
+      items = items.filter((item) => value(item[key]))
+      return
+    }
+
+    const columnFilter = String(value).toLowerCase()
+    if (columnFilter && itemsDataColumns.includes(key)) {
+      items = items.filter((item) => {
+        return String(item[key]).toLowerCase().includes(columnFilter)
+      })
+    }
+  })
+
+  return items
+}
+
+export const filterTable = (
+  items: Item[],
+  tableFilter: boolean | TableFilter | undefined,
+  tableFilterState: string,
+  itemsDataColumns: string[],
+) => {
+  if (
+    !tableFilterState ||
+    (tableFilter && typeof tableFilter === 'object' && tableFilter.external)
+  ) {
+    return items
+  }
+
+  const filter = tableFilterState.toLowerCase()
+  const valueContainFilter = (val: any) => String(val).toLowerCase().includes(filter)
+  items = items.filter((item) => {
+    return !!itemsDataColumns.find((key) => valueContainFilter(item[key]))
+  })
+
+  return items
+}
+
+export const getClickedColumnName = (
+  target: HTMLTextAreaElement,
+  columnNames: string[],
+): string => {
+  const closest = target.closest('tr')
+  const children = closest ? Array.from(closest.children) : []
+  const clickedCell = children.filter((child) => child.contains(target))[0]
+  return columnNames[children.indexOf(clickedCell)]
+}
+
+export const getColumnKey = (column: Column | string) =>
+  typeof column === 'object' ? column.key : column
+
+export const getColumnLabel = (column: Column | string) =>
+  typeof column === 'object'
+    ? column.label !== undefined
+      ? column.label
+      : pretifyName(column.key)
+    : pretifyName(column)
+
+export const getColumnNames = (columns: (string | Column)[] | undefined, items: Item[]) =>
+  columns
+    ? columns.map((column: Column) => {
+        if (typeof column === 'object') return column.key
+        else return column
+      })
+    : getColumnNamesFromItems(items)
+
+export const getColumnNamesFromItems = (items: Item[]) =>
+  Object.keys(items[0] || {}).filter((el) => el.charAt(0) !== '_')
+
+export const getColumnSorterState = (
+  key: string,
+  sorterState: SorterValue | undefined,
+): string | number => {
+  if (sorterState && sorterState.column === key) {
+    if (sorterState.state) {
+      return sorterState.state
+    }
+    return 0
+  }
+
+  return 0
+}
+
+export const getColumnValues = (items: Item[], key: string) => {
+  return items.map((item) => item[key])
+}
+
+export const getTableDataCellProps = (item: Item, colName: string) => {
+  const props = item._cellProps && {
+    ...(item._cellProps['all'] && { ...item._cellProps['all'] }),
+    ...(item._cellProps[colName] && { ...item._cellProps[colName] }),
+  }
+
+  return props
+}
+
+export const getTableHeaderCellProps = (column: Column | string) => {
+  if (typeof column === 'object' && column._props) {
+    return column._props
+  }
+
+  return {}
+}
+
+export const getTableHeaderCellStyles = (
+  column: Column | string,
+  columnSorter: boolean | Sorter | undefined,
+) => {
+  const style = {}
+
+  if (
+    columnSorter &&
+    (typeof column !== 'object' ||
+      (typeof column === 'object' && (typeof column.sorter === 'undefined' || column.sorter)))
+  ) {
+    style['cursor'] = 'pointer'
+  }
+
+  if (typeof column === 'object' && column._style) {
+    return { ...style, ...column._style }
+  }
+  return style
+}
+
+export const isSortable = (
+  i: number,
+  columns: (string | Column)[] | undefined,
+  columnSorter: Sorter | boolean | undefined,
+  itemsDataColumns: string[],
+  columnNames: string[],
+): boolean | undefined => {
+  const isDataColumn = itemsDataColumns.includes(columnNames[i])
+  let column
+  if (columns) column = columns[i]
+  return (
+    columnSorter &&
+    (!columns ||
+      typeof column !== 'object' ||
+      (typeof column === 'object' && (typeof column.sorter === 'undefined' || column.sorter))) &&
+    isDataColumn
+  )
+}
+
+export const pretifyName = (name: string) => {
+  return name
+    .replace(/[-_.]/g, ' ')
+    .replace(/ +/g, ' ')
+    .replace(/([a-z0-9])([A-Z])/g, '$1 $2')
+    .split(' ')
+    .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
+    .join(' ')
+}
+
+export const sortItems = (
+  columnSorter: boolean | Sorter | undefined,
+  items: Item[],
+  itemsDataColumns: string[],
+  sorterState: SorterValue,
+) => {
+  const column = sorterState.column
+  if (
+    !column ||
+    !itemsDataColumns.includes(column) ||
+    (columnSorter && typeof columnSorter === 'object' && columnSorter.external)
+  ) {
+    return items
+  }
+
+  const flip = sorterState.state === 'asc' ? 1 : sorterState.state === 'desc' ? -1 : 0
+  const sorted = items.slice().sort((item, item2) => {
+    const value = item[column]
+    const value2 = item2[column]
+    const a = typeof value === 'number' ? value : String(value).toLowerCase()
+    const b = typeof value2 === 'number' ? value2 : String(value2).toLowerCase()
+    return a > b ? 1 * flip : b > a ? -1 * flip : 0
+  })
+  return sorted
+}

package/src/components/table/CTable.tsx

@@ -53,7 +53,7 @@ export interface CTableProps extends Omit<TableHTMLAttributes<HTMLTableElement>,
    * Object: item is object with following keys available as column configuration:
    * - key (required)(String) - define column name equal to item key.
    * - label (String) - define visible label of column. If not defined, label will be generated automatically based on column name, by converting kebab-case and snake_case to individual words and capitalization of each word.
-   * - _props (Object) - adds classes to all cels in column, ex. _props: { scope: 'col', className: 'custom-class' },
+   * - _props (Object) - adds classes to all cels in column, ex. `_props: { scope: 'col', className: 'custom-class' }`,
    * - _style (Object) - adds styles to the column header (useful for defining widths)
    *
    * @since 4.3.0
@@ -69,13 +69,13 @@ export interface CTableProps extends Omit<TableHTMLAttributes<HTMLTableElement>,
    * Array of objects or strings, where each element represents one cell in the table footer.
    *
    * Example items:
-   * ['FooterCell', 'FooterCell', 'FooterCell']
+   * `['FooterCell', 'FooterCell', 'FooterCell']`
    * or
-   * [{ label: 'FooterCell', _props: { color: 'success' }, ...]
+   * `[{ label: 'FooterCell', _props: { color: 'success' }, ...]`
    *
    * @since 4.3.0
    */
-  footer?: FooterItem[]
+  footer?: (FooterItem | string)[]
   /**
    * Enable a hover state on table rows within a `<CTableBody>`.
    */
@@ -84,7 +84,7 @@ export interface CTableProps extends Omit<TableHTMLAttributes<HTMLTableElement>,
    * Array of objects, where each object represents one item - row in table. Additionally, you can add style classes to each row by passing them by '_props' key and to single cell by '_cellProps'.
    *
    * Example item:
-   * { name: 'John' , age: 12, _props: { color: 'success' }, _cellProps: { age: { className: 'fw-bold'}}}
+   * `{ name: 'John' , age: 12, _props: { color: 'success' }, _cellProps: { age: { className: 'fw-bold'}}}`
    *
    * @since 4.3.0
    */
@@ -155,7 +155,7 @@ export const CTable = forwardRef<HTMLTableElement, CTableProps>(
       columns,
       footer,
       hover,
-      items = [],
+      items,
       responsive,
       small,
       striped,
@@ -188,7 +188,7 @@ export const CTable = forwardRef<HTMLTableElement, CTableProps>(
           if (typeof column === 'object') return column.key
           else return column
         })
-      : Object.keys(items[0] || {}).filter((el) => el.charAt(0) !== '_')
+      : Object.keys((items && items[0]) || {}).filter((el) => el.charAt(0) !== '_')
 
     const pretifyName = (name: string) => {
       return name
@@ -253,8 +253,11 @@ export const CTable = forwardRef<HTMLTableElement, CTableProps>(
           {footer && (
             <CTableFoot {...tableFootProps}>
               <CTableRow>
-                {footer.map((item: FooterItem, index: number) => (
-                  <CTableDataCell {...(item._props && { ...item._props })} key={index}>
+                {footer.map((item: FooterItem | string, index: number) => (
+                  <CTableDataCell
+                    {...(typeof item === 'object' && item._props && { ...item._props })}
+                    key={index}
+                  >
                     {typeof item === 'object' ? item.label : item}
                   </CTableDataCell>
                 ))}

package/src/components/tabs/CTabPane.tsx

@@ -3,7 +3,7 @@ import PropTypes from 'prop-types'
 import classNames from 'classnames'
 import { Transition } from 'react-transition-group'
 
-import { useForkedRef } from '../../utils/hooks'
+import { useForkedRef } from '../../hooks'
 export interface CTabPaneProps extends HTMLAttributes<HTMLDivElement> {
   /**
    * A string of all className you want applied to the base component.