chop-logic-components 0.5.1 → 0.6.0

package/dist/components/{button → controls/button}/Button.d.ts

@@ -1,4 +1,4 @@
-import { Icon } from '../../../../../../../../src/enums/icon';
+import { Icon } from '../../../../../../../../../src/enums/icon';
 import { default as React, MouseEventHandler } from 'react';
 
 export type ChopLogicButtonProps = React.ButtonHTMLAttributes<HTMLButtonElement> & {

package/dist/components/{button → controls/button}/__docs__/Button.stories.d.ts

@@ -1,4 +1,4 @@
-import { default as ExampleButton } from './Example';
+import { default as ExampleButton } from './ButtonExample';
 import { Meta, StoryObj } from '@storybook/react';
 
 declare const meta: Meta<typeof ExampleButton>;

package/dist/components/index.d.ts

@@ -1,4 +1,6 @@
-export { default as ChopLogicButton } from './button/Button';
+export { default as ChopLogicButton } from './controls/button/Button';
 export { default as ChopLogicTextInput } from './inputs/text/TextInput';
 export { default as ChopLogicSelect } from './inputs/select/Select';
 export { default as ChopLogicCheckbox } from './inputs/checkbox/Checkbox';
+export { default as ChopLogicDialog } from './modals/dialog/Dialog';
+export { default as ChopLogicTooltip } from './modals/tooltip/Tooltip';

package/dist/components/inputs/checkbox/__docs__/Checkbox.stories.d.ts

@@ -1,4 +1,4 @@
-import { default as Example } from './Example';
+import { default as Example } from './CheckboxExample';
 import { Meta, StoryObj } from '@storybook/react';
 
 declare const meta: Meta<typeof Example>;

package/dist/components/inputs/multi-select/__docs__/MultiSelect.stories.d.ts

@@ -1,4 +1,4 @@
-import { default as Example } from './Example';
+import { default as Example } from './MultiSelectExample';
 import { Meta, StoryObj } from '@storybook/react';
 
 declare const meta: Meta<typeof Example>;

package/dist/components/inputs/select/__docs__/Select.stories.d.ts

@@ -1,4 +1,4 @@
-import { default as Example } from './Example';
+import { default as Example } from './SelectExample';
 import { Meta, StoryObj } from '@storybook/react';
 
 declare const meta: Meta<typeof Example>;

package/dist/components/inputs/text/__docs__/TextInput.stories.d.ts

@@ -1,4 +1,4 @@
-import { default as Example } from './Example';
+import { default as Example } from './TextInputExample';
 import { Meta, StoryObj } from '@storybook/react';
 
 declare const meta: Meta<typeof Example>;

package/dist/components/{modal/Modal.d.ts → modals/dialog/Dialog.d.ts}

@@ -5,5 +5,5 @@ export type ChopLogicModalProps = PropsWithChildren & React.HTMLAttributes<HTMLD
     onClose: () => void;
     title: string;
 };
-declare const ChopLogicModal: React.FC<ChopLogicModalProps>;
-export default ChopLogicModal;
+declare const ChopLogicDialog: React.FC<ChopLogicModalProps>;
+export default ChopLogicDialog;

package/dist/components/{modal/__docs__/Modal.stories.d.ts → modals/dialog/__docs__/Dialog.stories.d.ts}

@@ -1,4 +1,4 @@
-import { default as Example } from './Example';
+import { default as Example } from './DialogExample';
 import { Meta, StoryObj } from '@storybook/react';
 
 declare const meta: Meta<typeof Example>;

package/dist/components/{modal/__docs__/Example.d.ts → modals/dialog/__docs__/DialogExample.d.ts}

@@ -1,4 +1,4 @@
-import { ChopLogicModalProps } from '../Modal';
+import { ChopLogicModalProps } from '../Dialog';
 import { default as React } from 'react';
 
 declare const Example: React.FC<ChopLogicModalProps>;

package/dist/components/{modal → modals/dialog}/elements/Header.d.ts

@@ -4,5 +4,5 @@ type ChopLogicModalLayoutHeaderProps = {
     title: string;
     onClose: () => void;
 };
-declare const ChopLogicModalLayoutHeader: ({ title, onClose }: ChopLogicModalLayoutHeaderProps) => React.ReactElement;
+declare const ChopLogicModalLayoutHeader: React.FC<ChopLogicModalLayoutHeaderProps>;
 export default ChopLogicModalLayoutHeader;

package/dist/components/{modal → modals/dialog}/elements/Layout.d.ts

@@ -5,5 +5,5 @@ type ModalLayoutProps = PropsWithChildren & React.HTMLAttributes<HTMLDivElement>
     onClose: () => void;
     isOpened: boolean;
 };
-declare const ChopLogicModalLayout: ({ title, onClose, isOpened, children, ...rest }: ModalLayoutProps) => React.ReactElement;
+declare const ChopLogicModalLayout: React.FC<ModalLayoutProps>;
 export default ChopLogicModalLayout;

package/dist/components/modals/tooltip/Tooltip.d.ts

@@ -0,0 +1,10 @@
+import { PropsWithChildren } from 'react';
+
+export type ChopLogicTooltipProps = PropsWithChildren & React.HTMLAttributes<HTMLElement> & {
+    tooltipContent: string | React.ReactElement;
+    id: string;
+    containerTag?: 'span' | 'div' | 'p' | 'strong' | 'em';
+    visibleOn?: 'hover' | 'click' | 'focus' | 'contextmenu';
+};
+declare const ChopLogicTooltip: React.FC<ChopLogicTooltipProps>;
+export default ChopLogicTooltip;

