@peculiar/react-components 0.0.2-alpha.29 → 0.0.2-alpha.292

package/dist/types/Dialog/dialog.d.ts

@@ -0,0 +1,51 @@
+import React from 'react';
+import type { CircularProgressProps } from '../CircularProgress';
+declare type BaseProps = {
+    /**
+     * If `true`, the Dialog is open.
+     */
+    open: boolean;
+    /**
+     * Dialog children, usually the included sub-components.
+     */
+    children: React.ReactNode;
+    /**
+     * The className of Dialog container.
+     */
+    className?: string;
+    /**
+     * The duration for the transition, in milliseconds.
+     */
+    transitionDuration?: number;
+    /**
+     * If `true`, the dialog will be full-screen.
+     */
+    fullScreen?: boolean;
+    /**
+     * If `true`, clicking the backdrop will not fire the `onClose` callback.
+     */
+    disableBackdropClick?: boolean;
+    /**
+     * If `true`, hitting escape will not fire the `onClose` callback.
+     */
+    disableEscapeKeyDown?: boolean;
+    /**
+     * Callback fired when the component requests to be closed.
+     */
+    onClose?: () => void;
+    /**
+     * The size of the dialog.
+     */
+    size?: ('small' | 'medium' | 'large');
+    'data-testid'?: string;
+    /**
+     * If `true`, the dialog will be show CircularProgress component and disable all interactions.
+     */
+    loading?: boolean;
+    /**
+     * The color of the CircularProgress component.
+     */
+    loadingColor?: CircularProgressProps['color'];
+};
+export declare const Dialog: React.ForwardRefExoticComponent<BaseProps & Omit<React.HTMLAttributes<HTMLDivElement>, "children"> & React.RefAttributes<HTMLDivElement>>;
+export {};

package/dist/types/Dialog/dialog_actions.d.ts

@@ -0,0 +1,13 @@
+import React from 'react';
+declare type BaseProps = {
+    /**
+     * The content of the component.
+     */
+    children?: React.ReactNode;
+    /**
+     * The className of the component.
+     */
+    className?: string;
+};
+export declare const DialogActions: React.ForwardRefExoticComponent<BaseProps & React.HTMLAttributes<HTMLDivElement> & React.RefAttributes<HTMLDivElement>>;
+export {};

package/dist/types/Dialog/dialog_content.d.ts

@@ -0,0 +1,21 @@
+import React from 'react';
+declare type BaseProps = {
+    /**
+     * The content of the component.
+     */
+    children?: React.ReactNode;
+    /**
+     * The className of the component.
+     */
+    className?: string;
+    /**
+     * Display the top and bottom dividers.
+     */
+    dividers?: boolean;
+    /**
+     * The content of the error message.
+     */
+    error?: string;
+};
+export declare const DialogContent: React.ForwardRefExoticComponent<BaseProps & React.HTMLAttributes<HTMLDivElement> & React.RefAttributes<HTMLDivElement>>;
+export {};

package/dist/types/Dialog/dialog_title.d.ts

@@ -0,0 +1,17 @@
+import React from 'react';
+declare type BaseProps = {
+    /**
+     * The content of the component.
+     */
+    children?: React.ReactNode;
+    /**
+     * The className of the component.
+     */
+    className?: string;
+    /**
+     * Callback fired when the component requests to be closed.
+     */
+    onClose?: () => void;
+};
+export declare const DialogTitle: React.ForwardRefExoticComponent<BaseProps & React.HTMLAttributes<HTMLDivElement> & React.RefAttributes<HTMLDivElement>>;
+export {};

package/dist/types/Dialog/index.d.ts

@@ -0,0 +1,4 @@
+export { Dialog } from './dialog';
+export { DialogTitle } from './dialog_title';
+export { DialogContent } from './dialog_content';
+export { DialogActions } from './dialog_actions';

package/dist/types/Drawer/drawer.d.ts

@@ -0,0 +1,34 @@
+import * as React from 'react';
+declare type BaseProps = {
+    /**
+     * If `true`, the component is shown.
+     */
+    open: boolean;
+    /**
+     * The content of the component.
+     */
+    children: React.ReactNode;
+    /**
+     * The className of Drawer container.
+     */
+    className?: string;
+    /**
+     * The duration for the transition, in milliseconds.
+     */
+    transitionDuration?: number;
+    /**
+     * If `true`, clicking the backdrop will not fire the `onClose` callback.
+     */
+    disableBackdropClick?: boolean;
+    /**
+     * If `true`, hitting escape will not fire the `onClose` callback.
+     */
+    disableEscapeKeyDown?: boolean;
+    /**
+     * Callback fired when the component requests to be closed.
+     */
+    onClose?: () => void;
+    'data-testid'?: string;
+};
+export declare const Drawer: React.ForwardRefExoticComponent<BaseProps & Omit<React.HTMLAttributes<HTMLDivElement>, "children"> & React.RefAttributes<HTMLDivElement>>;
+export {};

