welcome-ui 1.0.0-beta.3 → 1.0.0-beta.4

package/dist/types/components/Field/styles.d.ts

@@ -0,0 +1,21 @@
+import { WuiProps } from '../System';
+import { FieldIconSize } from '../../utils/field-styles';
+type StyledFieldProps = {
+    checked?: boolean;
+    flexDirection: WuiProps['flexDirection'];
+    isCheckable?: boolean;
+    isRadioGroup?: boolean;
+    withHintText?: boolean;
+};
+export declare const Field: import('styled-components').StyledComponent<"div", import('@xstyled/system').Theme, StyledFieldProps, never>;
+export declare const Label: import('styled-components').StyledComponent<string, import('@xstyled/system').Theme, {}, never>;
+export declare const LabelWithHint: import('styled-components').StyledComponent<string, import('@xstyled/system').Theme, {}, never>;
+type IconWrapperProps = {
+    iconPlacement: 'left' | 'right';
+    size?: FieldIconSize;
+};
+export declare const IconWrapper: import('styled-components').StyledComponent<"div", import('@xstyled/system').Theme, import('@xstyled/system').SystemProps<import('@xstyled/system').Theme> & IconWrapperProps, never>;
+export declare const IconGroupWrapper: import('styled-components').StyledComponent<"div", import('@xstyled/system').Theme, import('@xstyled/system').SystemProps<import('@xstyled/system').Theme> & {
+    size: FieldIconSize;
+}, never>;
+export {};

package/dist/types/components/Field/utils.d.ts

@@ -0,0 +1,5 @@
+import { FieldOptions } from '.';
+export declare const getBaseType: (type: string) => string;
+export declare const getVariant: ({ error, success, warning, }: Pick<FieldOptions, "error" | "success" | "warning">) => "danger" | "warning" | "success";
+export declare const generateRandomId: () => string;
+export declare const forwardedProps: string[];

package/dist/types/components/FieldGroup/index.d.ts

@@ -0,0 +1,11 @@
+import { default as React } from 'react';
+import { LabelOptions } from '../Label';
+import { CreateWuiProps } from '../System';
+export interface FieldGroupOptions {
+    children: React.ReactNode;
+    label?: React.ReactElement;
+    required?: LabelOptions['required'];
+}
+export type FieldGroupProps = CreateWuiProps<'fieldset', FieldGroupOptions>;
+export declare const FieldGroup: import('../System').CreateWuiComponent<"fieldset", FieldGroupProps>;
+export declare const StyledFieldGroup: import('styled-components').StyledComponent<"fieldset", import('@xstyled/system').Theme, import('@xstyled/system').SystemProps<import('@xstyled/system').Theme>, never>;

package/dist/types/components/FieldGroup/styles.d.ts

@@ -0,0 +1 @@
+export declare const FieldGroup: import('styled-components').StyledComponent<"fieldset", import('@xstyled/system').Theme, import('@xstyled/system').SystemProps<import('@xstyled/system').Theme>, never>;

package/dist/types/components/FileDrop/FilePreview.d.ts

@@ -0,0 +1,9 @@
+import { default as React } from 'react';
+import { ForceFileType } from '../Files';
+import { FileDropChildren } from './index';
+export interface MessageProps {
+    file: FileDropChildren['file'];
+    fileName?: string;
+    forceFileType?: ForceFileType;
+}
+export declare const FilePreview: React.FC<MessageProps & FileDropChildren['wordings']>;

package/dist/types/components/FileDrop/Message.d.ts

@@ -0,0 +1,7 @@
+import { default as React } from 'react';
+import { FileDropChildren } from './index';
+export interface MessageProps {
+    disabled?: boolean;
+    openFile?: FileDropChildren['openFile'];
+}
+export declare const Message: React.FC<MessageProps & FileDropChildren['wordings']>;

package/dist/types/components/FileDrop/Preview.d.ts

