@peculiar/react-components 0.0.2-alpha.26 → 0.0.2-alpha.260

package/dist/types/Avatar/avatar.d.ts

@@ -0,0 +1,43 @@
+import * as React from 'react';
+import { ColorType } from '../styles';
+import { TypographyProps } from '../Typography';
+declare type BaseProps = {
+    /**
+     * The name of the person in the avatar.
+     *
+     * - If `src` has loaded, the name will be used as the `alt` attribute of the `img`.
+     * - If `src` is not loaded, the name will be used to create the initials.
+     */
+    name?: string;
+    /**
+     * Function to get the initials to display.
+     */
+    getInitials?: (name: string) => string;
+    /**
+     * The `src` attribute for the `img` element.
+     */
+    src?: string;
+    /**
+     * The className of the component.
+     */
+    className?: string;
+    /**
+     * Props applied to the `Typography` element.
+     */
+    typographyProps?: Partial<TypographyProps>;
+    /**
+     * The size of the avatar.
+     */
+    size?: ('small' | 'medium' | 'large');
+    /**
+     * The color of component background.
+     */
+    background?: ColorType;
+    /**
+     * The color of initials text.
+     */
+    color?: ColorType;
+    'data-testid'?: string;
+};
+export declare const Avatar: React.ForwardRefExoticComponent<BaseProps & Omit<React.HTMLAttributes<HTMLDivElement>, "children"> & React.RefAttributes<HTMLDivElement>>;
+export {};

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

@@ -0,0 +1 @@
+export { Avatar } from './avatar';

package/dist/types/Backdrop/backdrop.d.ts

@@ -0,0 +1,24 @@
+import * as React from 'react';
+import { BaseTransitionProps } from '../Fade';
+declare type BaseProps = {
+    /**
+     * If `true`, the backdrop is open.
+     */
+    open: boolean;
+    /**
+     * The className of the component.
+     */
+    className?: string;
+    /**
+     * If `true`, the backdrop is invisible.
+     */
+    invisible?: boolean;
+    /**
+     * The duration for the transition, in milliseconds.
+     */
+    transitionDuration?: number;
+    variant?: ('light' | 'medium' | 'heavy');
+};
+export declare type BackdropProps = BaseProps & BaseTransitionProps & React.HTMLAttributes<HTMLDivElement>;
+export declare const Backdrop: React.ForwardRefExoticComponent<BaseProps & BaseTransitionProps & React.HTMLAttributes<HTMLDivElement> & React.RefAttributes<HTMLDivElement>>;
+export {};

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

@@ -0,0 +1 @@
+export { Backdrop, BackdropProps } from './backdrop';

package/dist/types/Box/box.d.ts

@@ -0,0 +1,25 @@
+import * as React from 'react';
+import { ColorType } from '../styles';
+declare type BaseProps = {
+    /**
+     * The content of the component.
+     */
+    children?: React.ReactNode;
+    /**
+     * The className of the component.
+     */
+    className?: string;
+    /**
+     * The component used for the root node.
+     */
+    component?: React.ElementType;
+    background?: ColorType;
+    borderColor?: ColorType;
+    borderWidth?: number;
+    borderStyle?: ('solid' | 'dashed');
+    borderPosition?: ('horizontal' | 'vertical' | 'top' | 'right' | 'bottom' | 'left');
+    borderRadius?: number;
+    'data-testid'?: string;
+};
+export declare const Box: React.ForwardRefExoticComponent<BaseProps & React.HTMLAttributes<HTMLElement> & React.RefAttributes<HTMLElement>>;
+export {};

package/dist/types/Button/button.d.ts

@@ -0,0 +1,30 @@
+import * as React from 'react';
+import { ButtonBaseProps } from '../ButtonBase';
+declare type BaseProps = {
+    circled?: boolean;
+    /**
+     * Element placed before the children.
+     */
+    startIcon?: React.ReactNode;
+    /**
+     * Element placed after the children.
+     */
+    endIcon?: React.ReactNode;
+    /**
+     * Specify if the button doesn't have padding.
+     */
+    withoutPadding?: boolean;
+};
+export declare type ButtonProps = BaseProps & ButtonBaseProps;
+export declare const Button: React.ForwardRefExoticComponent<BaseProps & {
+    children: React.ReactNode;
+    disabled?: boolean;
+    variant?: "text" | "contained" | "outlined";
+    textVariant?: import("../styles").TypographyType;
+    color?: "default" | "white" | "primary" | "secondary" | "wrong";
+    size?: "small" | "medium" | "large";
+    className?: string;
+    component?: React.ElementType<any>;
+    'data-testid'?: string;
+} & React.ButtonHTMLAttributes<HTMLButtonElement> & React.RefAttributes<HTMLButtonElement>>;
+export {};

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

@@ -0,0 +1 @@
+export { Button, ButtonProps } from './button';

package/dist/types/ButtonBase/button_base.d.ts

