@coreui/react-pro 4.0.0-rc.1

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

@@ -0,0 +1,181 @@
+import React, { ElementType, forwardRef, ReactNode } from 'react'
+import PropTypes from 'prop-types'
+
+import { ColumnFilter, Column, Sorter, SorterValue } from './CSmartTableInterface'
+
+import { CFormInput } from '../form/CFormInput'
+import { CTableHead, CTableHeadProps } from '../table/CTableHead'
+import { CTableHeaderCell } from '../table/CTableHeaderCell'
+import { CTableRow } from '../table/CTableRow'
+export interface CSmartTableHeadProps extends CTableHeadProps {
+  columnFilter?: boolean | ColumnFilter
+  columnSorter?: boolean | Sorter
+  component?: string | ElementType
+  columns: (Column | string)[]
+  handleFilterOnChange?: (key: string, value: string) => void
+  handleFilterOnInput?: (key: string, value: string) => void
+  handleSort?: (key: string, index: number) => void
+  sorterState?: SorterValue
+  sortingIcon?: ReactNode
+  sortingIconAscending?: ReactNode
+  sortingIconDescending?: ReactNode
+}
+
+export const CSmartTableHead = forwardRef<HTMLTableSectionElement, CSmartTableHeadProps>(
+  (
+    {
+      columnFilter,
+      columnSorter,
+      component: Component = CTableHead,
+      columns,
+      handleFilterOnChange,
+      handleFilterOnInput,
+      handleSort,
+      sorterState,
+      sortingIcon,
+      sortingIconAscending,
+      sortingIconDescending,
+      ...rest
+    },
+    ref,
+  ) => {
+    const tableHeaderCellProps = (column: Column | string) => {
+      if (typeof column === 'object' && column._props) {
+        return column._props
+      }
+      return {}
+    }
+
+    const tableHeaderCellStyles = (column: Column | string) => {
+      const style = { verticalAlign: 'middle', overflow: 'hidden', cursor: '' }
+
+      if (
+        columnSorter &&
+        (typeof column !== 'object' ||
+          (typeof column === 'object' && (typeof column.sorter === 'undefined' || column.sorter)))
+      ) {
+        style.cursor = 'pointer'
+      }
+
+      if (typeof column === 'object' && column._props) {
+        return { ...style, ...column._style }
+      }
+      return style
+    }
+
+    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(' ')
+    }
+
+    const label = (column: Column | string) =>
+      typeof column === 'object'
+        ? column.label !== undefined
+          ? column.label
+          : pretifyName(column.key)
+        : pretifyName(column)
+
+    const key = (column: Column | string) => (typeof column === 'object' ? column.key : column)
+
+    const getColumnSorterState = (key: string): string | number => {
+      if (sorterState && sorterState.column === key) {
+        if (sorterState.state) {
+          return sorterState.state
+        }
+        return 0
+      }
+
+      return 0
+    }
+
+    const columnSorterIcon = (column: Column | string) => {
+      if (getColumnSorterState(key(column)) === 0) {
+        return <span className="opacity-25 float-end me-1">{sortingIcon}</span>
+      }
+      if (getColumnSorterState(key(column)) === 'asc') {
+        return <span className="float-end me-1">{sortingIconAscending}</span>
+      }
+      if (getColumnSorterState(key(column)) === 'desc') {
+        return <span className="float-end me-1">{sortingIconDescending}</span>
+      }
+      return
+    }
+
+    return (
+      <Component {...rest} ref={ref}>
+        <CTableRow>
+          {columns.map((column: Column | string, index: number) => {
+            return (
+              <CTableHeaderCell
+                {...tableHeaderCellProps(column)}
+                onClick={() => handleSort && handleSort(key(column), index)}
+                style={tableHeaderCellStyles(column)}
+                key={index}
+              >
+                <div className="d-inline">{label(column)}</div>
+                {columnSorter &&
+                  (typeof column !== 'object'
+                    ? true
+                    : typeof column.sorter === 'undefined'
+                    ? true
+                    : column.sorter) &&
+                  columnSorterIcon(column)}
+              </CTableHeaderCell>
+            )
+          })}
+        </CTableRow>
+        {columnFilter && (
+          <CTableRow>
+            {columns.map((column: Column | string, index: number) => {
+              return (
+                <CTableHeaderCell {...tableHeaderCellProps(column)} key={index}>
+                  {(typeof column !== 'object'
+                    ? true
+                    : typeof column.filter === 'undefined'
+                    ? true
+                    : column.filter) && (
+                    <CFormInput
+                      size="sm"
+                      onInput={(event) =>
+                        handleFilterOnInput &&
+                        handleFilterOnInput(key(column), (event.target as HTMLInputElement).value)
+                      }
+                      onChange={(event) =>
+                        handleFilterOnChange &&
+                        handleFilterOnChange(key(column), (event.target as HTMLInputElement).value)
+                      }
+                      // value={columnFilterState[colName] || ''}
+                      aria-label={`column name: '${label(column)}' filter input`}
+                    />
+                  )}
+                </CTableHeaderCell>
+              )
+            })}
+          </CTableRow>
+        )}
+      </Component>
+    )
+  },
+)
+
+CSmartTableHead.propTypes = {
+  columnFilter: PropTypes.oneOfType([PropTypes.bool, PropTypes.object]),
+  columnSorter: PropTypes.bool,
+  component: PropTypes.elementType,
+  children: PropTypes.node,
+  columns: PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.any, PropTypes.string])).isRequired, // TODO: improve this Prop Type,
+  handleFilterOnChange: PropTypes.func,
+  handleFilterOnInput: PropTypes.func,
+  handleSort: PropTypes.func,
+  sorterState: PropTypes.object,
+  sortingIcon: PropTypes.node,
+  sortingIconAscending: PropTypes.node,
+  sortingIconDescending: PropTypes.node,
+}
+
+CSmartTableHead.displayName = 'CSmartTableHead'

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

