@coreui/react 4.2.2 → 4.3.1

package/README.md

@@ -20,21 +20,24 @@
   ·
   <a href="https://github.com/coreui/coreui-react/issues/new?template=feature_request.md">Request feature</a>
   ·
-  <a href="https://blog.coreui.io/">Blog</a>
+  <a href="https://coreui.io/blog/">Blog</a>
 </p>
 
 
 ## Table of contents
 
 - [Quick start](#quick-start)
+- [Components](#components)
 - [Status](#status)
-- [What's included](#whats-included)
 - [Bugs and feature requests](#bugs-and-feature-requests)
 - [Documentation](#documentation)
+- [Frameworks](#frameworks)
+- [Templates](#templates)
 - [Contributing](#contributing)
 - [Community](#community)
 - [Versioning](#versioning)
 - [Creators](#creators)
+- [Support CoreUI Development](#support-coreui-development)
 - [Copyright and license](#copyright-and-license)
 
 ## Quick start
@@ -43,7 +46,7 @@
 
 Several quick start options are available:
 
-- [Download the latest release](https://github.com/coreui/coreui-react/archive/v4.2.2.zip)
+- [Download the latest release](https://github.com/coreui/coreui-react/archive/v4.3.1.zip)
 - Clone the repo: `git clone https://github.com/coreui/coreui-react.git`
 - Install with [npm](https://www.npmjs.com/): `npm install @coreui/react`
 - Install with [yarn](https://yarnpkg.com/): `yarn add @coreui/react`
@@ -94,13 +97,58 @@ npm install bootstrap
 import "bootstrap/dist/css/bootstrap.min.css";
 ```
 
+## Components
+
+- [React Accordion](https://coreui.io/react/docs/components/accordion/)
+- [React Alert](https://coreui.io/react/docs/components/alert/)
+- [React Avatar](https://coreui.io/react/docs/components/avatar/)
+- [React Badge](https://coreui.io/react/docs/components/badge/)
+- [React Breadcrumb](https://coreui.io/react/docs/components/breadcrumb/)
+- [React Button](https://coreui.io/react/docs/components/button/)
+- [React Button Group](https://coreui.io/react/docs/components/button-group/)
+- [React Callout](https://coreui.io/react/docs/components/callout/)
+- [React Card](https://coreui.io/react/docs/components/card/)
+- [React Carousel](https://coreui.io/react/docs/components/carousel/)
+- [React Checkbox](https://coreui.io/react/docs/forms/checkbox/)
+- [React Close Button](https://coreui.io/react/docs/components/close-button/)
+- [React Collapse](https://coreui.io/react/docs/components/collapse/)
+- [React Date Picker](https://coreui.io/react/docs/forms/date-picker/) **PRO**
+- [React Date Range Picker](https://coreui.io/react/docs/forms/date-range-picker/) **PRO**
+- [React Dropdown](https://coreui.io/react/docs/components/dropdown/)
+- [React Floating Labels](https://coreui.io/react/docs/forms/floating-labels/)
+- [React Footer](https://coreui.io/react/docs/components/footer/)
+- [React Header](https://coreui.io/react/docs/components/header/)
+- [React Image](https://coreui.io/react/docs/components/image/)
+- [React Input](https://coreui.io/react/docs/forms/input/)
+- [React Input Group](https://coreui.io/react/docs/forms/input-group/)
+- [React List Group](https://coreui.io/react/docs/components/list-group/)
+- [React Loading Button](https://coreui.io/react/docs/components/loading-button/) **PRO**
+- [React Modal](https://coreui.io/react/docs/components/modal/)
+- [React Multi Select](https://coreui.io/react/docs/forms/multi-select/) **PRO**
+- [React Navs & Tabs](https://coreui.io/react/docs/components/navs-tabs/)
+- [React Navbar](https://coreui.io/react/docs/components/navbar/)
+- [React Offcanvas](https://coreui.io/react/docs/components/offcanvas/)
+- [React Pagination](https://coreui.io/react/docs/components/pagination/)
+- [React Placeholder](https://coreui.io/react/docs/components/placeholder/)
+- [React Popover](https://coreui.io/react/docs/components/popover/)
+- [React Progress](https://coreui.io/react/docs/components/progress/)
+- [React Radio](https://coreui.io/react/docs/forms/radio/)
+- [React Range](https://coreui.io/react/docs/forms/range/)
+- [React Select](https://coreui.io/react/docs/forms/select/)
+- [React Sidebar](https://coreui.io/react/docs/components/sidebar/)
+- [React Smart Pagination](https://coreui.io/react/docs/components/smart-pagination/) **PRO**
+- [React Smart Table](https://coreui.io/react/docs/components/smart-table/) **PRO**
+- [React Spinner](https://coreui.io/react/docs/components/spinner/)
+- [React Switch](https://coreui.io/react/docs/forms/switch/)
+- [React Table](https://coreui.io/react/docs/components/table/)
+- [React Textarea](https://coreui.io/react/docs/forms/textarea/)
+- [React Time Picker](https://coreui.io/react/docs/forms/time-picker/) **PRO**
+- [React Toast](https://coreui.io/react/docs/components/toast/)
+- [React Tooltip](https://coreui.io/react/docs/components/tooltip/)
+
 ## Status
 
-[![Build Status](https://github.com/coreui/coreui-react/workflows/JS%20Tests/badge.svg?branch=main)](https://github.com/coreui/coreui-react/actions?query=workflow%3AJS+Tests+branch%3Amain)
 [![npm version](https://img.shields.io/npm/v/@coreui/react)](https://www.npmjs.com/package/@coreui/react)
-[![peerDependencies Status](https://img.shields.io/david/peer/coreui/coreui)](https://david-dm.org/coreui/coreui?type=peer)
-[![devDependency Status](https://img.shields.io/david/dev/coreui/coreui)](https://david-dm.org/coreui/coreui?type=dev)
-[![Coverage Status](https://img.shields.io/coveralls/github/coreui/coreui-react/v4)](https://coveralls.io/github/coreui/coreui-react?branch=v4)
 
 ## Bugs and feature requests
 
@@ -117,6 +165,24 @@ The documentation for the CoreUI & CoreUI PRO is hosted at our website [CoreUI f
 3. From the root directory, run `yarn docs:dev` or `npm run docs:dev` (or a specific npm script) to rebuild distributed CSS and JavaScript files, as well as our docs assets.
 4. Open `http://localhost:8000/` in your browser, and voilà.
 
+## Frameworks
+
+CoreUI supports most popular frameworks.
+
+- [CoreUI for Angular](https://github.com/coreui/coreui-angular)
+- [CoreUI for Bootstrap (Vanilla JS)](https://github.com/coreui/coreui)
+- [CoreUI for React](https://github.com/coreui/coreui-react)
+- [CoreUI for Vue](https://github.com/coreui/coreui-vue)
+
+## Templates
+
+Fully featured, out-of-the-box, templates for your application based on CoreUI.
+
+- [Angular Admin Template](https://coreui.io/angular)
+- [Bootstrap Admin Template](https://coreui.io/)
+- [React Admin Template](https://coreui.io/react)
+- [Vue Admin Template](https://coreui.io/vue)
+
 ## Contributing
 
 Please read through our [contributing guidelines](https://github.com/coreui/coreui-react/blob/v4/.github/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.
@@ -127,7 +193,7 @@ Editor preferences are available in the [editor config](https://github.com/coreu
 
 Stay up to date on the development of CoreUI and reach out to the community with these helpful resources.
 
-- Read and subscribe to [The Official CoreUI Blog](https://blog.coreui.io/).
+- Read and subscribe to [The Official CoreUI Blog](https://coreui.io/blog/).
 
 You can also follow [@core_ui on Twitter](https://twitter.com/core_ui).
 
@@ -152,6 +218,44 @@ See [the Releases section of our project](https://github.com/coreui/coreui-react
 
 - <https://github.com/orgs/coreui/people>
 
+## Support CoreUI Development
+
+CoreUI is an MIT-licensed open source project and is completely free to use. However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing. You can support development by buying the [CoreUI PRO](https://coreui.io/pricing/) or by becoming a sponsor via [Open Collective](https://opencollective.com/coreui/).
+
+<!--- StartOpenCollectiveBackers -->
+
+### Platinum Sponsors
+
+Support this project by [becoming a Platinum Sponsor](https://opencollective.com/coreui/contribute/platinum-sponsor-40959/). A large company logo will be added here with a link to your website.
+
+<a href="https://opencollective.com/coreui/contribute/platinum-sponsor-40959/checkout"><img src="https://opencollective.com/coreui/tiers/platinum-sponsor/0/avatar.svg?avatarHeight=100"></a>
+
+### Gold Sponsors
+
+Support this project by [becoming a Gold Sponsor](https://opencollective.com/coreui/contribute/gold-sponsor-40960/). A big company logo will be added here with a link to your website.
+
+<a href="https://opencollective.com/coreui/contribute/gold-sponsor-40960/checkout"><img src="https://opencollective.com/coreui/tiers/gold-sponsor/0/avatar.svg?avatarHeight=100"></a> 
+
+### Silver Sponsors
+
+Support this project by [becoming a Silver Sponsor](https://opencollective.com/coreui/contribute/silver-sponsor-40967/). A medium company logo will be added here with a link to your website.
+
+<a href="https://opencollective.com/coreui/contribute/silver-sponsor-40967/checkout"><img src="https://opencollective.com/coreui/tiers/gold-sponsor/0/avatar.svg?avatarHeight=100"></a>
+
+### Bronze Sponsors
+
+Support this project by [becoming a Bronze Sponsor](https://opencollective.com/coreui/contribute/bronze-sponsor-40966/). The company avatar will show up here with a link to your OpenCollective Profile.
+
+<a href="https://opencollective.com/coreui/contribute/bronze-sponsor-40966/checkout"><img src="https://opencollective.com/coreui/tiers/bronze-sponsor/0/avatar.svg?avatarHeight=100"></a> 
+
+### Backers
+
+Thanks to all the backers and sponsors! Support this project by [becoming a backer](https://opencollective.com/coreui/contribute/backer-40965/).
+
+<a href="https://opencollective.com/coreui/contribute/backer-40965/checkout" target="_blank" rel="noopener"><img src="https://opencollective.com/coreui/backers.svg?width=890"></a>
+
+<!--- EndOpenCollectiveBackers -->
+
 ## Copyright and license
 
-Copyright 2021 creativeLabs Łukasz Holeczek. Code released under the [MIT License](https://github.com/coreui/coreui-react/blob/main/LICENSE). Docs released under [Creative Commons](https://creativecommons.org/licenses/by/3.0/).
+Copyright 2022 creativeLabs Łukasz Holeczek. Code released under the [MIT License](https://github.com/coreui/coreui-react/blob/main/LICENSE). Docs released under [Creative Commons](https://creativecommons.org/licenses/by/3.0/).

package/dist/components/button/CButton.d.ts

@@ -51,4 +51,4 @@ export interface CButtonProps extends ButtonHTMLAttributes<HTMLButtonElement> {
      */
     variant?: 'outline' | 'ghost';
 }
-export declare const CButton: React.ForwardRefExoticComponent<CButtonProps & React.RefAttributes<HTMLButtonElement | HTMLAnchorElement>>;
+export declare const CButton: React.ForwardRefExoticComponent<CButtonProps & React.RefAttributes<HTMLAnchorElement | HTMLButtonElement>>;

package/dist/components/dropdown/CDropdownItem.d.ts

@@ -10,4 +10,4 @@ export interface CDropdownItemProps extends CLinkProps {
      */
     component?: string | ElementType;
 }
-export declare const CDropdownItem: React.ForwardRefExoticComponent<CDropdownItemProps & React.RefAttributes<HTMLButtonElement | HTMLAnchorElement>>;
+export declare const CDropdownItem: React.ForwardRefExoticComponent<CDropdownItemProps & React.RefAttributes<HTMLAnchorElement | HTMLButtonElement>>;

package/dist/components/form/CFormTextarea.d.ts

@@ -1,6 +1,6 @@
-import React, { ChangeEventHandler, InputHTMLAttributes } from 'react';
+import React, { ChangeEventHandler, TextareaHTMLAttributes } from 'react';
 import { CFormControlWrapperProps } from './CFormControlWrapper';
-export interface CFormTextareaProps extends CFormControlWrapperProps, InputHTMLAttributes<HTMLTextAreaElement> {
+export interface CFormTextareaProps extends CFormControlWrapperProps, TextareaHTMLAttributes<HTMLTextAreaElement> {
     /**
      * A string of all className you want applied to the component.
      */

package/dist/components/link/CLink.d.ts

@@ -21,4 +21,4 @@ export interface CLinkProps extends AllHTMLAttributes<HTMLElement> {
      */
     href?: string;
 }
-export declare const CLink: React.ForwardRefExoticComponent<CLinkProps & React.RefAttributes<HTMLButtonElement | HTMLAnchorElement>>;
+export declare const CLink: React.ForwardRefExoticComponent<CLinkProps & React.RefAttributes<HTMLAnchorElement | HTMLButtonElement>>;

package/dist/components/list-group/CListGroupItem.d.ts

@@ -24,4 +24,4 @@ export interface CListGroupItemProps extends HTMLAttributes<HTMLLIElement | HTML
      */
     component?: string | ElementType;
 }
-export declare const CListGroupItem: React.ForwardRefExoticComponent<CListGroupItemProps & React.RefAttributes<HTMLButtonElement | HTMLAnchorElement | HTMLLIElement>>;
+export declare const CListGroupItem: React.ForwardRefExoticComponent<CListGroupItemProps & React.RefAttributes<HTMLAnchorElement | HTMLButtonElement | HTMLLIElement>>;

package/dist/components/nav/CNavLink.d.ts

@@ -26,4 +26,4 @@ export interface CNavLinkProps extends Omit<CLinkProps, 'idx'> {
      */
     to?: string;
 }
-export declare const CNavLink: React.ForwardRefExoticComponent<CNavLinkProps & React.RefAttributes<HTMLButtonElement | HTMLAnchorElement | HTMLLIElement>>;
+export declare const CNavLink: React.ForwardRefExoticComponent<CNavLinkProps & React.RefAttributes<HTMLAnchorElement | HTMLButtonElement | HTMLLIElement>>;

package/dist/components/table/CTable.d.ts

@@ -1,10 +1,15 @@
 import React, { TableHTMLAttributes } from 'react';
 import { Colors } from '../Types';
-export interface CTableProps extends TableHTMLAttributes<HTMLTableElement> {
+import { CTableHeadProps } from './CTableHead';
+import { CTableHeaderCellProps } from './CTableHeaderCell';
+import { CTableDataCellProps } from './CTableDataCell';
+import { CTableRowProps } from './CTableRow';
+import { CTableFootProps } from './CTableFoot';
+export interface CTableProps extends Omit<TableHTMLAttributes<HTMLTableElement>, 'align'> {
     /**
      * Set the vertical aligment.
      */
-    align?: 'bottom' | 'middle' | 'top';
+    align?: 'bottom' | 'middle' | 'top' | string;
     /**
      * Sets the border color of the component to one of CoreUI’s themed colors.
      *
@@ -20,23 +25,63 @@ export interface CTableProps extends TableHTMLAttributes<HTMLTableElement> {
      */
     borderless?: boolean;
     /**
-     * Put the `<caption>` on the top of the table.
+     * Put the caption on the top if you set `caption="top"` of the table or set the text of the table caption.
      */
-    caption?: 'top';
+    caption?: 'top' | string;
+    /**
+     * Set the text of the table caption and the caption on the top of the table.
+     *
+     * @since 4.3.0
+     */
+    captionTop?: string;
     /**
      * A string of all className you want applied to the component.
      */
     className?: string;
+    /**
+     * 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. '_props')
+     *
+     * 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.
+     * - _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
+     */
+    columns?: (string | Column)[];
     /**
      * Sets the color context of the component to one of CoreUI’s themed colors.
      *
      * @type 'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'dark' | 'light' | string
      */
     color?: Colors;
+    /**
+     * Array of objects or strings, where each element represents one cell in the table footer.
+     *
+     * Example items:
+     * ['FooterCell', 'FooterCell', 'FooterCell']
+     * or
+     * [{ label: 'FooterCell', _props: { color: 'success' }, ...]
+     *
+     * @since 4.3.0
+     */
+    footer?: FooterItem[];
     /**
      * Enable a hover state on table rows within a `<CTableBody>`.
      */
     hover?: 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 '_props' key and to single cell by '_cellProps'.
+     *
+     * Example item:
+     * { name: 'John' , age: 12, _props: { color: 'success' }, _cellProps: { age: { className: 'fw-bold'}}}
+     *
+     * @since 4.3.0
+     */
+    items?: Item[];
     /**
      * Make any table responsive across all viewports or pick a maximum breakpoint with which to have a responsive table up to.
      */
@@ -49,5 +94,39 @@ export interface CTableProps extends TableHTMLAttributes<HTMLTableElement> {
      * Add zebra-striping to any table row within the `<CTableBody>`.
      */
     striped?: boolean;
+    /**
+     * Add zebra-striping to any table column.
+     *
+     * @since 4.3.0
+     */
+    stripedColumns?: boolean;
+    /**
+     * Properties that will be passed to the table footer component.
+     *
+     * @link https://coreui.io/react/docs/components/table/#ctablefoot
+     * @since 4.3.0
+     */
+    tableFootProps?: CTableFootProps;
+    /**
+     * Properties that will be passed to the table head component.
+     *
+     * @link https://coreui.io/react/docs/components/table/#ctablehead
+     * @since 4.3.0
+     */
+    tableHeadProps?: CTableHeadProps;
+}
+export interface Column {
+    label?: string;
+    key: string;
+    _style?: any;
+    _props?: CTableHeaderCellProps;
+}
+export interface Item {
+    [key: string]: number | string | any;
+    _props?: CTableRowProps;
+}
+export interface FooterItem {
+    label?: string;
+    _props?: CTableDataCellProps;
 }
 export declare const CTable: React.ForwardRefExoticComponent<CTableProps & React.RefAttributes<HTMLTableElement>>;

package/dist/components/table/CTableDataCell.d.ts

@@ -1,6 +1,6 @@
-import React, { TdHTMLAttributes } from 'react';
+import React, { TdHTMLAttributes, ThHTMLAttributes } from 'react';
 import { Colors } from '../Types';
-export interface CTableDataCellProps extends Omit<TdHTMLAttributes<HTMLTableDataCellElement>, 'align'> {
+export interface CTableDataCellProps extends Omit<TdHTMLAttributes<HTMLTableCellElement>, 'align'>, Omit<ThHTMLAttributes<HTMLTableCellElement>, 'align'> {
     /**
      * Highlight a table row or cell.
      */
@@ -8,7 +8,7 @@ export interface CTableDataCellProps extends Omit<TdHTMLAttributes<HTMLTableData
     /**
      * Set the vertical aligment.
      */
-    align?: 'bottom' | 'middle' | 'top';
+    align?: 'bottom' | 'middle' | 'top' | string;
     /**
      * A string of all className you want applied to the component.
      */
@@ -19,5 +19,9 @@ export interface CTableDataCellProps extends Omit<TdHTMLAttributes<HTMLTableData
      * @type 'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'dark' | 'light' | string
      */
     color?: Colors;
+    /**
+     * @ignore
+     */
+    colSpan?: number;
 }
-export declare const CTableDataCell: React.ForwardRefExoticComponent<CTableDataCellProps & React.RefAttributes<HTMLTableDataCellElement>>;
+export declare const CTableDataCell: React.ForwardRefExoticComponent<CTableDataCellProps & React.RefAttributes<HTMLTableCellElement>>;

package/dist/components/table/CTableHeaderCell.d.ts

@@ -1,6 +1,6 @@
 import React, { ThHTMLAttributes } from 'react';
 import { Colors } from '../Types';
-export interface CTableHeaderCellProps extends ThHTMLAttributes<HTMLTableHeaderCellElement> {
+export interface CTableHeaderCellProps extends ThHTMLAttributes<HTMLTableCellElement> {
     /**
      * A string of all className you want applied to the component.
      */
@@ -12,4 +12,4 @@ export interface CTableHeaderCellProps extends ThHTMLAttributes<HTMLTableHeaderC
      */
     color?: Colors;
 }
-export declare const CTableHeaderCell: React.ForwardRefExoticComponent<CTableHeaderCellProps & React.RefAttributes<HTMLTableHeaderCellElement>>;
+export declare const CTableHeaderCell: React.ForwardRefExoticComponent<CTableHeaderCellProps & React.RefAttributes<HTMLTableCellElement>>;

package/dist/components/table/CTableResponsiveWrapper.d.ts

@@ -0,0 +1,9 @@
+import { FC, HTMLAttributes } from 'react';
+export interface CTableResponsiveWrapperProps extends HTMLAttributes<HTMLDivElement> {
+    children: any;
+    /**
+     * Make any table responsive across all viewports or pick a maximum breakpoint with which to have a responsive table up to.
+     */
+    responsive?: boolean | 'sm' | 'md' | 'lg' | 'xl' | 'xxl';
+}
+export declare const CTableResponsiveWrapper: FC<CTableResponsiveWrapperProps>;

package/dist/components/table/CTableRow.d.ts

@@ -8,7 +8,7 @@ export interface CTableRowProps extends HTMLAttributes<HTMLTableRowElement> {
     /**
      * Set the vertical aligment.
      */
-    align?: 'bottom' | 'middle' | 'top';
+    align?: 'bottom' | 'middle' | 'top' | string;
     /**
      * A string of all className you want applied to the component.
      */