@@ -0,0 +1,40 @@
+import * as React from 'react';
+import { TypographyType } from '../styles';
+declare type BaseProps = {
+    /**
+     * The content of the component.
+     */
+    children: React.ReactNode;
+    /**
+     * If `true`, the button will be disabled.
+     */
+    disabled?: boolean;
+    /**
+     * The variant to use.
+     */
+    variant?: ('contained' | 'outlined' | 'text');
+    /**
+     * The variant of text to use.
+     */
+    textVariant?: TypographyType;
+    /**
+     * The color of the component.
+     */
+    color?: ('primary' | 'secondary' | 'wrong' | 'white' | 'default');
+    /**
+     * The size of the button.
+     */
+    size?: ('small' | 'medium' | 'large');
+    /**
+     * The className of the component.
+     */
+    className?: string;
+    /**
+     * The component used for the root node.
+     */
+    component?: React.ElementType;
+    'data-testid'?: string;
+};
+export declare type ButtonBaseProps = BaseProps & React.ButtonHTMLAttributes<HTMLButtonElement>;
+export declare const ButtonBase: React.ForwardRefExoticComponent<BaseProps & React.ButtonHTMLAttributes<HTMLButtonElement> & React.RefAttributes<HTMLButtonElement>>;
+export {};

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

@@ -0,0 +1 @@
+export { ButtonBase, ButtonBaseProps } from './button_base';

package/dist/types/Checkbox/checkbox.d.ts

@@ -0,0 +1,43 @@
+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 checkbox 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;
+    /**
+     * Callback fired when the state is changed.
+     */
+    onChange?: (event: React.ChangeEvent<HTMLInputElement>) => void;
+    'data-testid'?: string;
+};
+export declare type CheckboxProps = BaseProps & Omit<React.LabelHTMLAttributes<HTMLLabelElement>, 'children' | 'htmlFor' | 'onChange'>;
+export declare const Checkbox: React.ForwardRefExoticComponent<BaseProps & Omit<React.LabelHTMLAttributes<HTMLLabelElement>, "children" | "onChange" | "htmlFor"> & React.RefAttributes<HTMLLabelElement>>;
+export {};

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

@@ -0,0 +1 @@
+export { Checkbox } from './checkbox';

package/dist/types/Chip/chip.d.ts

@@ -0,0 +1,38 @@
+import * as React from 'react';
+declare type BaseProps = {
+    /**
+     * The content of the component.
+     */
+    children: React.ReactNode;
+    /**
+     * If `true`, the chip will be disabled.
+     */
+    disabled?: boolean;
+    /**
+     * Override the default delete icon element. Shown only if `onDelete` is set.
+     */
+    deleteIcon?: React.ReactElement;
+    /**
+     * The variant to use.
+     */
+    variant?: ('contained' | 'outlined');
+    /**
+     * The color of the component.
+     */
+    color?: ('secondary' | 'wrong');
+    /**
+     * The className of the component.
+     */
+    className?: string;
+    /**
+     * Callback function fired when the delete icon is clicked. If set, the delete icon will be shown.
+     */
+    onDelete?: React.MouseEventHandler<HTMLElement>;
+    /**
+     * Callback function fired when the component is clicked. If set, the component will be clickable.
+     */
+    onClick?: React.MouseEventHandler<HTMLElement>;
+    'data-testid'?: string;
+};
+export declare const Chip: React.ForwardRefExoticComponent<BaseProps & React.HTMLAttributes<HTMLDivElement> & React.RefAttributes<HTMLDivElement>>;
+export {};

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

@@ -0,0 +1 @@
+export { Chip } from './chip';

package/dist/types/CircularProgress/circular_progress.d.ts

@@ -0,0 +1,21 @@
+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' | 'white');
+    /**
+     * The className of the component.
+     */
+    className?: string;
+    /**
+     * The size of the progress.
+     */
+    size?: ('small' | 'large');
+};
+export declare type CircularProgressProps = BaseProps & Omit<React.HTMLAttributes<HTMLDivElement>, 'children'>;
+/**
+ *
+ */
+export declare const CircularProgress: React.ForwardRefExoticComponent<BaseProps & Omit<React.HTMLAttributes<HTMLDivElement>, "children"> & React.RefAttributes<HTMLDivElement>>;
+export {};

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

@@ -0,0 +1 @@
+export { CircularProgress, CircularProgressProps } from './circular_progress';

package/dist/types/Collapse/collapse.d.ts

@@ -0,0 +1,20 @@
+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.ReactNode;
+};
+declare type CollapseProps = BaseProps & BaseTransitionProps & React.HTMLAttributes<HTMLDivElement>;
+export declare const Collapse: React.FC<CollapseProps>;
+export {};

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

@@ -0,0 +1 @@
+export { Collapse } from './collapse';

package/dist/types/ComboBox/combo_box.d.ts

@@ -0,0 +1,19 @@
+import * as React from 'react';
+export declare type ComboBoxChangeEventType = React.ChangeEvent<{
+    value: string[];
+    name?: string;
+}>;
+declare type OptionType = {
+    value: string;
+    label: string;
+    disabled?: boolean;
+};
+declare type BaseProps = {
+    options: OptionType[];
+    name?: string;
+    defaultValue?: string[];
+    onChange?: (event: ComboBoxChangeEventType) => void;
+    label?: string;
+};
+export declare const ComboBox: React.ForwardRefExoticComponent<BaseProps & Omit<React.HTMLAttributes<HTMLDivElement>, "children" | "onChange"> & React.RefAttributes<HTMLDivElement>>;
+export {};

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

@@ -0,0 +1 @@
+export { ComboBox, ComboBoxChangeEventType } from './combo_box';

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';