@julseb-lib/react 1.1.33 → 1.1.34

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { c as LibColorsHover, af as CssTextAlign, L as LibColors, a as LibColorsShort, b as LibAllColors, e as LibOverlays, f as LibAllColorsAndOverlays, k as LibSpacers, ak as CssAlignContent, ai as CssAlignItems, aj as CssJustifyContent, ah as CssJustifyItems, E as LibMaxWidth, l as LibRadiuses, an as CssObjectFit, u as LibButtonVariantExtended, j as LibShadows, ag as CssVerticalAlign, h as LibFontSizes, i as LibFontWeights, ad as DispatchState, a5 as TranslateLang, aa as ReactChildren, p as LibThemeNames, ac as FC$1, a7 as LibCountry, ab as ReactElement, s as LibLoaderVariant } from './global-CXiIaXyy.cjs';
-export { av as designTokens } from './global-CXiIaXyy.cjs';
+import { c as LibColorsHover, af as CssTextAlign, L as LibColors, a as LibColorsShort, b as LibAllColors, e as LibOverlays, f as LibAllColorsAndOverlays, k as LibSpacers, ak as CssAlignContent, ai as CssAlignItems, aj as CssJustifyContent, ah as CssJustifyItems, E as LibMaxWidth, l as LibRadiuses, an as CssObjectFit, u as LibButtonVariantExtended, j as LibShadows, ag as CssVerticalAlign, h as LibFontSizes, i as LibFontWeights, ad as DispatchState, a5 as TranslateLang, aa as ReactChildren, p as LibThemeNames, ac as FC$1, a7 as LibCountry, ab as ReactElement, s as LibLoaderVariant } from './global-BFS193oO.cjs';
+export { av as designTokens } from './global-BFS193oO.cjs';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { ClassNameValue } from 'tailwind-merge';
 import { LibMdEditorOptions } from './types/components-items-props.cjs';
@@ -15,35 +15,209 @@ import 'fuse.js';
 import 'prism-react-renderer';
 import './types/require-at-least-one.cjs';
 
+/**
+ * Regular expression to match URLs in a string.
+ * Matches HTTP/HTTPS URLs with optional www, ports, and paths.
+ *
+ * @type {RegExp}
+ */
 declare const URL_REGEX: RegExp;
+/**
+ * Splits a string into words and wraps detected URLs in anchor tags, optionally opening them in a new tab.
+ *
+ * @param {string} text - The input text to linkify.
+ * @param {boolean} [blank] - If true, links open in a new tab.
+ * @returns {Array<JSX.Element | string>} Array of JSX elements and strings with URLs linkified.
+ *
+ * @example
+ * linkifyText("Visit https://example.com", true)
+ */
 declare const linkifyText: (text: string, blank?: boolean) => (string | react_jsx_runtime.JSX.Element)[];
 
+/**
+ * Maps color tokens to Tailwind CSS classes for styling anchor tags (`<a>`) with color, hover, and active states.
+ *
+ * @type {Record<LibColorsHover, string>}
+ * @example
+ * genLinkColor.primary // "[&_a]:font-black [&_a]:text-primary-500 [&_a]:hover:text-primary-300 [&_a]:active:text-primary-600"
+ */
 declare const genLinkColor: Record<LibColorsHover, string>;
+/**
+ * Maps color tokens to Tailwind CSS classes for styling button tags (`<button>`) with color, hover, and active states.
+ *
+ * @type {Record<LibColorsHover, string>}
+ * @example
+ * genButtonColor.secondary // "[&_button]:font-black [&_button]:text-secondary-500 [&_button]:hover:text-secondary-300 [&_button]:active:text-secondary-600"
+ */
 declare const genButtonColor: Record<LibColorsHover, string>;
 
+/**
+ * Maps CSS `text-align` values to their corresponding Tailwind CSS text alignment utility classes.
+ *
+ * @type {Record<CssTextAlign, string>}
+ * @example
+ * genTextAlign.center // "text-center"
+ */
 declare const genTextAlign: Record<CssTextAlign, string>;
 
