@mesalvo/react-ui 0.0.31889

package/dist/src/components/Input/props.d.ts

@@ -0,0 +1,171 @@
+import { ComponentProps, ReactNode } from 'react';
+import { Colors, DeepPartial, MainSizes, RoundedSizes } from '../../types';
+import { Editor } from '../ringed-avatars/types';
+import { InputTheme } from './theme';
+/**
+ * @name InputLabelPositionsEnum
+ * @description Enum for different label positions in the BaseInputs component.
+ * @enum [top, left]
+ */
+export declare enum InputLabelPositionsEnum {
+    top = "top",
+    left = "left"
+}
+/**
+ * @name InputLabelPositions
+ * @description Type for label positions in the BaseInputs component.
+ * @enum [top, left]
+ */
+export type InputLabelPositions = keyof typeof InputLabelPositionsEnum;
+/**
+ * @name BaseInputsProps
+ * @description Base props for input components.
+ */
+export interface BaseInputsProps {
+    /**
+     * @name color
+     * @description Optional prop to specify the color of the input.
+     * @default null
+     * @type Colors
+     * @enum [primary, secondary, success, danger, warning, info, light, dark, link]
+     * @example
+     * ```tsx
+     * <BaseInputs color="primary" />
+     * ```
+     */
+    color?: Colors;
+    /**
+     * @name helperText
+     * @description Optional prop to provide helper text for the input.
+     * @default null
+     * @type ReactNode
+     * @example
+     * ```tsx
+     * <BaseInputs helperText="This is a helper text" />
+     * ```
+     */
+    helperText?: ReactNode;
+    /**
+     * @name icon
+     * @description Optional prop to add a component to the right of the input. Recommended to icons
+     * @default null
+     * @type ReactNode
+     * @example
+     * ```tsx
+     * <BaseInputs icon={<RandomIcon />} />
+     * ```
+     */
+    icon?: React.FC<ComponentProps<"svg">>;
+    /**
+     * @name size
+     * @description Optional prop to specify the size of the input.
+     * @default null
+     * @type MainSizes
+     * @enum [xs, sm, md, lg, xl]
+     * @example
+     * ```tsx
+     * <BaseInputs size="md" />
+     * ```
+     */
+    size?: MainSizes;
+    /**
+     * @name theme
+     * @description Optional prop to change the theme of the input.
+     * @default {}
+     * @type DeepPartial<InputTheme>
+     * @example
+     * ```tsx
+     * <BaseInputs theme={{ color: { primary: 'bg-red-500' } }} />
+     * ```
+     */
+    theme?: DeepPartial<InputTheme>;
+    /**
+     * @name label
+     * @description Optional prop to add a label to the input.
+     * @default null
+     * @type string
+     * @example
+     * ```tsx
+     * <BaseInputs label="Username" />
+     * ```
+     */
+    label: string;
+    /**
+     * @name labelClassName
+     * @description Optional prop to add additional classes to the label.
+     * @default ''
+     * @type string
+     * @example
+     * ```tsx
+     * <BaseInputs label="Username" labelClassName="text-red-500" />
+     * ```
+     */
+    labelClassName?: string;
+    /**
+     * @name required
+     * @description Optional prop to specify if the input is required.
+     * @default false
+     * @type boolean
+     * @example
+     * ```tsx
+     * <BaseInputs required />
+     * ```
+     */
+    required?: boolean;
+    /**
+     * @name error
+     * @description Optional prop to specify if the input has an error.
+     * @default undefined
+     * @type string
+     * @example
+     * ```tsx
+     * <Input label="hola" error="This is an error" />
+     * ```
+     */
+    error?: string;
+    /**
+     * @name rounded
+     * @description Optional prop to control the border radius of the input.
+     * @type string
+     * @example
+     * ```tsx
+     * <Input rounded="md" />
+     * ```
+     */
+    rounded?: RoundedSizes;
+    rightContent?: ReactNode;
+    leftContent?: ReactNode;
+    iconPosition?: "left" | "right" /**
+       
+      /**
+       * Prop to highlight the real-time people that are typing in the input.
+       * Used to track how (how many) people are typing in the input.
+       * This can be useful for analytics or collaborative features.
+       * We receive an array of id, name and a optional color.
+       *
+       * @default []
+       * @example
+       * ```tsx
+       * <Input realTimeEditors={[{ id: '1', name: 'John Doe', color: 'blue' }]} />
+       * ```
+       */;
+    realTimeEditors?: Editor[];
+    /**
+     * @description Callback function that is triggered when the input value has stopped changing
+     */
+    onChangeEnd?: (value: string) => void;
+    /**
+     * @description Callback function that is triggered when the input value changes
+     */
+    onChangeValue?: (value: string) => void;
+    onChangeWithValue?: (value: string) => void;
+}
+/**
+ * @name InputProps
+ * @description Props for the Input component.
+ * @type BaseInputsProps
+ * @property addon `ReactNode`
+ */
+export interface InputProps extends Omit<ComponentProps<"input">, "ref" | "color" | "size" | "placeholder">, BaseInputsProps {
+}
+//# sourceMappingURL=props.d.ts.map

package/dist/src/components/Input/props.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../../../src/components/Input/props.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AACvD,OAAO,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAChF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAE1C;;;;GAIG;AACH,oBAAY,uBAAuB;IACjC,GAAG,QAAQ;IACX,IAAI,SAAS;CACd;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,OAAO,uBAAuB,CAAC;AAEvE;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;;;;;;OAUG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;;;;OASG;IACH,UAAU,CAAC,EAAE,SAAS,CAAC;IAEvB;;;;;;;;;OASG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IAEvC;;;;;;;;;;OAUG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IAEjB;;;;;;;;;OASG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC;IAEhC;;;;;;;;;OASG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;;;;;OASG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;;;;;;OASG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,YAAY,CAAC;IAEvB,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB,WAAW,CAAC,EAAE,SAAS,CAAC;IAExB,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;;;;;;;;;;;;;SAa9B,CAAC;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAG3B;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAEtC;;OAEG;IACH,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAExC,iBAAiB,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;CAC7C;AAED;;;;;GAKG;AACH,MAAM,WAAW,UACf,SAAQ,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,MAAM,GAAG,aAAa,CAAC,EAC7E,eAAe;CAAG"}