@@ -0,0 +1,3 @@
+import { default as React } from 'react';
+import { FileDropChildren } from './index';
+export declare const Preview: React.FC<FileDropChildren>;

package/dist/types/components/FileDrop/index.d.ts

@@ -0,0 +1,52 @@
+import { default as React } from 'react';
+import { Accept, DropEvent, DropzoneProps, DropzoneState } from 'react-dropzone';
+import { ForceFileType } from '../Files';
+import { CreateWuiProps } from '../System';
+import { CreateEvent } from '../../utils/create-event';
+export interface FileWithPreview extends File {
+    preview?: string;
+}
+type FileType = string | FileWithPreview;
+type FileUrlType = string | URL;
+type OpenType = DropzoneState['open'];
+type WordingsType = {
+    fileButtonText?: string | JSX.Element;
+    hint?: string | JSX.Element;
+    previewButtonText?: string | JSX.Element;
+    title?: string | JSX.Element;
+};
+export type FileDropChildren = {
+    disabled?: boolean;
+    error?: string;
+    file?: FileType;
+    fileName?: string;
+    fileUrl?: FileUrlType;
+    forceFileType?: ForceFileType;
+    isAnImage?: boolean;
+    isHoverAccept?: DropzoneState['isDragAccept'];
+    isHoverReject?: DropzoneState['isDragReject'];
+    openFile?: OpenType;
+    wordings?: WordingsType;
+};
+export interface FileDropOptions {
+    /** Pass a comma-separated string of file types e.g. "image/png" or "image/png,image/jpeg" */
+    accept?: Accept;
+    children?: (state: FileDropChildren) => JSX.Element;
+    fileName?: string;
+    forceFileType?: ForceFileType;
+    handleAddFile?: (event: DropEvent | React.ChangeEvent<HTMLInputElement> | CreateEvent) => void;
+    handleRemoveFile?: (event: DropEvent | React.ChangeEvent<HTMLInputElement> | CreateEvent) => void;
+    isClearable?: boolean;
+    isEditable?: boolean;
+    name?: string;
+    onBlur?: () => void;
+    onChange?: (event: DropEvent | React.ChangeEvent<HTMLInputElement> | CreateEvent) => void;
+    onError?: (event?: string) => void;
+    value: FileType;
+    /** Pass an object with optional fields title, hint, fileButtonText and/or previewButtonText (string or JSX.Element) */
+    wordings?: WordingsType;
+}
+export type FileDropProps = CreateWuiProps<'div', FileDropOptions> & Omit<DropzoneProps, 'children'>;
+export declare const FileDrop: import('../System').CreateWuiComponent<"div", FileDropProps>;
+export declare const ImagePreview: import('styled-components').StyledComponent<"img", import('@xstyled/system').Theme, import('@xstyled/system').SystemProps<import('@xstyled/system').Theme>, never>;
+export {};

package/dist/types/components/FileDrop/styles.d.ts

@@ -0,0 +1,9 @@
+export interface StyledFileDropProps {
+    disabled?: boolean;
+    isDragAccept?: boolean;
+    isDragReject?: boolean;
+}
+export declare const FileDrop: import('styled-components').StyledComponent<"div", import('@xstyled/system').Theme, StyledFileDropProps, never>;
+export declare const FilePreview: import('styled-components').StyledComponent<string, import('@xstyled/system').Theme, {}, never>;
+export declare const ImagePreview: import('styled-components').StyledComponent<"img", import('@xstyled/system').Theme, import('@xstyled/system').SystemProps<import('@xstyled/system').Theme>, never>;
+export declare const Actions: import('styled-components').StyledComponent<string, import('@xstyled/system').Theme, {}, never>;

package/dist/types/components/FileDrop/theme.d.ts