+/**
+ * Maps color tokens to their corresponding Tailwind CSS text color utility classes.
+ *
+ * @type {Record<LibColors, string>}
+ * @example
+ * genTextColor["primary-500"] // "text-primary-500"
+ */
 declare const genTextColor: Record<LibColors, string>;
+/**
+ * Maps shorthand color tokens to their corresponding Tailwind CSS text color utility classes (uses the 500 shade).
+ *
+ * @type {Record<LibColorsShort, string>}
+ * @example
+ * genTextColorShort.primary // "text-primary-500"
+ */
 declare const genTextColorShort: Record<LibColorsShort, string>;
+/**
+ * Maps color tokens to Tailwind CSS text color utility classes with hover and active states.
+ *
+ * @type {Record<LibColorsHover, string>}
+ * @example
+ * genTextColorHover.danger // "text-danger-500 hover:text-danger-300 active:text-danger-600"
+ */
 declare const genTextColorHover: Record<LibColorsHover, string>;
+/**
+ * Combined map of all color tokens (full and shorthand) to their Tailwind CSS text color utility classes.
+ *
+ * @type {Record<LibAllColors, string>}
+ * @example
+ * genTextAllColor.primary // "text-primary-500"
+ * genTextAllColor["primary-100"] // "text-primary-100"
+ */
 declare const genTextAllColor: Record<LibAllColors, string>;
 
+/**
+ * Maps all library color tokens to their corresponding Tailwind CSS `bg-` classes.
+ *
+ * @type {Record<LibColors, string>}
+ * @example
+ * genBgColor["primary-500"] // "bg-primary-500"
+ */
 declare const genBgColor: Record<LibColors, string>;
+/**
+ * Maps shorthand color names to their Tailwind CSS `bg-` classes (uses the 500 shade).
+ *
+ * @type {Record<LibColorsShort, string>}
+ * @example
+ * genBgColorShort.primary // "bg-primary-500"
+ */
 declare const genBgColorShort: Record<LibColorsShort, string>;
+/**
+ * Maps shorthand color names to their lightest (50 shade) Tailwind CSS `bg-` classes.
+ *
+ * @type {Record<Exclude<LibColorsShort, "black" | "transparent" | "background" | "current">, string>}
+ * @example
+ * genBgColor50.primary // "bg-primary-50"
+ */
 declare const genBgColor50: Record<Exclude<LibColorsShort, "black" | "transparent" | "background" | "current">, string>;
+/**
+ * Maps hover color names to Tailwind CSS `bg-` classes with hover and active states.
+ *
+ * @type {Record<LibColorsHover, string>}
+ * @example
+ * genBgColorHover.primary // "bg-primary-500 hover:bg-primary-300 active:bg-primary-600"
+ */
 declare const genBgColorHover: Record<LibColorsHover, string>;
+/**
+ * Maps ghost-style hover color names to Tailwind CSS `bg-` classes with hover and active states (lighter shades).
+ *
+ * @type {Record<LibColorsHover, string>}
+ * @example
+ * genBgColorGhostHover.primary // "bg-primary-50 hover:bg-primary-300 active:bg-primary-100"
+ */
 declare const genBgColorGhostHover: Record<LibColorsHover, string>;
+/**
+ * Maps overlay tokens to their Tailwind CSS `bg-overlay-` classes.
+ *
+ * @type {Record<LibOverlays, string>}
+ * @example
+ * genBgOverlay["black-50"] // "bg-overlay-black-50"
+ */
 declare const genBgOverlay: Record<LibOverlays, string>;
+/**
+ * Combined map of all color tokens (full and shorthand) to their Tailwind CSS `bg-` classes.
+ *
+ * @type {Record<LibAllColors, string>}
+ * @example
+ * genBgAllColors.primary // "bg-primary-500"
+ * genBgAllColors["primary-100"] // "bg-primary-100"
+ */
 declare const genBgAllColors: Record<LibAllColors, string>;
+/**
+ * Combined map of all color and overlay tokens to their Tailwind CSS `bg-` classes.
+ *
+ * @type {Record<LibAllColorsAndOverlays, string>}
+ * @example
+ * genBgAllColorsAndOverlays.primary // "bg-primary-500"
+ * genBgAllColorsAndOverlays["black-50"] // "bg-overlay-black-50"
+ */
 declare const genBgAllColorsAndOverlays: Record<LibAllColorsAndOverlays, string>;
 