package/dist/types/Drawer/index.d.ts

@@ -0,0 +1 @@
+export { Drawer } from './drawer';

package/dist/types/Fab/fab.d.ts

@@ -0,0 +1,10 @@
+import * as React from 'react';
+import { ButtonBaseProps } from '../ButtonBase';
+declare type BaseProps = {
+    /**
+     * The variant to use.
+     */
+    variant?: ('contained' | 'outlined');
+};
+export declare const Fab: React.ForwardRefExoticComponent<BaseProps & Omit<ButtonBaseProps, "size" | "variant"> & React.RefAttributes<HTMLButtonElement>>;
+export {};

package/dist/types/Fab/index.d.ts

@@ -0,0 +1 @@
+export { Fab } from './fab';

package/dist/types/Fade/fade.d.ts

@@ -0,0 +1,24 @@
+import * as React from 'react';
+import type { TransitionProps } from 'react-transition-group/Transition';
+export declare type BaseTransitionProps = Pick<TransitionProps<HTMLElement>, ('onEnter' | 'onEntered' | 'onEntering' | 'onExit' | 'onExited' | 'onExiting')>;
+declare type BaseProps = {
+    /**
+     * If `true`, the component will transition in.
+     */
+    in?: boolean;
+    /**
+     * The duration for the transition, in milliseconds.
+     */
+    timeout?: number;
+    /**
+     * A single child content element.
+     */
+    children: React.ReactElement;
+    finalOpacity?: number;
+    /**
+     * Perform the enter transition when it first mounts if `in` is also `true`.
+     */
+    appear?: boolean;
+};
+export declare const Fade: React.ForwardRefExoticComponent<BaseProps & BaseTransitionProps & React.RefAttributes<any>>;
+export {};

package/dist/types/Fade/index.d.ts

@@ -0,0 +1,2 @@
+export { Fade } from './fade';
+export type { BaseTransitionProps } from './fade';

package/dist/types/FocusTrap/focus_trap.d.ts

@@ -0,0 +1,19 @@
+import React from 'react';
+declare type BaseProps = {
+    /**
+     * A single child content element.
+     */
+    children: React.ReactElement;
+    /**
+     * If true, focus will be locked.
+     */
+    open: boolean;
+    /**
+     * If `true`, the trap focus will not automatically shift focus
+     * to first interactive element when it opens,
+     * and replace it to the last focused element when it closes.
+     */
+    disableAutoFocus?: boolean;
+};
+export declare const FocusTrap: React.FC<BaseProps>;
+export {};

package/dist/types/FocusTrap/index.d.ts

@@ -0,0 +1 @@
+export { FocusTrap } from './focus_trap';

package/dist/types/IconButton/icon_button.d.ts

@@ -0,0 +1,10 @@
+import * as React from 'react';
+import { ButtonProps } from '../Button';
+declare type BaseProps = {
+    /**
+     * The text that applied to `aria-label` attribute and Tooltip content.
+     */
+    title?: string;
+};
+export declare const IconButton: React.ForwardRefExoticComponent<BaseProps & Omit<ButtonProps, "variant" | "startIcon" | "endIcon" | "withoutPadding"> & React.RefAttributes<HTMLButtonElement>>;
+export {};

package/dist/types/IconButton/index.d.ts

@@ -0,0 +1 @@
+export { IconButton } from './icon_button';

package/dist/types/Image/image.d.ts

@@ -0,0 +1,22 @@
+import * as React from 'react';
+declare type BaseProps = {
+    /**
+     * The `src` attribute for the `img` element.
+     */
+    src: string;
+    /**
+     * Fallback element to show if image is loading.
+     */
+    loading?: React.ReactElement;
+    /**
+     * Fallback element to show if image fails.
+     */
+    fallback?: React.ReactElement;
+    /**
+     * The className of the component.
+     */
+    className?: string;
+    'data-testid'?: string;
+};
+export declare const Image: React.ForwardRefExoticComponent<BaseProps & Omit<React.ImgHTMLAttributes<HTMLImageElement>, "loading"> & React.RefAttributes<HTMLImageElement>>;
+export {};

package/dist/types/Image/index.d.ts

