@sohanemon/utils 4.0.29 → 4.0.31

package/dist/functions/index.d.ts

@@ -1,8 +1,55 @@
+/**
+ * Utility to merge class names with Tailwind CSS and additional custom merging logic.
+ *
+ * @param {...ClassValue[]} inputs - Class names to merge.
+ * @returns {string} - A string of merged class names.
+ */
 import { type ClassValue } from 'clsx';
 import type * as React from 'react';
 export * from './cookie';
 export declare function cn(...inputs: ClassValue[]): string;
+/**
+ * @deprecated Use isLinkActive instead.
+ *
+ * Determines if a navigation link is active based on the current path.
+ *
+ * @param  href - The target URL.
+ * @param  path - The current browser path.
+ * @returns - True if the navigation is active, false otherwise.
+ */
 export declare function isNavActive(href: string, path: string): boolean;
+/**
+ * Checks if a link is active, considering optional localization prefixes.
+ *
+ * @param {Object} params - Parameters object.
+ * @param {string} params.path - The target path of the link.
+ * @param {string} params.currentPath - The current browser path.
+ * @param {string[]} [params.locales=['en', 'es', 'de', 'zh', 'bn', 'fr', 'it', 'nl']] - Supported locale prefixes.
+ * @returns {boolean} - True if the link is active, false otherwise.
+ */
+export declare function isLinkActive({ path, currentPath, locales, }: {
+    path: string;
+    currentPath: string;
+    locales?: string[];
+}): boolean;
+/**
+ * Cleans a file path by removing the `/public/` prefix if present.
+ *
+ * @param  src - The source path to clean.
+ * @returns - The cleaned path.
+ */
 export declare function cleanSrc(src: string): string;
+/**
+ * Smoothly scrolls to the top or bottom of a specified container.
+ *
+ * @param  containerSelector - The CSS selector or React ref for the container.
+ * @param  to - Specifies whether to scroll to the top or bottom.
+ */
 export declare const scrollTo: (containerSelector: string | React.RefObject<HTMLDivElement>, to: "top" | "bottom") => void;
+/**
+ * Copies a given string to the clipboard.
+ *
+ * @param  value - The value to copy to the clipboard.
+ * @param  [onSuccess=() => {}] - Optional callback executed after successful copy.
+ */
 export declare const copyToClipboard: (value: string, onSuccess?: () => void) => void;

package/dist/functions/index.js

@@ -1,3 +1,9 @@
+/**
+ * Utility to merge class names with Tailwind CSS and additional custom merging logic.
+ *
+ * @param {...ClassValue[]} inputs - Class names to merge.
+ * @returns {string} - A string of merged class names.
+ */
 import { clsx } from 'clsx';
 import { extendTailwindMerge } from 'tailwind-merge';
 import { withFluid } from '@fluid-tailwind/tailwind-merge';
@@ -6,15 +12,57 @@ export function cn(...inputs) {
     const twMerge = extendTailwindMerge(withFluid);
     return twMerge(clsx(inputs));
 }
+/**
+ * @deprecated Use isLinkActive instead.
+ *
+ * Determines if a navigation link is active based on the current path.
+ *
+ * @param  href - The target URL.
+ * @param  path - The current browser path.
+ * @returns - True if the navigation is active, false otherwise.
+ */
 export function isNavActive(href, path) {
-    const regex = new RegExp(`^\/?${href}(\/|$)`);
+    console.warn('isNavActive is deprecated. Use isLinkActive instead.');
+    const regex = new RegExp(`^/?${href}(/|$)`);
     return regex.test(path);
 }
+/**
+ * Checks if a link is active, considering optional localization prefixes.
+ *
+ * @param {Object} params - Parameters object.
+ * @param {string} params.path - The target path of the link.
+ * @param {string} params.currentPath - The current browser path.
+ * @param {string[]} [params.locales=['en', 'es', 'de', 'zh', 'bn', 'fr', 'it', 'nl']] - Supported locale prefixes.
+ * @returns {boolean} - True if the link is active, false otherwise.
+ */
+export function isLinkActive({ path, currentPath, locales = ['en', 'es', 'de', 'zh', 'bn', 'fr', 'it', 'nl'], }) {
+    const localeRegex = new RegExp(`^/?(${locales.join('|')})/`);
+    const normalizePath = (p) => {
+        return p
+            .replace(localeRegex, '') // Remove localization prefix (e.g., en/, fr/, etc.)
+            .replace(/^\/+|\/+$/g, ''); // Trim leading and trailing slashes
+    };
+    const normalizedPath = normalizePath(path);
+    const normalizedCurrentPath = normalizePath(currentPath);
+    return normalizedPath === normalizedCurrentPath;
+}
+/**
+ * Cleans a file path by removing the `/public/` prefix if present.
+ *
+ * @param  src - The source path to clean.
+ * @returns - The cleaned path.
+ */
 export function cleanSrc(src) {
     if (src.includes('/public/'))
         return src.replace('/public/', '/');
     return src;
 }
+/**
+ * Smoothly scrolls to the top or bottom of a specified container.
+ *
+ * @param  containerSelector - The CSS selector or React ref for the container.
+ * @param  to - Specifies whether to scroll to the top or bottom.
+ */
 export const scrollTo = (containerSelector, to) => {
     let container;
     if (typeof containerSelector === 'string') {
@@ -33,6 +81,12 @@ export const scrollTo = (containerSelector, to) => {
         });
     }
 };
+/**
+ * Copies a given string to the clipboard.
+ *
+ * @param  value - The value to copy to the clipboard.
+ * @param  [onSuccess=() => {}] - Optional callback executed after successful copy.
+ */
 export const copyToClipboard = (value, onSuccess = () => { }) => {
     if (typeof window === 'undefined' || !navigator.clipboard?.writeText) {
         return;

package/dist/index.d.ts

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

package/dist/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sohanemon/utils",
-  "version": "4.0.29",
+  "version": "4.0.31",
   "author": "Sohan Emon <sohanemon@outlook.com>",
   "description": "",
   "type": "module",