release: v4.0.0-alpha.1

Author: mrholek

.gitignore

@@ -1,4 +1,3 @@
 .docz
-dist/
 coverage/
 node_modules/

dist/components/Types.d.ts

@@ -0,0 +1,10 @@
+import PropTypes from 'prop-types';
+export declare type Breakpoints = 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl';
+export declare type Colors = 'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'dark' | 'light' | string;
+export declare const colorPropType: PropTypes.Requireable<string>;
+export declare type Placements = 'auto' | 'auto-start' | 'auto-end' | 'top-end' | 'top' | 'top-start' | 'bottom-end' | 'bottom' | 'bottom-start' | 'right-start' | 'right' | 'right-end' | 'left-start' | 'left' | 'left-end' | undefined;
+export declare const placementPropType: PropTypes.Requireable<Placements>;
+export declare type Shapes = 'rounded' | 'rounded-top' | 'rounded-end' | 'rounded-bottom' | 'rounded-start' | 'rounded-circle' | 'rounded-pill' | 'rounded-0' | 'rounded-1' | 'rounded-2' | 'rounded-3' | string;
+export declare const shapePropType: PropTypes.Requireable<string>;
+export declare type Triggers = 'hover' | 'focus' | 'click';
+export declare const triggerPropType: PropTypes.Requireable<Triggers>;

dist/components/accordion/CAccordion.d.ts

@@ -0,0 +1,12 @@
+import React, { HTMLAttributes } from 'react';
+export interface CAccordionProps extends HTMLAttributes<HTMLDivElement> {
+    /**
+     * A string of all className you want applied to the base component. [docs]
+     */
+    className?: string;
+    /**
+     * Removes the default background-color, some borders, and some rounded corners to render accordions edge-to-edge with their parent container. [docs]
+     */
+    flush?: boolean;
+}
+export declare const CAccordion: React.ForwardRefExoticComponent<CAccordionProps & React.RefAttributes<HTMLDivElement>>;

dist/components/accordion/CAccordionBody.d.ts

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

dist/components/accordion/CAccordionButton.d.ts

@@ -0,0 +1,12 @@
+import React, { HTMLAttributes } from 'react';
+export interface CAccordionButtonProps extends HTMLAttributes<HTMLButtonElement> {
+    /**
+     * A string of all className you want applied to the base component. [docs]
+     */
+    className?: string;
+    /**
+     * Set button state to collapsed. [docs]
+     */
+    collapsed?: boolean;
+}
+export declare const CAccordionButton: React.ForwardRefExoticComponent<CAccordionButtonProps & React.RefAttributes<HTMLButtonElement>>;

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<CCollapseProps & React.RefAttributes<HTMLDivElement>>;

dist/components/accordion/CAccordionHeader.d.ts

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

dist/components/accordion/CAccordionItem.d.ts

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

dist/components/alert/CAlert.d.ts

@@ -0,0 +1,38 @@
+import React, { HTMLAttributes } from 'react';
+import { Colors } from '../Types';
+export interface CAlertProps extends HTMLAttributes<HTMLDivElement> {
+    /**
+     * 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 }
+     * @default 'primary'
+     */
+    color: Colors;
+    /**
+     * Optionally add a close button to alert and allow it to self dismiss. [docs]
+     */
+    dismissible?: boolean;
+    /**
+     * Method called before the dissmiss animation has started. [docs]
+     */
+    onDismiss?: () => void;
+    /**
+     * Method called after the dissmiss animation has completed and the component is removed from the dom. [docs]
+     */
+    onDismissed?: () => void;
+    /**
+     * Set the alert variant to a solid. [docs]
+     */
+    variant?: 'solid' | string;
+    /**
+     * Toggle the visibility of component. [docs]
+     *
+     * @default true
+     */
+    visible?: boolean;
+}
+export declare const CAlert: React.ForwardRefExoticComponent<CAlertProps & React.RefAttributes<HTMLDivElement>>;