@@ -0,0 +1,300 @@
+import { HTMLAttributes, MouseEvent, ReactNode } from 'react'
+import { CSmartPaginationProps } from '../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 {
+  sorter?: boolean
+  key: string
+  label?: string
+  filter?: 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
+  _props: CTableRowProps
+}
+
+export interface ItemsPerPageSelect {
+  external?: boolean
+  label?: string
+  values?: Array<number>
+}
+
+export interface Sorter {
+  resetable?: boolean
+  external?: boolean
+}
+
+export interface ScopedColumns {
+  details?: (a: Item, b: number) => ReactNode
+}
+
+export interface SorterValue {
+  column?: string
+  state?: number | string
+}
+
+export interface TableFilter {
+  lazy?: boolean
+  external?: boolean
+  label?: string
+  placeholder?: string
+}
+
+export interface NoItemsView {
+  noResults?: string
+  noItems?: string
+}
+
+export interface CSmartTableProps extends HTMLAttributes<HTMLDivElement> {
+  /**
+   * Sets active page. If 'pagination' prop is enabled, activePage is set only initially. [docs]
+   *
+   * @default 1
+   */
+  activePage?: number
+  /**
+   * A string of all className you want applied to the base component. [docs]
+   */
+  className?: string
+  /**
+   * When set, displays table cleaner above table, next to the table filter (or in place of table filter if `tableFilter` prop is not set)
+   * Cleaner resets `tableFilterValue`, `columnFilterValue`, `sorterValue`. If clean is possible it is clickable (`tabIndex="0"` `role="button"`, `color="danger"`), otherwise it is not clickable and transparent. Cleaner can be customized through the `cleaner` slot. [docs]
+   *
+   */
+  cleaner?: boolean
+  /**
+   * Style table items as clickable. [docs]
+   *
+   * @type boolean
+   */
+  clickableRows?: boolean
+  /**
+   * When set, displays additional filter row between table header and items, allowing filtering by specific column.
+   * 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. [docs]
+   *
+   * @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 }
+   * You can track state of this prop by setting .sync modifier. [docs]
+   */
+  columnFilterValue?: ColumnFilterValue
+  /**
+   * Prop for table columns configuration. If prop is not defined, table will display columns based on the first item keys, omitting keys that begins with underscore (e.g. '_classes')
+   *
+   * In columns prop each array item represents one column. Item might be specified in two ways:
+   * String: each item define column name equal to item value.
+   * 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.
+   * - _classes (String/Array/Object) - adds classes to all cels in column
+   * - _style (String/Array/Object) - adds styles to the column header (useful for defining widths)
+   * - sorter (Boolean) - disables sorting of the column when set to false
+   * - filter (Boolean) - removes filter from column when set to false. [docs]
+   */
+  columns?: Column[] | string[]
+  /**
+   * Enables table sorting by column value. Sorting will be performed corectly only if values in column are of one type: string (case insensitive) or number.
+   *
+   * 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. [docs]
+   *
+   * @type boolean | Sorter
+   */
+  columnSorter?: boolean | Sorter
+  /**
+   * Displays table footer, which mirrors table header. (without column filter). [docs]
+   */
+  footer?: boolean
+  /**
+   * Set to false to remove table header. [docs]
+   *
+   * @default true
+   */
+  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'.
+   *
+   * Example item:
+   * { name: 'John' , age: 12, _props: { color: 'success' }, _cellProps: { age: { className: 'fw-bold'}}}
+   * For column generation description watch columns prop. [docs]
+   *
+   * @type Array<string>
+   */
+  items?: Item[]
+  /**
+   * Number of items per site, when pagination is enabled. [docs]
+   *
+   * @default 10
+   */
+  itemsPerPage?: number
+  /**
+   * Label for items per page selector. [docs]
+   *
+   * @default 'Items per page:'
+   */
+  itemsPerPageLabel?: string
+  /**
+   * Items per page selector options. [docs]
+   *
+   * @default [5, 10, 20, 50]
+   */
+  itemsPerPageOptions?: number[]
+  /**
+   * Adds select element over table, which is used for control items per page in pagination. If you want to customize this element, pass object with optional values:
+   * - label (String) - replaces default label text
+   * - values (Array) - custom array of pagination values
+   * - external (Boolean) - disables automatic 'itemsPerPage' change (use to change pages externaly by 'pagination-change' event). [docs]
+   */
+  itemsPerPageSelect?: boolean | ItemsPerPageSelect
+  /**
+   * When set, table will have loading style: loading spinner and reduced opacity. When 'small' prop is enabled spinner will be also smaller. [docs]
+   */
+  loading?: boolean
+  /**
+   * ReactNode or string for passing custom noItemsLabel texts. [docs]
+   * @default 'No items found'
+   */
+  noItemsLabel?: string | ReactNode
+  /**
+   * Page change callback. [docs]
+   */
+  onActivePageChange?: (value: number) => void
+  /**
+   * Column filter change callback. [docs]
+   */
+  onColumnFilterChange?: (value: ColumnFilterValue) => void //!
+  /**
+   * Filtered items change callback. [docs]
+   */
+  onFilteredItemsChange?: (items: Item[]) => void
+  /**
+   * Pagination change callback. [docs]
+   */
+  onItemsPerPageChange?: (value: number) => void
+  /**
+   * Row click callback. [docs]
+   */
+  onRowClick?: (item: Item, index: number, columnName: string, event: MouseEvent | boolean) => void
+  /**
+   * Sorter value change callback. [docs]
+   */
+  onSorterChange?: (value: SorterValue) => void
+  /**
+   * Table filter change callback. [docs]
+   */
+  onTableFilterChange?: (value?: string) => void
+  /**
+   * Enables default pagination. Set to true for default setup or pass an object with additional CPagination props. Default pagination will always have the computed number of pages that cannot be changed. The number of pages is generated based on the number of passed items and 'itemsPerPage' prop. If this restriction is an obstacle, you can make external CPagination instead. [docs]
+   */
+  pagination?: boolean
+  /**
+   * Properties to `CSmartPagination` component. [docs]
+   *
+   * @link https://coreui.io/react/docs/4.0/components/smart-pagination#csmartpagination
+   */
+  paginationProps?: CSmartPaginationProps
+  /**
+   * Scoped columns. [docs]
+   *
+   * @type scopedColumns
+   */
+  scopedColumns?: ScopedColumns
+  /**
+   * State of the sorter. Name key is column name, direction can be 'asc' or 'desc'. Set .sync modifier to track changes. [docs]
+   *
+   * @type SorterValue
+   */
+  sorterValue?: SorterValue
+  /**
+   * Sorter icon when items are unsorted. [docs]
+   *
+   * @default '<CIcon width="18" content={cilArrowTop} />
+   */
+  sortingIcon?: ReactNode
+  /**
+   * Sorter icon when items are sorted ascending. [docs]
+   *
+   * @default '<CIcon width="18" content={cilArrowTop} />
+   */
+  sortingIconAscending?: ReactNode
+  /**
+   * Sorter icon when items are sorted descending. [docs]
+   *
+   * @default '<CIcon width="18" content={cilArrowBottom} />'
+   */
+  sortingIconDescending?: ReactNode
+  /**
+   * Properties to `CTableBody` component. [docs]
+   *
+   * @link https://coreui.io/react/docs/4.0/components/table/#ctablebody
+   */
+  tableBodyProps?: CTableBodyProps
+  /**
+   * Properties to `CTableFoot` component. [docs]
+   *
+   * @link https://coreui.io/react/docs/4.0/components/table/#ctablefoot
+   */
+  tableFootProps?: CTableFootProps
+  /**
+   * When set, displays table filter above table, allowing filtering by specific column.
+   *
+   * Column filter can be customized, by passing prop as object with additional options as keys. Available options:
+   * - placeholder (String) - Sets custom table filter placeholder.
+   * - label (String) - Sets custom table filter label.
+   * - external (Boolean) - Disables automatic filtering inside component.
+   * - lazy (Boolean) - Set to true to trigger filter updates only on change event. [docs]
+   */
+  tableFilter?: boolean | TableFilter
+  /**
+   * The element represents a caption for a component. [docs]
+   *
+   * @default 'Filter:'
+   */
+  tableFilterLabel?: string
+  /**
+   * Specifies a short hint that is visible in the search input. [docs]
+   *
+   * @default 'type string...'
+   */
+  tableFilterPlaceholder?: string
+  /**
+   * Value of table filter. Set .sync modifier to track changes. [docs]
+   *
+   */
+  tableFilterValue?: string
+  /**
+   * Properties to `CTableHead` component. [docs]
+   *
+   * @link https://coreui.io/react/docs/4.0/components/table/#ctablehead
+   */
+  tableHeadProps?: CTableHeadProps
+  /**
+   * Properties to `CTable` component. [docs]
+   *
+   * @link https://coreui.io/react/docs/4.0/components/table/#ctable
+   */
+  tableProps?: CTableProps
+}

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