+/**
+ * Maps all library color tokens to their corresponding Tailwind CSS `border-` classes.
+ *
+ * @type {Record<LibColors, string>}
+ * @example
+ * genBorderColor["primary-500"] // "border-primary-500"
+ */
 declare const genBorderColor: Record<LibColors, string>;
+/**
+ * Maps shorthand color names to their Tailwind CSS `border-` classes (uses the 500 shade).
+ *
+ * @type {Record<LibColorsShort, string>}
+ * @example
+ * genBorderColorShort.primary // "border-primary-500"
+ */
 declare const genBorderColorShort: Record<LibColorsShort, string>;
+/**
+ * Maps hover color names to Tailwind CSS `border-` classes with hover and active states.
+ *
+ * @type {Record<LibColorsHover, string>}
+ * @example
+ * genBorderColorHover.primary // "border-primary-500 hover:border-primary-300 active:border-primary-600"
+ */
 declare const genBorderColorHover: Record<LibColorsHover, string>;
+/**
+ * Combined map of all color tokens (full and shorthand) to their Tailwind CSS `border-` classes.
+ *
+ * @type {Record<LibAllColors, string>}
+ * @example
+ * genBorderAllColors.primary // "border-primary-500"
+ * genBorderAllColors["primary-100"] // "border-primary-100"
+ */
 declare const genBorderAllColors: Record<LibAllColors, string>;
 
+/**
+ * Maps spacing tokens to their corresponding Tailwind CSS gap utility classes.
+ *
+ * @type {Record<LibSpacers, string>}
+ * @example
+ * genGap.lg // "gap-6"
+ */
 declare const genGap: Record<LibSpacers, string>;
+/**
+ * Maps spacing tokens to their corresponding Tailwind CSS row gap utility classes.
+ *
+ * @type {Record<LibSpacers, string>}
+ * @example
+ * genRowGap.md // "gap-y-4"
+ */
 declare const genRowGap: Record<LibSpacers, string>;
+/**
+ * Maps spacing tokens to their corresponding Tailwind CSS column gap utility classes.
+ *
+ * @type {Record<LibSpacers, string>}
+ * @example
+ * genColGap.sm // "gap-x-3"
+ */
 declare const genColGap: Record<LibSpacers, string>;
 
 /**
@@ -53,33 +227,126 @@ declare const genColGap: Record<LibSpacers, string>;
  */
 declare const clsx: (...classes: Array<ClassNameValue>) => string;
 
+/**
+ * Maps CSS `align-content` values to their corresponding Tailwind CSS utility classes.
+ *
+ * @type {Record<CssAlignContent, string>}
+ * @example
+ * genAlignContent.center // "content-center"
+ */
 declare const genAlignContent: Record<CssAlignContent, string>;
+/**
+ * Maps CSS `align-items` values to their corresponding Tailwind CSS utility classes.
+ *
+ * @type {Record<CssAlignItems, string>}
+ * @example
+ * genAlignItems.center // "items-center"
+ */
 declare const genAlignItems: Record<CssAlignItems, string>;
 
+/**
+ * Maps CSS `justify-content` values to their corresponding Tailwind CSS utility classes.
+ *
+ * @type {Record<CssJustifyContent, string>}
+ * @example
+ * genJustifyContent.center // "justify-center"
+ */
 declare const genJustifyContent: Record<CssJustifyContent, string>;
+/**
+ * Maps CSS `justify-items` values to their corresponding Tailwind CSS utility classes.
+ *
+ * @type {Record<CssJustifyItems, string>}
+ * @example
+ * genJustifyItems.end // "justify-items-end"
+ */
 declare const genJustifyItems: Record<CssJustifyItems, string>;
 
+/**
+ * Maps max-width tokens to their corresponding Tailwind CSS max-width utility classes.
+ *
+ * @type {Record<LibMaxWidth, string>}
+ * @example
+ * genMaxWidth.lg // "max-w-lg"
+ */
 declare const genMaxWidth: Record<LibMaxWidth, string>;
 