@@ -0,0 +1 @@
+export { Image } from './image';

package/dist/types/LinearProgress/index.d.ts

@@ -0,0 +1 @@
+export { LinearProgress } from './linear_progress';

package/dist/types/LinearProgress/linear_progress.d.ts

@@ -0,0 +1,17 @@
+import React from 'react';
+declare type BaseProps = {
+    /**
+     * The color of the component. It supports those theme colors that make sense for this component.
+     */
+    color?: ('primary' | 'secondary');
+    /**
+     * The variant to use.
+     */
+    variant?: ('indeterminate');
+    /**
+     * The className of the component.
+     */
+    className?: string;
+};
+export declare const LinearProgress: React.ForwardRefExoticComponent<BaseProps & Omit<React.HTMLAttributes<HTMLDivElement>, "children"> & React.RefAttributes<HTMLDivElement>>;
+export {};

package/dist/types/Menu/index.d.ts

@@ -0,0 +1 @@
+export { Menu, MenuProps } from './menu';

package/dist/types/Menu/menu.d.ts

@@ -0,0 +1,30 @@
+import React from 'react';
+import { PopoverProps } from '../Popover';
+declare type OptionBaseProps = {
+    label: string;
+    disabled?: boolean;
+    onClick?: (event: React.MouseEvent<HTMLElement>) => void;
+    component?: React.ElementType;
+};
+declare type OptionProps = OptionBaseProps & Omit<React.AllHTMLAttributes<HTMLElement>, 'children'>;
+declare type BaseProps = {
+    /**
+     * Menu reference element.
+     */
+    children: React.ReactElement;
+    /**
+     * Menu contents.
+     */
+    options: OptionProps[];
+    /**
+     * Callback fired when the component requests to be closed.
+     */
+    onClose?: () => void;
+    /**
+     * Props applied to the `Popover` element.
+     */
+    popoverProps?: Partial<PopoverProps>;
+};
+export declare type MenuProps = BaseProps;
+export declare const Menu: React.ForwardRefExoticComponent<BaseProps & React.RefAttributes<HTMLDivElement>>;
+export {};

package/dist/types/Modal/index.d.ts

@@ -0,0 +1 @@
+export { Modal, ModalProps } from './modal';

package/dist/types/Modal/modal.d.ts

@@ -0,0 +1,54 @@
+import * as React from 'react';
+import { BackdropProps } from '../Backdrop';
+declare type BaseProps = {
+    /**
+     * A single child content element.
+     */
+    children: React.ReactElement;
+    /**
+     * If `true`, the modal is open.
+     */
+    open: boolean;
+    /**
+     * The className of the component.
+     */
+    className?: string;
+    /**
+     * The duration for the transition, in milliseconds.
+     */
+    transitionDuration?: number;
+    /**
+     * If `true`, clicking the backdrop will not fire the `onClose` callback.
+     */
+    disableBackdropClick?: boolean;
+    /**
+     * If `true`, hitting escape will not fire the `onClose` callback.
+     */
+    disableEscapeKeyDown?: boolean;
+    /**
+     * Callback fired when the component requests to be closed.
+     */
+    onClose?: (event: React.SyntheticEvent) => void;
+    /**
+     * Always keep the children in the DOM.
+     */
+    keepMounted?: boolean;
+    /**
+     * Props applied to the `Backdrop` element.
+     */
+    backdropProps?: Partial<BackdropProps>;
+    /**
+     * If `true`, the modal will not prevent focus from leaving the modal while open.
+     */
+    disableEnforceFocus?: boolean;
+    /**
+     * If `true`, the trap focus will not automatically shift focus
+     * to first interactive element when it opens,
+     * and replace it to the last focused element when it closes.
+     */
+    disableAutoFocus?: boolean;
+    'data-testid'?: string;
+};
+export declare type ModalProps = BaseProps & React.HTMLAttributes<HTMLDivElement>;
+export declare const Modal: React.ForwardRefExoticComponent<BaseProps & React.HTMLAttributes<HTMLDivElement> & React.RefAttributes<HTMLDivElement>>;
+export {};

package/dist/types/Popover/index.d.ts

@@ -0,0 +1 @@
+export { Popover, PopoverProps } from './popover';

package/dist/types/Popover/popover.d.ts