@@ -0,0 +1,9 @@
+import { CSSObject } from '@xstyled/styled-components';
+import { ThemeValues } from '../../theme';
+export type ThemeFileDrops = {
+    default: CSSObject;
+    disabled: CSSObject;
+    dragAccept: Record<string, unknown>;
+    dragReject: Record<string, unknown>;
+};
+export declare const getFileDrops: (theme: ThemeValues) => ThemeFileDrops;

package/dist/types/components/FileDrop/utils.d.ts

@@ -0,0 +1,3 @@
+import { FileDropChildren } from './index';
+export declare const isAnImage: (file: FileDropChildren["file"]) => boolean;
+export declare const getPreviewUrl: (file: FileDropChildren["file"]) => FileDropChildren["fileUrl"];

package/dist/types/components/FileUpload/index.d.ts

@@ -0,0 +1,35 @@
+import { default as React } from 'react';
+import { CreateWuiProps } from '../System';
+import { createEvent } from '../../utils/create-event';
+import { FileType } from '../Files';
+import { TagProps } from '../Tag';
+type FileWithPreview = File & {
+    name?: string;
+    preview?: string;
+};
+type FileWithPreviewType = FileWithPreview | string;
+type HandleRemoveType = (file: FileWithPreviewType) => void;
+export type FileUploadPreviewProps = {
+    file: FileType;
+    onRemove: TagProps['onRemove'];
+};
+export interface FileUploadOptions {
+    /** Pass a comma-separated string of file types e.g. "image/png" or "image/png,image/jpeg" */
+    accept?: string;
+    children?: (props: {
+        disabled: boolean;
+        files: FileWithPreviewType[];
+        onRemoveFile: HandleRemoveType;
+        openFile: () => void;
+    }) => React.ReactNode;
+    handleAddFile?: (files: FileWithPreviewType[] | FileWithPreviewType) => void;
+    handleRemoveFile?: HandleRemoveType;
+    maxSize?: number;
+    onBlur?: () => void;
+    onChange?: (event: ReturnType<typeof createEvent>) => void;
+    preview?: typeof DefaultPreview;
+}
+export type FileUploadProps = CreateWuiProps<'input', FileUploadOptions>;
+declare const DefaultPreview: React.FC<FileUploadPreviewProps>;
+export declare const FileUpload: import('../System').CreateWuiComponent<"input", FileUploadProps>;
+export {};

package/dist/types/components/FileUpload/styles.d.ts

@@ -0,0 +1 @@
+export declare const Input: import('styled-components').StyledComponent<"input", import('@xstyled/system').Theme, import('@xstyled/system').SystemProps<import('@xstyled/system').Theme>, never>;

package/dist/types/components/Files/index.d.ts

@@ -0,0 +1,8 @@
+import { default as React } from 'react';
+import { IconProps } from '../Icon';
+export type FileType = string | File;
+export type ForceFileType = 'image' | 'audio' | 'video';
+export declare function getFileName(file: FileType): string;
+export declare function getMimeType(file: FileType): string;
+export declare function getFileSize(file: FileType): string;
+export declare function getFileIcon(file: FileType, forceFileType?: ForceFileType): React.FC<IconProps>;

package/dist/types/components/Files/types.d.ts