+/**
+ * Maps each LibRadiuses key to its corresponding Tailwind CSS border-radius class.
+ *
+ * @type {Record<LibRadiuses, string>}
+ * @example
+ * genBorderRadius.sm // "rounded-sm"
+ */
 declare const genBorderRadius: Record<LibRadiuses, string>;
 
+/**
+ * Maps CSS `object-fit` values to their corresponding Tailwind CSS object-fit utility classes.
+ *
+ * @type {Record<CssObjectFit, string>}
+ * @example
+ * genObjectFit.cover // "object-cover"
+ */
 declare const genObjectFit: Record<CssObjectFit, string>;
 
+/**
+ * Maps button variant names to their corresponding Tailwind CSS classes for the disabled state.
+ *
+ * @type {Record<LibButtonVariantExtended, string>}
+ * @example
+ * genButtonDisabled.plain // "disabled:bg-gray-200 disabled:hover:bg-gray-200 disabled:text-gray-500!"
+ */
 declare const genButtonDisabled: Record<LibButtonVariantExtended, string>;
 
+/**
+ * Maps each LibShadows key to its corresponding Tailwind CSS box-shadow utility class.
+ *
+ * @type {Record<LibShadows, string>}
+ * @example
+ * genBoxShadow.md // "shadow-md"
+ */
 declare const genBoxShadow: Record<LibShadows, string>;
 
+/**
+ * Maps CSS `vertical-align` values to their corresponding Tailwind CSS vertical alignment utility classes.
+ *
+ * @type {Record<CssVerticalAlign, string>}
+ * @example
+ * genVAlign["align-middle"] // "align-middle"
+ */
 declare const genVAlign: Record<CssVerticalAlign, string>;
 
+/**
+ * Custom React components mapping for rendering Markdown elements using the library's Text and Table components.
+ *
+ * @type {Components}
+ * @example
+ * // Usage with react-markdown
+ * <ReactMarkdown components={libMarkdownComponents} />
+ */
 declare const libMarkdownComponents: Components;
+/**
+ * Default options for the Markdown editor, enabling or disabling formatting features.
+ *
+ * @type {LibMdEditorOptions}
+ * @example
+ * libMarkdownEditorOptions.bold // true
+ */
 declare const libMarkdownEditorOptions: LibMdEditorOptions;
 
 /**
- * Maps each color variant to its corresponding Tailwind focus ring classes.
+ * Maps each color variant to its corresponding Tailwind CSS focus ring utility classes.
+ *
+ * @type {Record<LibColorsHover, string>}
+ * @example
+ * genRingColor.primary // "focus:ring-1 focus:ring-primary-800"
  */
 declare const genRingColor: Record<LibColorsHover, string>;
 /**
- * Maps each color variant to its corresponding Tailwind focus ring classes, applied to child elements via the `[&>*]` selector.
+ * Maps each color variant to its corresponding Tailwind CSS focus ring utility classes, applied to child elements via the `[&>*]` selector.
+ *
+ * @type {Record<LibColorsHover, string>}
+ * @example
+ * genRingColorChildren.success // "[&>*]:focus:ring-1 [&>*]:focus:ring-success-800"
  */
 declare const genRingColorChildren: Record<LibColorsHover, string>;
 
@@ -165,8 +432,23 @@ declare function enableScroll(): void;
  */
 declare function scrollToTop(): void;
 
+/**
+ * Maps font size tokens to their corresponding Tailwind CSS text-size utility classes or custom property-based classes.
+ *
+ * @type {Record<LibFontSizes, string>}
+ * @example
+ * genFontSize.xl // "text-xl"
+ * genFontSize["display-h1"] // "text-(length:--text-display-h1)"
+ */
 declare const genFontSize: Record<LibFontSizes, string>;
 
+/**
+ * Maps font weight tokens to their corresponding Tailwind CSS font-weight utility classes.
+ *
+ * @type {Record<LibFontWeights, string>}
+ * @example
+ * genFontWeight.bold // "font-bold"
+ */
 declare const genFontWeight: Record<LibFontWeights, string>;
 
 /**