@@ -0,0 +1,36 @@
+import React from 'react';
+import { PopperProps } from 'react-popper';
+import { ModalProps } from '../Modal';
+declare type BaseProps = {
+    /**
+     * If `true`, the popover is visible.
+     */
+    open: boolean;
+    /**
+     * The content of the component.
+     */
+    children: React.ReactNode;
+    /**
+     * A HTML element, or a function that returns it. It's used to set the position of the popover
+     */
+    anchorEl: Element;
+    /**
+     * Popover placement.
+     */
+    placement?: PopperProps<unknown>['placement'];
+    /**
+     * Callback fired when the component requests to be closed.
+     */
+    onClose?: (event: React.SyntheticEvent) => void;
+    /**
+     * Props applied to the `Modal` element.
+     */
+    modalProps?: Partial<ModalProps>;
+    /**
+     * Make your popover the same width as the reference.
+     */
+    allowUseSameWidth?: boolean;
+};
+export declare type PopoverProps = BaseProps & Omit<React.HTMLAttributes<HTMLDivElement>, 'children'>;
+export declare const Popover: React.ForwardRefExoticComponent<BaseProps & Omit<React.HTMLAttributes<HTMLDivElement>, "children"> & React.RefAttributes<HTMLDivElement>>;
+export {};

package/dist/types/Popper/index.d.ts

@@ -0,0 +1 @@
+export { Popper } from './popper';

package/dist/types/Popper/popper.d.ts

@@ -0,0 +1,31 @@
+import React from 'react';
+import { PopperProps as PopperReactProps } from 'react-popper';
+declare type BaseProps = {
+    /**
+     * If `true`, the popper is visible.
+     */
+    open: boolean;
+    /**
+     * Popper render node.
+     */
+    children: React.ReactNode;
+    /**
+     * It's used to set the position of the popper.
+     */
+    anchorEl?: Element;
+    /**
+     * Popper placement.
+     */
+    placement?: PopperReactProps<unknown>['placement'];
+    /**
+     * Disable the portal behavior. The children stay within it's parent DOM hierarchy.
+     */
+    disablePortal?: boolean;
+    /**
+     * Make your popper the same width as the reference.
+     */
+    allowUseSameWidth?: boolean;
+};
+declare type PopperProps = BaseProps & React.HTMLAttributes<HTMLDivElement>;
+export declare const Popper: React.FC<PopperProps>;
+export {};

package/dist/types/Portal/index.d.ts

@@ -0,0 +1 @@
+export { Portal } from './portal';

package/dist/types/Portal/portal.d.ts

@@ -0,0 +1,16 @@
+import * as React from 'react';
+declare type BaseProps = {
+    /**
+     * The content of the component.
+     */
+    children?: React.ReactNode;
+    /**
+     * A HTML element, component instance, or function that returns either.
+     * The `container` will have the portal children appended to it.
+     * By default, it uses the body of the top-level document object,
+     * so it's simply `document.body` most of the time.
+     */
+    container?: Element | (() => Element | null) | null;
+};
+export declare const Portal: React.FC<BaseProps>;
+export {};

package/dist/types/Radio/index.d.ts

@@ -0,0 +1 @@
+export { Radio } from './radio';

package/dist/types/Radio/radio.d.ts

@@ -0,0 +1,47 @@
+import * as React from 'react';
+declare type BaseProps = {
+    /**
+     * If `true`, the component is checked.
+     */
+    checked?: boolean;
+    /**
+     * If `true`, the component is checked by default.
+     */
+    defaultChecked?: boolean;
+    /**
+     * Attributes applied to the input element.
+     */
+    inputProps?: Omit<React.InputHTMLAttributes<HTMLInputElement>, 'className' | 'type'>;
+    /**
+     * The content of the component.
+     */
+    className?: string;
+    /**
+     * If `true`, the radio will be disabled.
+     */
+    disabled?: boolean;
+    /**
+     * The `id` of the input element.
+     */
+    id?: string;
+    /**
+     * If `true`, the `input` element will be required.
+     */
+    required?: boolean;
+    /**
+     * The icon to display when the component is checked.
+     */
+    checkedIcon?: React.ReactElement;
+    /**
+     * Name attribute of the `input` element.
+     */
+    name?: string;
+    /**
+     * Callback fired when the state is changed.
+     */
+    onChange?: (event: React.ChangeEvent<HTMLInputElement>) => void;
+    'data-testid'?: string;
+};
+export declare type RadioProps = BaseProps & Omit<React.LabelHTMLAttributes<HTMLLabelElement>, 'children' | 'htmlFor' | 'onChange'>;
+export declare const Radio: React.ForwardRefExoticComponent<BaseProps & Omit<React.LabelHTMLAttributes<HTMLLabelElement>, "children" | "htmlFor" | "onChange"> & React.RefAttributes<HTMLLabelElement>>;
+export {};