@@ -0,0 +1,72 @@
+export interface Types {
+    '7z': 'application/x-7z-compressed';
+    aac: 'audio/aac';
+    aif: 'audio/x-aiff';
+    aifc: 'audio/x-aiff';
+    aiff: 'audio/x-aiff';
+    au: 'audio/basic';
+    avi: 'video/x-msvideo';
+    bmp: 'image/x-ms-bmp';
+    bz: 'application/x-bzip';
+    bz2: 'application/x-bzip2';
+    csv: 'text/csv';
+    doc: 'application/msword';
+    docx: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document';
+    gif: 'image/gif';
+    gz: 'application/gzip';
+    ico: 'image/x-icon';
+    jpe: 'image/jpeg';
+    jpeg: 'image/jpeg';
+    jpg: 'image/jpeg';
+    m1v: 'video/mpeg';
+    mid: 'audio/midi';
+    midi: 'audio/x-midi';
+    mov: 'video/quicktime';
+    movie: 'video/x-sgi-movie';
+    mp2: 'audio/mpeg';
+    mp3: 'audio/mpeg';
+    mp4: 'video/mp4';
+    mpa: 'video/mpeg';
+    mpe: 'video/mpeg';
+    mpeg: 'video/mpeg';
+    mpg: 'video/mpeg';
+    pbm: 'image/x-portable-bitmap';
+    pdf: 'application/pdf';
+    pgm: 'image/x-portable-graymap';
+    png: 'image/png';
+    pnm: 'image/x-portable-anymap';
+    pot: 'application/vnd.ms-powerpoint';
+    ppa: 'application/vnd.ms-powerpoint';
+    ppm: 'image/x-portable-pixmap';
+    pps: 'application/vnd.ms-powerpoint';
+    ppt: 'application/vnd.ms-powerpoint';
+    pptx: 'application/vnd.openxmlformats-officedocument.presentationml.presentation';
+    ps: 'application/postscript';
+    pwz: 'application/vnd.ms-powerpoint';
+    qt: 'video/quicktime';
+    ra: 'audio/x-pn-realaudio';
+    rar: 'application/vnd.rar';
+    ras: 'image/x-cmu-raster';
+    rgb: 'image/x-rgb';
+    snd: 'audio/basic';
+    svg: 'image/svg+xml';
+    tif: 'image/tiff';
+    tiff: 'image/tiff';
+    wav: 'audio/x-wav';
+    weba: 'audio/webm';
+    webm: 'video/webm';
+    webp: 'image/webp';
+    wiz: 'application/msword';
+    xbm: 'image/x-xbitmap';
+    xls: 'application/vnd.ms-excel';
+    xlsx: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet';
+    xpm: 'image/x-xpixmap';
+    xwd: 'image/x-xwindowdump';
+    zip: 'application/zip';
+}
+export type Type = Types[keyof Types] | (string & {});
+interface TypesWithString extends Types {
+    [key: string]: string;
+}
+export declare const types: TypesWithString;
+export {};

package/dist/types/components/Grid/Item.d.ts

@@ -0,0 +1,14 @@
+import { CreateWuiProps, WuiProps } from '../System';
+export interface ItemOptions {
+    /** same as gridArea */
+    area?: WuiProps['gridArea'];
+    /** same as gridColumn */
+    column?: WuiProps['gridColumn'];
+    /** same as gridRow */
+    row?: WuiProps['row'];
+}
+export type ItemProps = CreateWuiProps<'div', ItemOptions>;
+/**
+ * @name Grid.Item
+ */
+export declare const Item: import('../System').CreateWuiComponent<"div", ItemProps>;

package/dist/types/components/Grid/index.d.ts

@@ -0,0 +1,31 @@
+import { CreateWuiProps, WuiProps } from '../System';
+export interface GridOptions {
+    /** same as gridArea */
+    area?: WuiProps['gridArea'];
+    /** same as gridAutoColumns */
+    autoColumns?: WuiProps['gridAutoColumns'];
+    /** same as gridAutoFlow */
+    autoFlow?: WuiProps['gridAutoFlow'];
+    /** same as gridAutoRows */
+    autoRows?: WuiProps['gridAutoRows'];
+    /** same as gridColumn */
+    column?: WuiProps['gridColumn'];
+    /** same as columnGap */
+    columnGap?: WuiProps['columnGap'];
+    /** same as gridGap */
+    gap?: WuiProps['gap'];
+    /** same as gridRow */
+    row?: WuiProps['gridRow'];
+    /** same as gridRowGap */
+    rowGap?: WuiProps['rowGap'];
+    /** same as gridTemplateAreas */
+    templateAreas?: WuiProps['gridTemplateAreas'];
+    /** same as gridTemplateColumns */
+    templateColumns?: WuiProps['gridTemplateColumns'];
+    /** same as gridTemplateRows */
+    templateRows?: WuiProps['gridTemplateRows'];
+}
+export type GridProps = CreateWuiProps<'div', GridOptions>;
+export declare const Grid: import('../System').CreateWuiComponent<"div", GridProps> & {
+    Item: import('../System').CreateWuiComponent<"div", import('./Item').ItemProps>;
+};