package/dist/components/modals/tooltip/__docs__/Tooltip.stories.d.ts

@@ -0,0 +1,10 @@
+import { default as TooltipExample } from './TooltipExample';
+import { Meta, StoryObj } from '@storybook/react';
+
+declare const meta: Meta<typeof TooltipExample>;
+export default meta;
+type Story = StoryObj<typeof TooltipExample>;
+export declare const Default: Story;
+export declare const ClickToShow: Story;
+export declare const FocusToShow: Story;
+export declare const ContextMenuToShow: Story;

package/dist/components/modals/tooltip/__docs__/TooltipExample.d.ts

@@ -0,0 +1,5 @@
+import { ChopLogicTooltipProps } from '../Tooltip';
+import { default as React } from 'react';
+
+declare const TooltipExample: React.FC<ChopLogicTooltipProps>;
+export default TooltipExample;

package/dist/components/modals/tooltip/__tests__/Tooltip.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/hooks/__tests__/use-window-dimensions.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/hooks/index.d.ts

@@ -2,3 +2,6 @@ export { useMount } from './use-mount';
 export { useClickOutside } from './use-click-outside';
 export { useModalFocusTrap } from './use-modal-focus-trap';
 export { useKeyPress } from './use-key-press';
+export { useContainerDimensions } from './use-container-dimensions';
+export { useWindowDimensions } from './use-window-dimensions';
+export { useTooltipPosition } from './use-tooltip-position';

package/dist/hooks/use-click-outside.d.ts

@@ -5,13 +5,5 @@ type UseClickOutsideParams = {
     onClickOutsideHandler: () => void;
     dependentRef?: React.RefObject<HTMLDivElement>;
 };
-/**
- * Custom hook that triggers a callback when a click event occurs outside specified elements.
- *
- * @param {UseClickOutsideParams} ref - Reference to the main element to check if the click is outside
- * @param {UseClickOutsideParams} onClickOutsideHandler - Callback function to execute when a click event occurs outside
- * @param {UseClickOutsideParams} dependentRef - Reference to a dependent element to check if the click is outside
- * @return {void} Function does not return anything
- */
 export declare const useClickOutside: ({ ref, onClickOutsideHandler, dependentRef }: UseClickOutsideParams) => void;
 export {};

package/dist/hooks/use-container-dimensions.d.ts

@@ -0,0 +1,8 @@
+import { Dimensions } from './use-window-dimensions';
+
+type useContainerDimensionsParams = {
+    ref: React.RefObject<HTMLDivElement | HTMLSpanElement>;
+    isVisible?: boolean;
+};
+export declare const useContainerDimensions: ({ ref, isVisible }: useContainerDimensionsParams) => Dimensions;
+export {};

package/dist/hooks/use-key-press.d.ts

@@ -5,14 +5,5 @@ type useKeyPressParams = {
     ref: React.RefObject<HTMLDivElement>;
     onKeyPress: () => void;
 };
-/**
- * Hook that listens for a specific key press event and triggers an action when the key is pressed.
- *
- * @param {Object} params - An object containing the following properties:
- *   - ref: A ref object that refers to the HTML element to attach the event listener to.
- *   - keyCode: The key code of the key to listen for.
- *   - onKeyPress: A function to be called when the key is pressed.
- * @return {void} This hook does not return anything.
- */
 export declare const useKeyPress: ({ ref, keyCode, onKeyPress }: useKeyPressParams) => void;
 export {};

package/dist/hooks/use-modal-focus-trap.d.ts

@@ -2,13 +2,5 @@ type ModalFocusTrapParams = {
     modalRef: React.RefObject<HTMLDivElement>;
     isOpened: boolean;
 };
-/**
- * Traps the focus within a modal element when it is opened.
- *
- * @param {ModalFocusTrapParams} params - An object containing the modal reference and a boolean indicating whether the modal is opened.
- * @param {React.RefObject<HTMLDivElement>} params.modalRef - A reference to the modal element.
- * @param {boolean} params.isOpened - A boolean indicating whether the modal is opened.
- * @return {void} This function does not return anything.
- */
 export declare const useModalFocusTrap: ({ modalRef, isOpened }: ModalFocusTrapParams) => void;
 export {};

package/dist/hooks/use-mount.d.ts

@@ -1,8 +1 @@
-/**
- * Custom hook that manages the mounting state based on the isOpened prop and a delay.
- *
- * @param {boolean} isOpened - Indicates if the component is opened.
- * @param {number} [delay=300] - The delay in milliseconds before unmounting.
- * @return {boolean} The current state of mounting.
- */
 export declare const useMount: (isOpened: boolean, delay?: number) => boolean;

package/dist/hooks/use-tooltip-position.d.ts

@@ -0,0 +1,11 @@
+type useTooltipPositionParams = {
+    wrapperRef: React.RefObject<HTMLSpanElement | HTMLDivElement>;
+    tooltipRef: React.RefObject<HTMLSpanElement | HTMLDivElement>;
+    isOpened: boolean;
+    spacing?: number;
+};
+export declare const useTooltipPosition: ({ wrapperRef, tooltipRef, isOpened, spacing }: useTooltipPositionParams) => {
+    top: number;
+    left: number;
+};
+export {};

package/dist/hooks/use-window-dimensions.d.ts

@@ -0,0 +1,5 @@
+export type Dimensions = {
+    width: number;
+    height: number;
+};
+export declare function useWindowDimensions(): Dimensions;