dist/components/alert/CAlertHeading.d.ts

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

dist/components/alert/CAlertLink.d.ts

@@ -0,0 +1,8 @@
+import React, { AnchorHTMLAttributes } from 'react';
+export interface CAlertLinkProps extends AnchorHTMLAttributes<HTMLAnchorElement> {
+    /**
+     * A string of all className you want applied to the base component. [docs]
+     */
+    className?: string;
+}
+export declare const CAlertLink: React.ForwardRefExoticComponent<CAlertLinkProps & React.RefAttributes<HTMLAnchorElement>>;

dist/components/alert/__tests__/CAlert.spec.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom/extend-expect';

dist/components/alert/__tests__/CAlertHeading.spec.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom/extend-expect';

dist/components/alert/__tests__/CAlertLink.spec.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom/extend-expect';

dist/components/animations/CFade.d.ts

@@ -0,0 +1,57 @@
+import React from 'react';
+import { Transition } from 'react-transition-group';
+export interface CFadeProps {
+    /**
+     * Run the fade in animation when the component mounts, if it is initially
+     * shown
+     */
+    appear?: boolean;
+    children: any;
+    /**
+     * A string of all className you want applied to the base component. [docs]
+     */
+    className?: string;
+    /**
+     * Show the component; triggers the fade in or fade out animation
+     */
+    in?: boolean;
+    /**
+     * Wait until the first "enter" transition to mount the component (add it to the DOM)
+     */
+    mountOnEnter?: boolean;
+    /**
+     * Unmount the component (remove it from the DOM) when it is faded out
+     */
+    unmountOnExit?: boolean;
+    /**
+     * Callback fired before the component fades in
+     */
+    onEnter?(node: HTMLElement): any;
+    /**
+     * Callback fired after the component starts to fade in
+     */
+    onEntering?(node: HTMLElement): any;
+    /**
+     * Callback fired after the has component faded in
+     */
+    onEntered?(node: HTMLElement): any;
+    /**
+     * Callback fired before the component fades out
+     */
+    onExit?(node: HTMLElement): any;
+    /**
+     * Callback fired after the component starts to fade out
+     */
+    onExiting?(node: HTMLElement): any;
+    /**
+     * Callback fired after the component has faded out
+     */
+    onExited?(node: HTMLElement): any;
+    /**
+     * Duration of the fade animation in milliseconds, to ensure that finishing
+     * callbacks are fired even if the original browser transition end events are
+     * canceled
+     */
+    timeout?: number;
+}
+export declare const CFade: React.ForwardRefExoticComponent<CFadeProps & React.RefAttributes<Transition<any>>>;

dist/components/avatar/CAvatar.d.ts

@@ -0,0 +1,39 @@
+import React, { HTMLAttributes } from 'react';
+import { Colors, Shapes } from '../Types';
+export interface CAvatarProps extends HTMLAttributes<HTMLDivElement> {
+    /**
+     * 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;
+    /**
+     * Select the shape of the component. [docs]
+     *
+     * @type {'rounded' | 'rounded-top' | 'rounded-end' | 'rounded-bottom' | 'rounded-start' | 'rounded-circle' | 'rounded-pill' | 'rounded-0' | 'rounded-1' | 'rounded-2' | 'rounded-3' | string}
+     */
+    shape?: Shapes;
+    /**
+     * Size the component small, large, or extra large. [docs]
+     */
+    size?: string;
+    /**
+     * The src attribute for the img element. [docs]
+     */
+    src?: string;
+    /**
+     * Sets the color context of the status indicator to one of CoreUI’s themed colors. [docs]
+     *
+     * @type {'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'dark' | 'light' | string}
+     */
+    status?: Colors;
+    /**
+     * Sets the text color of the component to one of CoreUI’s themed colors. [docs]
+     */
+    textColor?: string;
+}
+export declare const CAvatar: React.ForwardRefExoticComponent<CAvatarProps & React.RefAttributes<HTMLDivElement>>;

