chop-logic-components 2.0.0 → 2.1.0

package/README.md

@@ -6,22 +6,23 @@
 [![GitHub Pages](https://github.com/SavouryGin/chop-logic-components/actions/workflows/github-pages.yml/badge.svg)](https://github.com/SavouryGin/chop-logic-components/actions/workflows/github-pages.yml)
 [![codecov](https://codecov.io/github/SavouryGin/chop-logic-components/graph/badge.svg?token=U5WF25WZTV)](https://codecov.io/github/SavouryGin/chop-logic-components)
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
+[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
 
 Welcome to **Chop Logic Components**, a React components library packed with a variety of **styled
 components** and **custom hooks** that are easy to integrate into any React project.
 
-## About the Library
+## ✨ Features
 
 Chop Logic is designed to speed up development by providing reusable, accessible, and highly customizable components.
 Whether you're building complex forms, creating dynamic layouts, or managing component logic with hooks, Chop Logic
 Components has the tools to make it easier.
 
-## Links
+## 🔗 Links
 
 - [Storybook Playground](https://savourygin.github.io/chop-logic-components)
 - [NPM package](https://www.npmjs.com/package/chop-logic-components)
 
-## Getting Started
+## 📦 Installation
 
 To get started with Chop Logic, install it via npm or yarn:
 
@@ -31,7 +32,7 @@ npm install chop-logic-components
 yarn add chop-logic-components
 ```
 
-## Scripts
+## ⚙️ Available Scripts
 
 ### `start`
 
@@ -94,7 +95,7 @@ npm run lint:fix
 
 ### `check-types`
 
-Runs the TypeScript compiler (tsc) to perform type checking without generating output files. This script helps ensure
+Run the TypeScript compiler (tsc) to perform type checking without generating output files. This script helps ensure
 that the code adheres to TypeScript's type safety.
 
 ```bash
@@ -103,7 +104,7 @@ npm run types
 
 ### `test`
 
-Runs unit tests using Vitest, a fast testing framework designed for Vite projects.
+Run unit tests using Vitest, a fast testing framework designed for Vite projects.
 
 ```bash
 npm run test
@@ -111,7 +112,7 @@ npm run test
 
 ### `test:ci`
 
-Runs the tests in continuous integration (CI) mode with Vitest, providing a streamlined output suitable for automated
+Run the tests in continuous integration (CI) mode with Vitest, providing a streamlined output suitable for automated
 environments.
 
 ```bash
@@ -120,8 +121,23 @@ npm run test:ci
 
 ### `coverage`
 
-Runs unit tests using Vitest and generates a code coverage report using the v8 generator.
+Run unit tests using Vitest and generates a code coverage report using the v8 generator.
 
 ```bash
 npm run coverage
 ```
+
+## 🛠 Contributing
+
+Contributions are welcome! If you find a bug or have an idea for improvement, feel free to open an issue or submit a
+pull request. Please check the [Contribution guide](CONTRIBUTING.md) for additional info.
+
+1. Fork the repository.
+2. Clone your fork.
+3. Create a new feature branch.
+4. Implement and test your changes.
+5. Submit a pull request!
+
+---
+
+Let's build better logic tools together! 🚀

package/dist/icons/index.d.ts

@@ -1,8 +1,8 @@
-import { default as React } from 'react';
+import { ChopLogicSVGElementProps } from '../models';
+import { ReactElement } from 'react';
 import { ChopLogicIconName } from '../enums';
-type LazyIcon = React.LazyExoticComponent<(props: React.SVGProps<SVGSVGElement>) => React.ReactElement>;
-type ChopLogicLazyIcons = {
-    [key in ChopLogicIconName]: LazyIcon;
+type ChopLogicIcons = {
+    [key in ChopLogicIconName]: ({ title, ...rest }: ChopLogicSVGElementProps) => ReactElement;
 };
-export declare const ChopLogicIconDictionary: ChopLogicLazyIcons;
+export declare const ChopLogicIconDictionary: ChopLogicIcons;
 export {};

package/dist/icons/svg/ArrowDownIcon.d.ts

@@ -1,3 +1,3 @@
-import { default as React } from 'react';
-declare function ArrowDownIcon(props: React.SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare function ArrowDownIcon({ title, ...rest }: ChopLogicSVGElementProps): import("react/jsx-runtime").JSX.Element;
 export default ArrowDownIcon;

package/dist/icons/svg/ArrowUpIcon.d.ts

@@ -1,3 +1,3 @@
-import { default as React } from 'react';
-declare function ArrowUpIcon(props: React.SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare function ArrowUpIcon({ title, ...rest }: ChopLogicSVGElementProps): import("react/jsx-runtime").JSX.Element;
 export default ArrowUpIcon;

package/dist/icons/svg/BackIcon.d.ts

@@ -1,3 +1,3 @@
-import { default as React } from 'react';
-declare function BackIcon(props: React.SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare function BackIcon({ title, ...rest }: ChopLogicSVGElementProps): import("react/jsx-runtime").JSX.Element;
 export default BackIcon;

package/dist/icons/svg/CancelIcon.d.ts

@@ -1,3 +1,3 @@
-import { default as React } from 'react';
-declare function CancelIcon(props: React.SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare function CancelIcon({ title, ...rest }: ChopLogicSVGElementProps): import("react/jsx-runtime").JSX.Element;
 export default CancelIcon;

package/dist/icons/svg/CheckMarkIcon.d.ts

@@ -1,3 +1,3 @@
-import { default as React } from 'react';
-declare function CheckMarkIcon(props: React.SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare function CheckMarkIcon({ title, ...rest }: ChopLogicSVGElementProps): import("react/jsx-runtime").JSX.Element;
 export default CheckMarkIcon;

package/dist/icons/svg/CheckboxCheckedIcon.d.ts

@@ -1,3 +1,3 @@
-import { default as React } from 'react';
-declare function CheckboxCheckedIcon(props: React.SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare function CheckboxCheckedIcon({ title, ...rest }: ChopLogicSVGElementProps): import("react/jsx-runtime").JSX.Element;
 export default CheckboxCheckedIcon;

package/dist/icons/svg/CheckboxUncheckedIcon.d.ts

@@ -1,3 +1,3 @@
-import { default as React } from 'react';
-declare function CheckboxUncheckedIcon(props: React.SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare function CheckboxUncheckedIcon({ title, ...rest }: ChopLogicSVGElementProps): import("react/jsx-runtime").JSX.Element;
 export default CheckboxUncheckedIcon;

package/dist/icons/svg/ChevronDownIcon.d.ts

@@ -1,3 +1,3 @@
-import { default as React } from 'react';
-declare function ChevronDownIcon(props: React.SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare function ChevronDownIcon({ title, ...rest }: ChopLogicSVGElementProps): import("react/jsx-runtime").JSX.Element;
 export default ChevronDownIcon;

package/dist/icons/svg/ChevronLeftIcon.d.ts

@@ -1,3 +1,3 @@
-import { default as React } from 'react';
-declare function ChevronLeftIcon(props: React.SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare function ChevronLeftIcon({ title, ...rest }: ChopLogicSVGElementProps): import("react/jsx-runtime").JSX.Element;
 export default ChevronLeftIcon;

package/dist/icons/svg/ChevronRightIcon.d.ts

@@ -1,3 +1,3 @@
-import { default as React } from 'react';
-declare function ChevronRightIcon(props: React.SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare function ChevronRightIcon({ title, ...rest }: ChopLogicSVGElementProps): import("react/jsx-runtime").JSX.Element;
 export default ChevronRightIcon;

package/dist/icons/svg/ChevronUpIcon.d.ts

@@ -1,3 +1,3 @@
-import { default as React } from 'react';
-declare function ChevronUpIcon(props: React.SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare function ChevronUpIcon({ title, ...rest }: ChopLogicSVGElementProps): import("react/jsx-runtime").JSX.Element;
 export default ChevronUpIcon;

package/dist/icons/svg/ClearIcon.d.ts

@@ -1,3 +1,3 @@
-import { default as React } from 'react';
-declare function ClearIcon(props: React.SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare function ClearIcon({ title, ...rest }: ChopLogicSVGElementProps): import("react/jsx-runtime").JSX.Element;
 export default ClearIcon;

package/dist/icons/svg/CopyIcon.d.ts

@@ -1,3 +1,3 @@
-import { default as React } from 'react';
-declare function CopyIcon(props: React.SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare function CopyIcon({ title, ...rest }: ChopLogicSVGElementProps): import("react/jsx-runtime").JSX.Element;
 export default CopyIcon;

package/dist/icons/svg/CutIcon.d.ts

@@ -1,3 +1,3 @@
-import { default as React } from 'react';
-declare function CutIcon(props: React.SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare function CutIcon({ title, ...rest }: ChopLogicSVGElementProps): import("react/jsx-runtime").JSX.Element;
 export default CutIcon;

package/dist/icons/svg/DeleteIcon.d.ts

@@ -1,3 +1,3 @@
-import { default as React } from 'react';
-declare function DeleteIcon(props: React.SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare function DeleteIcon({ title, ...rest }: ChopLogicSVGElementProps): import("react/jsx-runtime").JSX.Element;
 export default DeleteIcon;

package/dist/icons/svg/DownloadIcon.d.ts

@@ -1,3 +1,3 @@
-import { default as React } from 'react';
-declare function DownloadIcon(props: React.SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare function DownloadIcon({ title, ...rest }: ChopLogicSVGElementProps): import("react/jsx-runtime").JSX.Element;
 export default DownloadIcon;

package/dist/icons/svg/ErrorIcon.d.ts

@@ -1,3 +1,3 @@
-import { default as React } from 'react';
-declare function ErrorIcon(props: React.SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare function ErrorIcon({ title, ...rest }: ChopLogicSVGElementProps): import("react/jsx-runtime").JSX.Element;
 export default ErrorIcon;

package/dist/icons/svg/ForwardIcon.d.ts

@@ -1,3 +1,3 @@
-import { default as React } from 'react';
-declare function ForwardIcon(props: React.SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare function ForwardIcon({ title, ...rest }: ChopLogicSVGElementProps): import("react/jsx-runtime").JSX.Element;
 export default ForwardIcon;

package/dist/icons/svg/GraduateIcon.d.ts

@@ -1,3 +1,3 @@
-import * as React from 'react';
-declare const GraduateIcon: (props: React.SVGProps<SVGSVGElement>) => import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare const GraduateIcon: ({ title, ...rest }: ChopLogicSVGElementProps) => import("react/jsx-runtime").JSX.Element;
 export default GraduateIcon;

package/dist/icons/svg/HelpIcon.d.ts

@@ -1,3 +1,3 @@
-import { default as React } from 'react';
-declare function HelpIcon(props: React.SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare function HelpIcon({ title, ...rest }: ChopLogicSVGElementProps): import("react/jsx-runtime").JSX.Element;
 export default HelpIcon;

package/dist/icons/svg/HideIcon.d.ts

@@ -1,3 +1,3 @@
-import { default as React } from 'react';
-declare function HideIcon(props: React.SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare function HideIcon({ title, ...rest }: ChopLogicSVGElementProps): import("react/jsx-runtime").JSX.Element;
 export default HideIcon;

package/dist/icons/svg/HomeIcon.d.ts

@@ -1,3 +1,3 @@
-import { default as React } from 'react';
-declare const HomeIcon: (props: React.SVGProps<SVGSVGElement>) => import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare const HomeIcon: ({ title, ...rest }: ChopLogicSVGElementProps) => import("react/jsx-runtime").JSX.Element;
 export default HomeIcon;

package/dist/icons/svg/InfoIcon.d.ts

@@ -1,3 +1,3 @@
-import { default as React } from 'react';
-declare function InfoIcon(props: React.SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare function InfoIcon({ title, ...rest }: ChopLogicSVGElementProps): import("react/jsx-runtime").JSX.Element;
 export default InfoIcon;

package/dist/icons/svg/LoginIcon.d.ts

@@ -1,3 +1,3 @@
-import * as React from 'react';
-declare const LoginIcon: (props: React.SVGProps<SVGSVGElement>) => import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare const LoginIcon: ({ title, ...rest }: ChopLogicSVGElementProps) => import("react/jsx-runtime").JSX.Element;
 export default LoginIcon;

package/dist/icons/svg/PasteIcon.d.ts

@@ -1,3 +1,3 @@
-import { default as React } from 'react';
-declare function PasteIcon(props: React.SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare function PasteIcon({ title, ...rest }: ChopLogicSVGElementProps): import("react/jsx-runtime").JSX.Element;
 export default PasteIcon;

package/dist/icons/svg/QuestionIcon.d.ts

@@ -1,3 +1,3 @@
-import { default as React } from 'react';
-declare function QuestionIcon(props: React.SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare function QuestionIcon({ title, ...rest }: ChopLogicSVGElementProps): import("react/jsx-runtime").JSX.Element;
 export default QuestionIcon;

package/dist/icons/svg/RemoveIcon.d.ts

@@ -1,3 +1,3 @@
-import { default as React } from 'react';
-declare function RemoveIcon(props: React.SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare function RemoveIcon({ title, ...rest }: ChopLogicSVGElementProps): import("react/jsx-runtime").JSX.Element;
 export default RemoveIcon;

package/dist/icons/svg/SaveIcon.d.ts

@@ -1,3 +1,3 @@
-import { default as React } from 'react';
-declare function SaveIcon(props: React.SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare function SaveIcon({ title, ...rest }: ChopLogicSVGElementProps): import("react/jsx-runtime").JSX.Element;
 export default SaveIcon;

package/dist/icons/svg/ShowIcon.d.ts

@@ -1,3 +1,3 @@
-import { default as React } from 'react';
-declare function ShowIcon(props: React.SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare function ShowIcon({ title, ...rest }: ChopLogicSVGElementProps): import("react/jsx-runtime").JSX.Element;
 export default ShowIcon;

package/dist/icons/svg/UploadIcon.d.ts

@@ -1,3 +1,3 @@
-import { default as React } from 'react';
-declare function UploadIcon(props: React.SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare function UploadIcon({ title, ...rest }: ChopLogicSVGElementProps): import("react/jsx-runtime").JSX.Element;
 export default UploadIcon;

package/dist/icons/svg/WarningIcon.d.ts

@@ -1,3 +1,3 @@
-import { default as React } from 'react';
-declare function WarningIcon(props: React.SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;
+import { ChopLogicSVGElementProps } from '../../models';
+declare function WarningIcon({ title, ...rest }: ChopLogicSVGElementProps): import("react/jsx-runtime").JSX.Element;
 export default WarningIcon;