gantri-components 1.43.0 → 1.45.1

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

@@ -1,12 +1,12 @@
 import { TextVariant } from '../typography/typography.types';
-export interface CheckboxProps {
+import { FieldChangeEvent } from '../text-field';
+export interface CheckboxProps<T = boolean> {
     checked?: boolean;
     disabled?: boolean;
-    extraProps?: any;
     labelPosition?: 'left' | 'right';
     labelText?: string;
     labelTx?: string;
     labelVariant?: TextVariant;
     name?: string;
-    onChange?: (value: boolean, extraProps?: any) => void;
+    onChange?: (event: FieldChangeEvent<T>) => void;
 }

package/dist/components/formik-input/formik-input.d.ts

@@ -0,0 +1,3 @@
+import { FC, PropsWithChildren } from 'react';
+import { FormikInputProps } from './formik-input.types';
+export declare const FormikInput: FC<PropsWithChildren<FormikInputProps>>;

package/dist/components/formik-input/formik-input.presets.d.ts

@@ -0,0 +1,2 @@
+import { FormikInputProps } from './formik-input.types';
+export declare const FormikInputPresets: Partial<FormikInputProps>;

package/dist/components/formik-input/formik-input.types.d.ts

@@ -0,0 +1,12 @@
+import { ReactElement } from 'react';
+import { TextFieldProps } from '../text-field';
+export interface FormikInputProps<FieldType = Record<string, unknown>> extends TextFieldProps {
+    Field?: ReactElement<FieldType, any>;
+    /**
+     * standard wraps a formik Field component
+     * fast wraps a formik FastField component
+     * Refer to https://formik.org/docs/api/fastfield for more information
+     */
+    fieldVariant?: 'standard' | 'fast';
+    name: string;
+}

package/dist/components/formik-input/index.d.ts

@@ -0,0 +1 @@
+export * from './formik-input';

package/dist/components/index.d.ts

@@ -3,11 +3,14 @@ export * from './badge';
 export * from './box';
 export * from './button';
 export * from './cell';
+export * from './checkbox';
 export * from './flex';
+export * from './formik-input';
 export * from './grid';
 export * from './icon';
 export * from './image';
 export * from './radio';
 export * from './stack';
+export * from './text-area';
+export * from './text-field';
 export * from './typography';
-export * from './checkbox';

package/dist/components/text-area/error-message.d.ts

@@ -0,0 +1,3 @@
+import { FC } from 'react';
+import { ErrorMessageProps } from '../text-field';
+export declare const ErrorMessage: FC<ErrorMessageProps>;

package/dist/components/text-area/index.d.ts

@@ -0,0 +1,2 @@
+export * from './text-area';
+export * from './text-area.types';

package/dist/components/text-area/text-area.d.ts

@@ -0,0 +1,3 @@
+import { FC } from 'react';
+import { TextAreaProps } from './text-area.types';
+export declare const TextArea: FC<TextAreaProps>;

package/dist/components/text-area/text-area.presets.d.ts

@@ -0,0 +1,2 @@
+import { TextAreaProps } from './text-area.types';
+export declare const TextAreaPresets: Partial<TextAreaProps>;

package/dist/components/text-area/text-area.styles.d.ts

@@ -0,0 +1,7 @@
+import { DefaultTheme } from 'styled-components';
+import { StyledInputContainerProps, StyledParentContainerProps } from '../text-field';
+export declare const StyledTextareaParentContainer: import("styled-components").StyledComponent<"div", DefaultTheme, StyledParentContainerProps, never>;
+export declare const StyledIconContainer: import("styled-components").StyledComponent<"div", DefaultTheme, {}, never>;
+export declare const StyledContainer: import("styled-components").StyledComponent<"div", DefaultTheme, StyledInputContainerProps, never>;
+export declare const StyledInputWrapper: import("styled-components").StyledComponent<"div", DefaultTheme, {}, never>;
+export declare const StyledTextarea: import("styled-components").StyledComponent<"textarea", DefaultTheme, {}, never>;

package/dist/components/text-area/text-area.types.d.ts

@@ -0,0 +1,5 @@
+import { TextFieldProps } from '../text-field';
+export interface TextAreaProps extends Pick<TextFieldProps, Exclude<keyof TextFieldProps, 'icon' | 'type' | 'autoFocus' | 'minValue' | 'maxValue'>> {
+    cols?: number;
+    rows?: number;
+}

package/dist/components/text-field/error-message.d.ts

@@ -0,0 +1,3 @@
+import { FC } from 'react';
+import { ErrorMessageProps } from './text-field.types';
+export declare const ErrorMessage: FC<ErrorMessageProps>;

package/dist/components/text-field/index.d.ts

@@ -0,0 +1,2 @@
+export * from './text-field';
+export * from './text-field.types';

package/dist/components/text-field/text-field.d.ts

@@ -0,0 +1,3 @@
+import { FC } from 'react';
+import { TextFieldProps } from './text-field.types';
+export declare const TextField: FC<TextFieldProps>;

package/dist/components/text-field/text-field.presets.d.ts

@@ -0,0 +1,2 @@
+import { TextFieldProps } from './text-field.types';
+export declare const TextFieldPresets: Partial<TextFieldProps>;

package/dist/components/text-field/text-field.styles.d.ts

@@ -0,0 +1,7 @@
+import { DefaultTheme } from 'styled-components';
+import { StyledInputContainerProps, StyledParentContainerProps } from './text-field.types';
+export declare const StyledParentContainer: import("styled-components").StyledComponent<"div", DefaultTheme, StyledParentContainerProps, never>;
+export declare const StyledIconContainer: import("styled-components").StyledComponent<"div", DefaultTheme, {}, never>;
+export declare const StyledContainer: import("styled-components").StyledComponent<"div", DefaultTheme, StyledInputContainerProps, never>;
+export declare const StyledInputWrapper: import("styled-components").StyledComponent<"div", DefaultTheme, {}, never>;
+export declare const StyledInput: import("styled-components").StyledComponent<"input", DefaultTheme, {}, never>;

package/dist/components/text-field/text-field.types.d.ts

@@ -0,0 +1,67 @@
+import { ChangeEvent, CSSProperties, FocusEvent, KeyboardEventHandler, ReactElement } from 'react';
+export declare type ErrorMessageType = string | {
+    tx: string;
+    values?: {
+        [key: string]: string;
+    };
+};
+export interface TextFieldProps {
+    ariaLabel?: string;
+    ariaLabelTx?: string;
+    autoComplete?: string;
+    autoFocus?: boolean;
+    className?: string;
+    debounce?: number;
+    disabled?: boolean;
+    /**
+     * This field is used to map the error message, it can be a string
+     * or an object that contains tx and the values used to be mapped
+     * against translation keys.
+     * */
+    errorMessage?: ErrorMessageType;
+    hideErrors?: boolean;
+    icon?: ReactElement;
+    id?: string;
+    labelPosition?: 'top' | 'left';
+    labelText?: string;
+    labelTx?: string;
+    labelTxValues?: Record<string, unknown>;
+    maxLength?: number;
+    maxValue?: number;
+    minValue?: number;
+    name?: string;
+    onBlur?: (event: FocusEvent) => void;
+    onChange?: (event: ChangeEvent<HTMLInputElement | HTMLTextAreaElement>) => void;
+    onFocus?: (event: FocusEvent) => void;
+    onKeyDown?: KeyboardEventHandler<HTMLInputElement | HTMLTextAreaElement>;
+    onKeyUp?: KeyboardEventHandler<HTMLInputElement | HTMLTextAreaElement>;
+    onTextChange?: (value: string) => void;
+    placeholder?: string;
+    placeholderTx?: string;
+    placeholderTxValues?: {
+        [key: string]: string;
+    };
+    readOnly?: boolean;
+    required?: boolean;
+    style?: CSSProperties;
+    throttle?: number;
+    type?: string;
+    value?: string;
+    variant?: 'line' | 'filled';
+}
+export interface FieldChangeEvent<T = boolean> extends Pick<ChangeEvent<Partial<HTMLInputElement>>, Exclude<keyof ChangeEvent<HTMLInputElement>, 'target'>> {
+    target: {
+        name: string;
+        value: T;
+    };
+}
+export interface StyledInputContainerProps extends Pick<TextFieldProps, 'variant'> {
+    $disabled: boolean;
+    $withErrors: boolean;
+}
+export interface StyledParentContainerProps extends Pick<TextFieldProps, 'labelPosition'> {
+}
+export interface ErrorMessageProps {
+    errorMessage?: ErrorMessageType;
+    required?: boolean;
+}

package/dist/global/hooks/index.d.ts

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

package/dist/global/hooks/useId.d.ts

@@ -0,0 +1 @@
+export declare const useId: () => string;

package/dist/global/index.d.ts

@@ -0,0 +1 @@
+export * from './hooks';