dist/components/avatar/__tests__/CAvatar.spec.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom/extend-expect';

dist/components/backdrop/CBackdrop.d.ts

@@ -0,0 +1,12 @@
+import React, { HTMLAttributes } from 'react';
+export interface CBackdropProps extends HTMLAttributes<HTMLDivElement> {
+    /**
+     * A string of all className you want applied to the base component. [docs]
+     */
+    className?: string;
+    /**
+     * Toggle the visibility of modal component. [docs]
+     */
+    visible?: boolean;
+}
+export declare const CBackdrop: React.ForwardRefExoticComponent<CBackdropProps & React.RefAttributes<HTMLDivElement>>;

dist/components/backdrop/__tests__/CBackdrop.spec.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom/extend-expect';

dist/components/badge/CBadge.d.ts

@@ -0,0 +1,37 @@
+import React, { ElementType, HTMLAttributes } from 'react';
+import { Colors, Shapes } from '../Types';
+export interface CBadgeProps 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 'span'
+     */
+    component?: string | ElementType;
+    /**
+     * Select the shape of the component. [docs]
+     *
+     * @type 'rounded' | 'rounded-top' | 'rounded-end' | 'rounded-bottom' | 'rounded-start' | 'rounded-circle' | 'rounded-pill' | 'rounded-0' | 'rounded-1' | 'rounded-2' | 'rounded-3' | string
+     */
+    shape?: Shapes;
+    /**
+     * Size the component small. [docs]
+     *
+     * @type 'sm'
+     */
+    size?: 'sm';
+    /**
+     * Sets the text color of the component to one of CoreUI’s themed colors. [docs]
+     */
+    textColor?: string;
+}
+export declare const CBadge: React.ForwardRefExoticComponent<CBadgeProps & React.RefAttributes<HTMLDivElement | HTMLSpanElement>>;

dist/components/badge/__tests__/CBadge.spec.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom/extend-expect';

dist/components/breadcrumb/CBreadcrumb.d.ts

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

dist/components/breadcrumb/CBreadcrumbItem.d.ts

@@ -0,0 +1,16 @@
+import React, { HTMLAttributes } from 'react';
+export interface CBreadcrumbItemProps extends HTMLAttributes<HTMLLIElement> {
+    /**
+     * Toggle the active state for the component. [docs]
+     */
+    active?: boolean;
+    /**
+     * A string of all className you want applied to the base component. [docs]
+     */
+    className?: string;
+    /**
+     * The `href` attribute for the inner `<CLink>` component. [docs]
+     */
+    href?: string;
+}
+export declare const CBreadcrumbItem: React.ForwardRefExoticComponent<CBreadcrumbItemProps & React.RefAttributes<HTMLLIElement>>;

dist/components/breadcrumb/__tests__/CBreadcrumb.spec.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom/extend-expect';

dist/components/breadcrumb/__tests__/CBreadcrumbItem.spec.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom/extend-expect';

dist/components/button-group/CButtonGroup.d.ts

@@ -0,0 +1,18 @@
+import React, { HTMLAttributes } from 'react';
+export interface CButtonGroupProps extends HTMLAttributes<HTMLDivElement> {
+    /**
+     * A string of all className you want applied to the base component. [docs]
+     */
+    className?: string;
+    /**
+     * Size the component small or large. [docs]
+     *
+     * @type {'sm' | 'lg'}
+     */
+    size?: 'sm' | 'lg';
+    /**
+     * Create a set of buttons that appear vertically stacked rather than horizontally. Split button dropdowns are not supported here. [docs]
+     */
+    vertical?: boolean;
+}
+export declare const CButtonGroup: React.ForwardRefExoticComponent<CButtonGroupProps & React.RefAttributes<HTMLDivElement>>;

dist/components/button-group/CButtonToolbar.d.ts

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

dist/components/button-group/__tests__/CButtonGroup.spec.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom/extend-expect';

dist/components/button-group/__tests__/CButtonToolbar.spec.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom/extend-expect';