package/dist/types/Select/index.d.ts

@@ -0,0 +1 @@
+export { Select } from './select';

package/dist/types/Select/select.d.ts

@@ -0,0 +1,71 @@
+import * as React from 'react';
+declare type BaseProps = {
+    options: {
+        value: string;
+        label: string;
+    }[];
+    /**
+     * If `true`, the component is disabled.
+     */
+    disabled?: boolean;
+    /**
+     * The size of the select.
+     */
+    size?: ('small' | 'medium' | 'large');
+    /**
+     * The className of the component.
+     */
+    className?: string;
+    /**
+     * Attributes applied to the `input` element.
+     */
+    inputProps?: React.SelectHTMLAttributes<HTMLSelectElement>;
+    /**
+     * The default value. Use when the component is not controlled.
+     */
+    defaultValue?: string;
+    /**
+     * The id of the `input` element.
+     */
+    id?: string;
+    /**
+     * The label of the input. It is only used for layout.
+     */
+    label?: string;
+    /**
+     * The value of the `input` element, required for a controlled component.
+     */
+    value?: string;
+    /**
+     * The short hint displayed in the `input` before the user enters a value.
+     */
+    placeholder?: string;
+    /**
+     * If `true`, the `input` element is required.
+     */
+    required?: boolean;
+    /**
+     * Name attribute of the `input` element.
+     */
+    name?: string;
+    /**
+     * Pass a ref to the `input` element.
+     */
+    inputRef?: React.ForwardedRef<HTMLSelectElement>;
+    /**
+     * If `true`, the `input` element is focused during the first mount.
+     */
+    autoFocus?: boolean;
+    /**
+     * If `true`, the `input` will indicate an error.
+     */
+    error?: boolean;
+    errorText?: string;
+    /**
+     * Callback fired when the value is changed.
+     */
+    onChange?: React.ChangeEventHandler<HTMLSelectElement>;
+    'data-testid'?: string;
+};
+export declare const Select: React.ForwardRefExoticComponent<BaseProps & Omit<React.HTMLAttributes<HTMLDivElement>, "onChange"> & React.RefAttributes<HTMLDivElement>>;
+export {};

package/dist/types/Skeleton/index.d.ts

@@ -0,0 +1 @@
+export { Skeleton } from './skeleton';

package/dist/types/Skeleton/skeleton.d.ts

@@ -0,0 +1,30 @@
+import * as React from 'react';
+import { ColorType } from '../styles';
+declare type BaseProps = {
+    /**
+     * Optional children to infer width and height from.
+     */
+    children?: React.ReactNode;
+    /**
+     * Height of the skeleton.
+     */
+    height?: number | string;
+    /**
+     * Width of the skeleton.
+     */
+    width?: number | string;
+    /**
+     * The type of content that will be rendered.
+     */
+    variant?: ('text' | 'rect' | 'circle');
+    /**
+     * The className of the component.
+     */
+    className?: string;
+    background?: ColorType;
+};
+/**
+ *
+ */
+export declare const Skeleton: React.ForwardRefExoticComponent<BaseProps & Omit<React.HTMLAttributes<HTMLSpanElement>, "height" | "width" | "children"> & React.RefAttributes<HTMLSpanElement>>;
+export {};

package/dist/types/Slide/index.d.ts

@@ -0,0 +1 @@
+export { Slide } from './slide';

package/dist/types/Slide/slide.d.ts

@@ -0,0 +1,27 @@
+import * as React from 'react';
+import type { TransitionProps } from 'react-transition-group/Transition';
+declare type BaseTransitionProps = Pick<TransitionProps<HTMLElement>, ('onEnter' | 'onEntered' | 'onEntering' | 'onExit' | 'onExited' | 'onExiting')>;
+declare type BaseProps = {
+    /**
+     * If `true`, the component will transition in.
+     */
+    in?: boolean;
+    /**
+     * The duration for the transition, in milliseconds.
+     */
+    timeout?: number;
+    /**
+     * A single child content element.
+     */
+    children: React.ReactElement;
+    /**
+     * Direction the child node will enter from.
+     */
+    direction?: ('right' | 'left' | 'up' | 'down');
+    /**
+     * Perform the enter transition when it first mounts if `in` is also `true`.
+     */
+    appear?: boolean;
+};
+export declare const Slide: React.ForwardRefExoticComponent<BaseProps & BaseTransitionProps & React.RefAttributes<any>>;
+export {};

package/dist/types/Slider/index.d.ts

@@ -0,0 +1 @@
+export { Slider } from './slider';