@@ -0,0 +1,42 @@
+import React, { forwardRef, HTMLAttributes } from 'react'
+import PropTypes from 'prop-types'
+
+import { CFormLabel } from '../form/CFormLabel'
+import { CFormSelect } from '../form/CFormSelect'
+
+interface CSmartTableItemsPerPageSelectorProps extends HTMLAttributes<HTMLSelectElement> {
+  itemsPerPage?: number
+  itemsPerPageLabel?: string
+  itemsPerPageOptions?: number[]
+}
+
+export const CSmartTableItemsPerPageSelector = forwardRef<
+  HTMLSelectElement,
+  CSmartTableItemsPerPageSelectorProps
+>(({ itemsPerPage, itemsPerPageLabel, itemsPerPageOptions, ...rest }, ref) => {
+  return (
+    <div className="row">
+      <CFormLabel className="col-auto col-form-label">{itemsPerPageLabel}</CFormLabel>
+      <div className="col-auto">
+        <CFormSelect defaultValue={itemsPerPage} {...rest} ref={ref}>
+          {itemsPerPageOptions &&
+            itemsPerPageOptions.map((number, index) => {
+              return (
+                <option value={number} key={index}>
+                  {number}
+                </option>
+              )
+            })}
+        </CFormSelect>
+      </div>
+    </div>
+  )
+})
+
+CSmartTableItemsPerPageSelector.propTypes = {
+  itemsPerPage: PropTypes.number,
+  itemsPerPageLabel: PropTypes.string,
+  itemsPerPageOptions: PropTypes.array,
+}
+
+CSmartTableItemsPerPageSelector.displayName = 'CSmartTableItemsPerPageSelector'