package/dist/types/components/Hint/index.d.ts

@@ -0,0 +1,10 @@
+import { CreateWuiProps } from '../System';
+export interface HintOptions {
+    checkableField?: boolean;
+    variant?: 'danger' | 'success' | 'warning';
+}
+export type HintProps = CreateWuiProps<'div', HintOptions>;
+export declare const Hint: import('../System').CreateWuiComponent<"div", HintProps>;
+export declare const StyledHint: import('styled-components').StyledComponent<string, import('@xstyled/system').Theme, {
+    variant: HintOptions["variant"];
+}, never>;

package/dist/types/components/Hint/styles.d.ts

@@ -0,0 +1,4 @@
+import { HintOptions } from '.';
+export declare const Hint: import('styled-components').StyledComponent<string, import('@xstyled/system').Theme, {
+    variant: HintOptions["variant"];
+}, never>;

package/dist/types/components/Hint/theme.d.ts

@@ -0,0 +1,9 @@
+import { CSSObject } from '@xstyled/styled-components';
+import { ThemeValues } from '../../theme';
+export type ThemeHints = {
+    danger: CSSObject;
+    default: CSSObject;
+    success: CSSObject;
+    warning: CSSObject;
+};
+export declare const getHints: (theme: ThemeValues) => ThemeHints;

package/dist/types/components/Icon/index.d.ts

@@ -0,0 +1,26 @@
+import { default as React } from 'react';
+import { CreateWuiProps } from '../System';
+import * as S from './styles';
+type IconContent = {
+    block?: string;
+    height?: number;
+    isFlag?: boolean;
+    stroked?: boolean;
+    viewBox?: string;
+    width?: number;
+};
+type Size = 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl' | number | string;
+export interface IconOptions {
+    content?: IconContent;
+    name?: string;
+    onClick?: (event: React.MouseEvent<SVGSVGElement>) => void;
+    size?: Size;
+    title?: string;
+}
+export type IconProps = CreateWuiProps<typeof S.Icon, IconOptions>;
+export declare const Icon: import('../System').CreateWuiComponent<"svg", IconProps>;
+export declare const StyledIcon: import('styled-components').StyledComponent<"svg", import('@xstyled/system').Theme, Pick<IconOptions, "size"> & Pick<IconContent, "isFlag" | "stroked"> & import('../System').WuiProps & Partial<{
+    alt: string;
+    title: string;
+}>, never>;
+export {};

package/dist/types/components/Icon/styles.d.ts

@@ -0,0 +1,9 @@
+import { Theme } from '@xstyled/styled-components';
+import { WuiProps } from '../System';
+import { IconOptions } from './index';
+type StyledIconProps = Pick<IconOptions, 'size'> & Pick<IconOptions['content'], 'isFlag' | 'stroked'> & WuiProps & Partial<{
+    alt: string;
+    title: string;
+}>;
+export declare const Icon: import('styled-components').StyledComponent<"svg", Theme, StyledIconProps, never>;
+export {};

package/dist/types/components/Icon/theme.d.ts

@@ -0,0 +1,10 @@
+import { ThemeValues } from '../../theme';
+export type ThemeIcons = {
+    lg: string;
+    md: string;
+    sm: string;
+    xl: string;
+    xs: string;
+    xxl: string;
+};
+export declare const getIcons: ({ toRem }: ThemeValues) => ThemeIcons;