@producteca/producteca-ui-kit 0.0.13 → 1.0.0

package/README.md

@@ -14,10 +14,42 @@
 
 ## Main Scripts
 
-- `dev`: Bootstrap the Storybook preview with Hot Reload.
-- `build`: Builds the static storybook project.
-- `build:lib`: Builds the component library into the **dist** folder.
-- `lint:fix`: Applies linting based on the rules defined in **.eslintrc.js**.
-- `format:prettier`: Formats files using the prettier rules defined in **.prettierrc**.
-- `test`: Runs testing using watch mode.
-- `test:cov`: Runs testing displaying a coverage report.
+- `dev`: Starts Storybook in development mode on port 6006.
+- `build`: Builds the static Storybook project.
+- `build:lib`: Removes the `dist` folder, compiles TypeScript, and builds the library using Vite.
+- `deploy`: Deploys the project using the specified Makefile configuration.
+- `lint`: Runs ESLint to lint and fix issues in files with `.js`, `.jsx`, `.ts`, and `.tsx` extensions.
+- `prettier`: Formats files in the `src` folder with extensions `.ts`, `.tsx`, `.js`, and `.mdx` using Prettier.
+- `test`: Runs tests using Vitest.
+- `test:cov`: Executes tests and generates a coverage report using Vitest.
+- `prepare`: Prepares the repository by installing Husky for Git hooks.
+- `pre-commit`: Installs Husky and sets up Git hooks for pre-commit validation.
+- `build-storybook`: Builds the static Storybook project.
+
+### Setting up `@producteca/producteca-ui-kit`
+
+Follow these steps to integrate and configure the `@producteca/producteca-ui-kit` package in your project:
+
+1. **Install the package**  
+   Make sure to install the latest version of the package:
+   ```bash
+   bun install @producteca/producteca-ui-kit
+
+   ```
+2. **Import the styles**  
+   Add the following line to your `app/css/setup.js` file:
+   ```bash
+   import "@producteca/producteca-ui-kit/dist/style.css";
+
+   ```
+3. **Remove old SelectField instances**
+
+- Check for any existing version of `selectField`. If found, delete the file:
+  ```bash
+  app/components/form/selectField
+
+  ```
+- Update any old imports to:
+  ```bash
+  import { SelectField } from "@producteca/producteca-ui-kit";
+  ```

package/dist/components/emptyState/emptyState.d.ts

@@ -2,10 +2,10 @@ import { default as React } from 'react';
 
 interface EmptyStateProps {
     onActionClick?: () => void;
-    actionTex?: string;
+    actionText?: string;
     text?: string;
     icon?: React.ReactNode;
 }
-export declare const EmptyState: ({ onActionClick, icon, actionTex, text, }: EmptyStateProps) => import("react/jsx-runtime").JSX.Element;
+export declare const EmptyState: ({ onActionClick, icon, actionText, text, }: EmptyStateProps) => import("react/jsx-runtime").JSX.Element;
 export type { EmptyStateProps };
 export default EmptyState;

package/dist/components/icons/closeIcon/closeIcon.d.ts

@@ -0,0 +1,5 @@
+import { IconInterface } from '../parameters';
+
+export declare const CloseIcon: ({ size, color }: IconInterface) => import("react/jsx-runtime").JSX.Element;
+export type { IconInterface };
+export default CloseIcon;

package/dist/components/icons/index.d.ts

@@ -1 +1,3 @@
 export { SearchPublication } from './searchPublication/searchPublication';
+export { CloseIcon } from './closeIcon/closeIcon';
+export { SearchIcon } from './searchIcon/searchIcon';

package/dist/components/icons/parameters.d.ts

@@ -0,0 +1,35 @@
+export interface IconInterface {
+    size?: number;
+    color?: string;
+}
+interface ArgTypes {
+    [key: string]: {
+        control: {
+            type: string;
+            presetColors?: {
+                title: string;
+                color: string;
+            }[];
+        };
+        description: string;
+    };
+}
+export declare const argTypes: ArgTypes;
+export declare const parameters: {
+    layout: string;
+    design: {
+        type: string;
+        url: string;
+    };
+};
+export declare const defaultParameters: {
+    parameters: {
+        layout: string;
+        design: {
+            type: string;
+            url: string;
+        };
+    };
+    argTypes: ArgTypes;
+};
+export default defaultParameters;

package/dist/components/icons/searchIcon/searchIcon.d.ts

@@ -0,0 +1,5 @@
+import { IconInterface } from '../parameters';
+
+export declare const SearchIcon: ({ size, color }: IconInterface) => import("react/jsx-runtime").JSX.Element;
+export type { IconInterface };
+export default SearchIcon;

package/dist/components/icons/searchPublication/searchPublication.d.ts

@@ -1,8 +1,5 @@
+import { IconInterface } from '../parameters';
 
-interface SearchPublicationProps {
-    size?: number;
-    color?: string | undefined;
-}
-export declare const SearchPublication: ({ size, color }: SearchPublicationProps) => import("react/jsx-runtime").JSX.Element;
-export type { SearchPublicationProps };
+export declare const SearchPublication: ({ size, color }: IconInterface) => import("react/jsx-runtime").JSX.Element;
+export type { IconInterface };
 export default SearchPublication;

package/dist/components/index.d.ts

@@ -1,4 +1,5 @@
 export * from './button/button';
 export * from './emptyState/emptyState';
+export * from './selectField/selectField';
 export * from './icons';
 export * from './spinner/spinner';

package/dist/components/selectField/selectField.d.ts

@@ -0,0 +1,28 @@
+import { default as React } from 'react';
+
+interface SelectOption {
+    label: string;
+    value: string | number;
+    [key: string]: any;
+}
+export interface SelectFieldProps {
+    name: string;
+    label?: string;
+    placeholder?: string;
+    isDisabled?: boolean;
+    onBlur?: () => void;
+    noOptionsMessage?: string;
+    options: SelectOption[];
+    hideSelectedOptions?: boolean;
+    defaultValue?: SelectOption[] | SelectOption | null | undefined;
+    currentValue?: (string | number)[];
+    isMultiple?: boolean;
+    isSearchable?: boolean;
+    isClearable?: boolean;
+    isRequired?: boolean;
+    isOptionDisabled?: (option: SelectOption) => boolean;
+    rightModifier?: React.ReactNode;
+    setValue: (name: string, value: SelectOption | SelectOption[] | null) => void;
+}
+export declare const SelectField: React.FC<SelectFieldProps>;
+export default SelectField;

package/dist/index.d.ts

@@ -1,2 +1 @@
-
 export * from './components';

package/dist/locales/es.d.ts

@@ -1,5 +1,12 @@
 declare const _default: {
     noResultsFound: string;
     reloadPage: string;
+    selectPlaceholder: string;
+    noOptionsMessage: string;
+    noFoundOptions: string;
+    selectedPlural: string;
+    selected: string;
+    selectRequiredText: string;
+    hideSelectedOptionsExplainText: string;
 };
 export default _default;