package/src/components/spinner/CSpinner.tsx

@@ -0,0 +1,79 @@
+import React, { ElementType, forwardRef, HTMLAttributes } from 'react'
+import PropTypes from 'prop-types'
+import classNames from 'classnames'
+
+import { Colors, colorPropType } from '../Types'
+
+export interface CSpinnerProps extends HTMLAttributes<HTMLDivElement | HTMLSpanElement> {
+  /**
+   * A string of all className you want applied to the component. [docs]
+   */
+  className?: string
+  /**
+   * Sets the color context of the component to one of CoreUI’s themed colors. [docs]
+   *
+   * @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. [docs]
+   *
+   * @default 'div'
+   */
+  component?: string | ElementType
+  /**
+   * Size the component small. [docs]
+   */
+  size?: 'sm'
+  /**
+   * Set the button variant to an outlined button or a ghost button. [docs]
+   *
+   * @default 'border'
+   */
+  variant?: 'border' | 'grow'
+  /**
+   * Set visually hidden label for accessibility purposes. [docs]
+   *
+   * @default 'Loading...'
+   */
+  visuallyHiddenLabel?: string
+}
+
+export const CSpinner = forwardRef<HTMLDivElement | HTMLSpanElement, CSpinnerProps>(
+  (
+    {
+      className,
+      color,
+      component: Component = 'div',
+      size,
+      variant = 'border',
+      visuallyHiddenLabel = 'Loading...',
+      ...rest
+    },
+    ref,
+  ) => {
+    const _className = classNames(
+      `spinner-${variant}`,
+      `text-${color}`,
+      size && `spinner-${variant}-${size}`,
+      className,
+    )
+
+    return (
+      <Component className={_className} role="status" {...rest} ref={ref}>
+        <span className="visually-hidden">{visuallyHiddenLabel}</span>
+      </Component>
+    )
+  },
+)
+
+CSpinner.propTypes = {
+  className: PropTypes.string,
+  color: colorPropType,
+  component: PropTypes.string,
+  size: PropTypes.oneOf(['sm']),
+  variant: PropTypes.oneOf(['border', 'grow']),
+  visuallyHiddenLabel: PropTypes.string,
+}
+
+CSpinner.displayName = 'CSpinner'

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

