@coreui/react 4.9.0-rc.0 → 5.0.0-alpha.0

package/README.md

@@ -46,7 +46,7 @@
 
 Several quick start options are available:
 
-- [Download the latest release](https://github.com/coreui/coreui-react/archive/v4.9.0-rc.0.zip)
+- [Download the latest release](https://github.com/coreui/coreui-react/archive/v5.0.0-alpha.0.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`

package/dist/components/accordion/CAccordionCollapse.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+import { CCollapseProps } from '../collapse/CCollapse';
+export declare const CAccordionCollapse: React.ForwardRefExoticComponent<Omit<CCollapseProps, "horizontal"> & React.RefAttributes<HTMLDivElement>>;

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

@@ -53,7 +53,7 @@ export interface CDropdownProps extends HTMLAttributes<HTMLDivElement | HTMLLIEl
     /**
      * Callback fired when the component requests to be hidden.
      *
-     * @since 4.9.0-rc.0
+     * @since 4.9.0
      */
     onHide?: () => void;
     /**

package/dist/components/dropdown copy/CDropdown.d.ts

@@ -0,0 +1,89 @@
+import React, { ElementType, HTMLAttributes, RefObject } from 'react';
+import type { Placements } from '../../types';
+export type Directions = 'start' | 'end';
+export type Breakpoints = {
+    xs: Directions;
+} | {
+    sm: Directions;
+} | {
+    md: Directions;
+} | {
+    lg: Directions;
+} | {
+    xl: Directions;
+} | {
+    xxl: Directions;
+};
+export type Alignments = Directions | Breakpoints;
+export interface CDropdownProps extends HTMLAttributes<HTMLDivElement | HTMLLIElement> {
+    /**
+     * Set aligment of dropdown menu.
+     *
+     * @type 'start' | 'end' | { xs: 'start' | 'end' } | { sm: 'start' | 'end' } | { md: 'start' | 'end' } | { lg: 'start' | 'end' } | { xl: 'start' | 'end'} | { xxl: 'start' | 'end'}
+     */
+    alignment?: Alignments;
+    /**
+     * Configure the auto close behavior of the dropdown:
+     * - `true` - the dropdown will be closed by clicking outside or inside the dropdown menu.
+     * - `false` - the dropdown will be closed by clicking the toggle button and manually calling hide or toggle method. (Also will not be closed by pressing esc key)
+     * - `'inside'` - the dropdown will be closed (only) by clicking inside the dropdown menu.
+     * - `'outside'` - the dropdown will be closed (only) by clicking outside the dropdown menu.
+     */
+    autoClose?: 'inside' | 'outside' | boolean;
+    /**
+     * A string of all className you want applied to the base component.
+     */
+    className?: string;
+    /**
+     * Component used for the root node. Either a string to use a HTML element or a component.
+     */
+    component?: string | ElementType;
+    /**
+     * Sets a darker color scheme to match a dark navbar.
+     */
+    dark?: boolean;
+    /**
+     * Sets a specified  direction and location of the dropdown menu.
+     */
+    direction?: 'center' | 'dropup' | 'dropup-center' | 'dropend' | 'dropstart';
+    /**
+     * Callback fired when the component requests to be hidden.
+     */
+    onHide?: () => void;
+    /**
+     * Callback fired when the component requests to be shown.
+     */
+    onShow?: () => void;
+    /**
+     * 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.
+     *
+     * @type 'auto' | 'top-end' | 'top' | 'top-start' | 'bottom-end' | 'bottom' | 'bottom-start' | 'right-start' | 'right' | 'right-end' | 'left-start' | 'left' | 'left-end'
+     */
+    placement?: Placements;
+    /**
+     * If you want to disable dynamic positioning set this property to `true`.
+     */
+    popper?: boolean;
+    /**
+     * Generates dropdown menu using createPortal.
+     *
+     * @since 4.8.0
+     */
+    portal?: boolean;
+    /**
+     * Set the dropdown variant to an btn-group, dropdown, input-group, and nav-item.
+     */
+    variant?: 'btn-group' | 'dropdown' | 'input-group' | 'nav-item';
+    /**
+     * Toggle the visibility of dropdown menu component.
+     */
+    visible?: boolean;
+}
+interface ContextProps extends CDropdownProps {
+    dropdownToggleRef: RefObject<any> | undefined;
+    setVisible: React.Dispatch<React.SetStateAction<boolean | undefined>>;
+    portal: boolean;
+}
+export declare const CDropdownContext: React.Context<ContextProps>;
+export declare const CDropdown: React.ForwardRefExoticComponent<CDropdownProps & React.RefAttributes<HTMLDivElement | HTMLLIElement>>;
+export {};

package/dist/components/dropdown copy/CDropdownDivider.d.ts

@@ -0,0 +1,8 @@
+import React, { HTMLAttributes } from 'react';
+export interface CDropdownDividerProps extends HTMLAttributes<HTMLHRElement> {
+    /**
+     * A string of all className you want applied to the component.
+     */
+    className?: string;
+}
+export declare const CDropdownDivider: React.ForwardRefExoticComponent<CDropdownDividerProps & React.RefAttributes<HTMLHRElement>>;

package/dist/components/dropdown copy/CDropdownHeader.d.ts

@@ -0,0 +1,12 @@
+import React, { ElementType, HTMLAttributes } from 'react';
+export interface CDropdownHeaderProps extends HTMLAttributes<HTMLHeadingElement> {
+    /**
+     * A string of all className you want applied to the component.
+     */
+    className?: string;
+    /**
+     * Component used for the root node. Either a string to use a HTML element or a component.
+     */
+    component?: string | ElementType;
+}
+export declare const CDropdownHeader: React.ForwardRefExoticComponent<CDropdownHeaderProps & React.RefAttributes<HTMLHeadingElement>>;

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

@@ -0,0 +1,13 @@
+import React, { ElementType } from 'react';
+import { CLinkProps } from '../link/CLink';
+export interface CDropdownItemProps extends CLinkProps {
+    /**
+     * A string of all className you want applied to the component.
+     */
+    className?: string;
+    /**
+     * Component used for the root node. Either a string to use a HTML element or a component.
+     */
+    component?: string | ElementType;
+}
+export declare const CDropdownItem: React.ForwardRefExoticComponent<CDropdownItemProps & React.RefAttributes<HTMLButtonElement | HTMLAnchorElement>>;

package/dist/components/dropdown copy/CDropdownItemPlain.d.ts

@@ -0,0 +1,12 @@
+import React, { ElementType, HTMLAttributes } from 'react';
+export interface CDropdownItemPlainProps extends HTMLAttributes<HTMLSpanElement> {
+    /**
+     * A string of all className you want applied to the component.
+     */
+    className?: string;
+    /**
+     * Component used for the root node. Either a string to use a HTML element or a component.
+     */
+    component?: string | ElementType;
+}
+export declare const CDropdownItemPlain: React.ForwardRefExoticComponent<CDropdownItemPlainProps & React.RefAttributes<HTMLSpanElement>>;

package/dist/components/dropdown copy/CDropdownMenu.d.ts

@@ -0,0 +1,13 @@
+import { ElementType, FC, HTMLAttributes } from 'react';
+import { PopperChildrenProps } from 'react-popper';
+export interface CDropdownMenuProps extends HTMLAttributes<HTMLDivElement | HTMLUListElement>, Omit<PopperChildrenProps, 'arrowProps' | 'forceUpdate' | 'hasPopperEscaped' | 'isReferenceHidden' | 'placement' | 'ref' | 'style' | 'update'> {
+    /**
+     * A string of all className you want applied to the base component.
+     */
+    className?: string;
+    /**
+     * Component used for the root node. Either a string to use a HTML element or a component.
+     */
+    component?: string | ElementType;
+}
+export declare const CDropdownMenu: FC<CDropdownMenuProps>;

package/dist/components/dropdown copy/CDropdownToggle.d.ts

@@ -0,0 +1,24 @@
+import { FC } from 'react';
+import { CButtonProps } from '../button/CButton';
+import type { Triggers } from '../../types';
+export interface CDropdownToggleProps extends Omit<CButtonProps, 'type'> {
+    /**
+     * Enables pseudo element caret on toggler.
+     */
+    caret?: boolean;
+    /**
+     * Create a custom toggler which accepts any content.
+     */
+    custom?: boolean;
+    /**
+     * Similarly, create split button dropdowns with virtually the same markup as single button dropdowns, but with the addition of `.dropdown-toggle-split` className for proper spacing around the dropdown caret.
+     */
+    split?: boolean;
+    /**
+     * Sets which event handlers you’d like provided to your toggle prop. You can specify one trigger or an array of them.
+     *
+     * @type 'hover' | 'focus' | 'click'
+     */
+    trigger?: Triggers | Triggers[];
+}
+export declare const CDropdownToggle: FC<CDropdownToggleProps>;

package/dist/components/dropdown copy/index.d.ts

@@ -0,0 +1,8 @@
+import { CDropdown } from './CDropdown';
+import { CDropdownDivider } from './CDropdownDivider';
+import { CDropdownHeader } from './CDropdownHeader';
+import { CDropdownItem } from './CDropdownItem';
+import { CDropdownItemPlain } from './CDropdownItemPlain';
+import { CDropdownMenu } from './CDropdownMenu';
+import { CDropdownToggle } from './CDropdownToggle';
+export { CDropdown, CDropdownDivider, CDropdownHeader, CDropdownItem, CDropdownItemPlain, CDropdownMenu, CDropdownToggle, };

package/dist/components/popover/CPopover.d.ts

@@ -4,7 +4,7 @@ export interface CPopoverProps extends Omit<HTMLAttributes<HTMLDivElement>, 'tit
     /**
      * Apply a CSS fade transition to the popover.
      *
-     * @since 4.9.0-rc.0
+     * @since 4.9.0
      */
     animation?: boolean;
     /**
@@ -22,7 +22,7 @@ export interface CPopoverProps extends Omit<HTMLAttributes<HTMLDivElement>, 'tit
     /**
      * 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 }`.
      *
-     * @since 4.9.0-rc.0
+     * @since 4.9.0
      */
     delay?: number | {
         show: number;
@@ -31,7 +31,7 @@ export interface CPopoverProps extends Omit<HTMLAttributes<HTMLDivElement>, 'tit
     /**
      * Specify the desired order of fallback placements by providing a list of placements as an array. The placements should be prioritized based on preference.
      *
-     * @since 4.9.0-rc.0
+     * @since 4.9.0
      */
     fallbackPlacements?: Placements | Placements[];
     /**

package/dist/components/tooltip/CTooltip.d.ts

@@ -4,7 +4,7 @@ export interface CTooltipProps extends Omit<HTMLAttributes<HTMLDivElement>, 'con
     /**
      * Apply a CSS fade transition to the tooltip.
      *
-     * @since 4.9.0-rc.0
+     * @since 4.9.0
      */
     animation?: boolean;
     /**
@@ -18,7 +18,7 @@ export interface CTooltipProps extends Omit<HTMLAttributes<HTMLDivElement>, 'con
     /**
      * The delay for displaying and hiding the tooltip (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 }`.
      *
-     * @since 4.9.0-rc.0
+     * @since 4.9.0
      */
     delay?: number | {
         show: number;
@@ -27,7 +27,7 @@ export interface CTooltipProps extends Omit<HTMLAttributes<HTMLDivElement>, 'con
     /**
      * Specify the desired order of fallback placements by providing a list of placements as an array. The placements should be prioritized based on preference.
      *
-     * @since 4.9.0-rc.0
+     * @since 4.9.0
      */
     fallbackPlacements?: Placements | Placements[];
     /**

package/dist/hooks/index.d.ts

@@ -1,3 +1,4 @@
+import { useColorModes } from './useColorModes';
 import { useForkedRef } from './useForkedRef';
 import { usePopper } from './usePopper';
-export { useForkedRef, usePopper };
+export { useColorModes, useForkedRef, usePopper };

package/dist/index.es.js

@@ -2475,6 +2475,54 @@ CSSTransition.propTypes = process.env.NODE_ENV !== "production" ? _extends({}, T
 }) : {};
 var CSSTransition$1 = CSSTransition;
 
+var getStoredTheme = function (localStorageItemName) {
+    return typeof window !== 'undefined' && localStorage.getItem(localStorageItemName);
+};
+var setStoredTheme = function (localStorageItemName, colorMode) {
+    return localStorage.setItem(localStorageItemName, colorMode);
+};
+var getPreferredColorScheme = function (localStorageItemName) {
+    if (typeof window === 'undefined') {
+        return 'light';
+    }
+    var storedTheme = getStoredTheme(localStorageItemName);
+    if (storedTheme) {
+        return storedTheme;
+    }
+    return window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light';
+};
+var setTheme = function (colorMode) {
+    document.documentElement.dataset.coreuiTheme =
+        colorMode === 'auto' && window.matchMedia('(prefers-color-scheme: dark)').matches
+            ? 'dark'
+            : colorMode;
+    var event = new Event('ColorSchemeChange');
+    document.documentElement.dispatchEvent(event);
+};
+var useColorModes = function (localStorageItemName) {
+    if (localStorageItemName === void 0) { localStorageItemName = 'coreui-react-color-scheme'; }
+    var _a = useState(getPreferredColorScheme(localStorageItemName)), colorMode = _a[0], setColorMode = _a[1];
+    useEffect(function () {
+        if (colorMode) {
+            setStoredTheme(localStorageItemName, colorMode);
+            setTheme(colorMode);
+        }
+    }, [colorMode]);
+    useEffect(function () {
+        window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', function () {
+            var storedTheme = getStoredTheme(localStorageItemName);
+            if (storedTheme !== 'light' && storedTheme !== 'dark' && colorMode) {
+                setTheme(colorMode);
+            }
+        });
+    });
+    return {
+        colorMode: colorMode,
+        isColorModeSet: function () { return Boolean(getStoredTheme(localStorageItemName)); },
+        setColorMode: setColorMode,
+    };
+};
+
 // code borrowed from https://github.com/reach/reach-ui
 // problem described https://github.com/facebook/react/issues/13029
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -4832,6 +4880,16 @@ CCardTitle.propTypes = {
 };
 CCardTitle.displayName = 'CCardTitle';
 
+var isRTL = function (element) {
+    if (typeof document !== 'undefined' && document.documentElement.dir === 'rtl') {
+        return true;
+    }
+    if (element) {
+        return element.closest('[dir="rtl"]') !== null;
+    }
+    return false;
+};
+
 var getRTLPlacement = function (placement, element) {
     switch (placement) {
         case 'right': {
@@ -4854,16 +4912,6 @@ var isInViewport = function (element) {
         Math.floor(rect.right) <= (window.innerWidth || document.documentElement.clientWidth));
 };
 
-var isRTL = function (element) {
-    if (typeof document !== 'undefined' && document.documentElement.dir === 'rtl') {
-        return true;
-    }
-    if (element) {
-        return element.closest('[dir="rtl"]') !== null;
-    }
-    return false;
-};
-
 var CCarouselContext = createContext({});
 var CCarousel = forwardRef(function (_a, ref) {
     var children = _a.children, _b = _a.activeIndex, activeIndex = _b === void 0 ? 0 : _b, className = _a.className, controls = _a.controls, dark = _a.dark, indicators = _a.indicators, _c = _a.interval, interval = _c === void 0 ? 5000 : _c, onSlid = _a.onSlid, onSlide = _a.onSlide, _d = _a.pause, pause = _d === void 0 ? 'hover' : _d, _e = _a.touch, touch = _e === void 0 ? true : _e, transition = _a.transition, _f = _a.wrap, wrap = _f === void 0 ? true : _f, rest = __rest(_a, ["children", "activeIndex", "className", "controls", "dark", "indicators", "interval", "onSlid", "onSlide", "pause", "touch", "transition", "wrap"]);
@@ -7417,5 +7465,5 @@ CWidgetStatsF.propTypes = {
 };
 CWidgetStatsF.displayName = 'CWidgetStatsF';
 
-export { CAccordion, CAccordionBody, CAccordionButton, CAccordionHeader, CAccordionItem, CAlert, CAlertHeading, CAlertLink, CAvatar, CBackdrop, CBadge, CBreadcrumb, CBreadcrumbItem, CButton, CButtonGroup, CButtonToolbar, CCallout, CCard, CCardBody, CCardFooter, CCardGroup, CCardHeader, CCardImage, CCardImageOverlay, CCardLink, CCardSubtitle, CCardText, CCardTitle, CCarousel, CCarouselCaption, CCarouselItem, CCloseButton, CCol, CCollapse, CConditionalPortal, CContainer, CDropdown, CDropdownDivider, CDropdownHeader, CDropdownItem, CDropdownItemPlain, CDropdownMenu, CDropdownToggle, CFooter, CForm, CFormCheck, CFormControlValidation, CFormControlWrapper, CFormFeedback, CFormFloating, CFormInput, CFormLabel, CFormRange, CFormSelect, CFormSwitch, CFormText, CFormTextarea, CHeader, CHeaderBrand, CHeaderDivider, CHeaderNav, CHeaderText, CHeaderToggler, CImage, CInputGroup, CInputGroupText, CLink, CListGroup, CListGroupItem, CModal, CModalBody, CModalContent, CModalDialog, CModalFooter, CModalHeader, CModalTitle, CNav, CNavGroup, CNavGroupItems, CNavItem, CNavLink, CNavTitle, CNavbar, CNavbarBrand, CNavbarNav, CNavbarText, CNavbarToggler, COffcanvas, COffcanvasBody, COffcanvasHeader, COffcanvasTitle, CPagination, CPaginationItem, CPlaceholder, CPopover, CProgress, CProgressBar, CProgressStacked, CRow, CSidebar, CSidebarBrand, CSidebarFooter, CSidebarHeader, CSidebarNav, CSidebarToggler, CSpinner, CTabContent, CTabPane, CTable, CTableBody, CTableCaption, CTableDataCell, CTableFoot, CTableHead, CTableHeaderCell, CTableRow, CToast, CToastBody, CToastClose, CToastHeader, CToaster, CTooltip, CWidgetStatsA, CWidgetStatsB, CWidgetStatsC, CWidgetStatsD, CWidgetStatsE, CWidgetStatsF, useForkedRef, usePopper };
+export { CAccordion, CAccordionBody, CAccordionButton, CAccordionHeader, CAccordionItem, CAlert, CAlertHeading, CAlertLink, CAvatar, CBackdrop, CBadge, CBreadcrumb, CBreadcrumbItem, CButton, CButtonGroup, CButtonToolbar, CCallout, CCard, CCardBody, CCardFooter, CCardGroup, CCardHeader, CCardImage, CCardImageOverlay, CCardLink, CCardSubtitle, CCardText, CCardTitle, CCarousel, CCarouselCaption, CCarouselItem, CCloseButton, CCol, CCollapse, CConditionalPortal, CContainer, CDropdown, CDropdownDivider, CDropdownHeader, CDropdownItem, CDropdownItemPlain, CDropdownMenu, CDropdownToggle, CFooter, CForm, CFormCheck, CFormControlValidation, CFormControlWrapper, CFormFeedback, CFormFloating, CFormInput, CFormLabel, CFormRange, CFormSelect, CFormSwitch, CFormText, CFormTextarea, CHeader, CHeaderBrand, CHeaderDivider, CHeaderNav, CHeaderText, CHeaderToggler, CImage, CInputGroup, CInputGroupText, CLink, CListGroup, CListGroupItem, CModal, CModalBody, CModalContent, CModalDialog, CModalFooter, CModalHeader, CModalTitle, CNav, CNavGroup, CNavGroupItems, CNavItem, CNavLink, CNavTitle, CNavbar, CNavbarBrand, CNavbarNav, CNavbarText, CNavbarToggler, COffcanvas, COffcanvasBody, COffcanvasHeader, COffcanvasTitle, CPagination, CPaginationItem, CPlaceholder, CPopover, CProgress, CProgressBar, CProgressStacked, CRow, CSidebar, CSidebarBrand, CSidebarFooter, CSidebarHeader, CSidebarNav, CSidebarToggler, CSpinner, CTabContent, CTabPane, CTable, CTableBody, CTableCaption, CTableDataCell, CTableFoot, CTableHead, CTableHeaderCell, CTableRow, CToast, CToastBody, CToastClose, CToastHeader, CToaster, CTooltip, CWidgetStatsA, CWidgetStatsB, CWidgetStatsC, CWidgetStatsD, CWidgetStatsE, CWidgetStatsF, useColorModes, useForkedRef, usePopper };
 //# sourceMappingURL=index.es.js.map