@@ -0,0 +1,22 @@
+import * as React from 'react'
+import { render } from '@testing-library/react'
+import '@testing-library/jest-dom/extend-expect'
+import { CSpinner } from '../../../index'
+
+test('loads and displays CSpinner component', async () => {
+  const { container } = render(<CSpinner>Test</CSpinner>)
+  expect(container).toMatchSnapshot()
+})
+
+test('CSpinner customize', async () => {
+  const { container } = render(
+    <CSpinner className="bazinga" color="warning" component="h3" size="sm" variant="grow">
+      Test
+    </CSpinner>,
+  )
+  expect(container).toMatchSnapshot()
+  expect(container.firstChild).toHaveClass('bazinga')
+  expect(container.firstChild).toHaveClass('spinner-grow')
+  expect(container.firstChild).toHaveClass('text-warning')
+  expect(container.firstChild).toHaveClass('spinner-grow-sm')
+})

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

@@ -0,0 +1,31 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`CSpinner customize 1`] = `
+<div>
+  <h3
+    class="spinner-grow text-warning spinner-grow-sm bazinga"
+    role="status"
+  >
+    <span
+      class="visually-hidden"
+    >
+      Loading...
+    </span>
+  </h3>
+</div>
+`;
+
+exports[`loads and displays CSpinner component 1`] = `
+<div>
+  <div
+    class="spinner-border text-undefined"
+    role="status"
+  >
+    <span
+      class="visually-hidden"
+    >
+      Loading...
+    </span>
+  </div>
+</div>
+`;