@julseb-lib/react 1.0.5 → 1.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -3056,26 +3056,28 @@ declare const Drawer: FC$1<ILibDrawer>;
3056
3056
  * </nav>
3057
3057
  * </Header>
3058
3058
  *
3059
- * @extends HTMLDivElement
3059
+ * @extends ILibHeader
3060
3060
  *
3061
3061
  * @prop {string} [props.className] - Additional CSS classes to apply to the header container.
3062
- * @prop {React.ElementType} [props.element="header"] - HTML element type to render as the container.
3062
+ * @prop {React.ElementType} [props.element="header"] - HTML element type to render as the container. Default: "header".
3063
3063
  * @prop {React.Ref<HTMLDivElement>} [props.ref] - Ref to the header element.
3064
- * @prop {React.ReactNode} [props.logo] - Logo content to display in the header.
3065
- * @prop {"left" | "right"} [props.burgerPosition="right"] - Position of the burger menu button.
3066
- * @prop {LibColorsHover | object} [props.burgerColor="white"] - Color for the burger menu button, can be a single color or object with open/closed states.
3067
3064
  * @prop {React.ReactNode} [props.children] - Content to display in the navigation area.
3068
- * @prop {"left" | "right"} [props.navDesktopPosition="right"] - Position of the navigation on desktop screens.
3069
- * @prop {"drawer" | "fullscreen"} [props.navMobileVariant="drawer"] - Variant for mobile navigation display.
3065
+ * @prop {React.ReactNode} [props.logo] - Logo content to display in the header.
3066
+ * @prop {"left" | "right"} [props.burgerPosition="right"] - Position of the burger menu button. Possible values: "left", "right". Default: "right".
3067
+ * @prop {LibColorsHover | { open: LibColorsHover; closed: LibColorsHover }} [props.burgerColor="white"] - Color for the burger menu button, can be a single color or object with open/closed states. Default: "white".
3068
+ * @prop {"left" | "right"} [props.navDesktopPosition="right"] - Position of the navigation on desktop screens. Possible values: "left", "right". Default: "right".
3069
+ * @prop {"drawer" | "full" | "top"} [props.navMobileVariant="drawer"] - Variant for mobile navigation display. Possible values: "drawer", "full", "top". Default: "drawer".
3070
3070
  * @prop {boolean} [props.enableScrollingOpen] - Whether to allow page scrolling when mobile menu is open.
3071
3071
  * @prop {React.ReactNode} [props.search] - Search component to display in the header.
3072
- * @prop {"relative" | "absolute" | "fixed"} [props.position="relative"] - CSS position property for the header.
3072
+ * @prop {"relative" | "absolute" | "fixed"} [props.position="relative"] - CSS position property for the header. Possible values: "relative", "absolute", "fixed". Default: "relative".
3073
3073
  * @prop {boolean | number} [props.hideOnScroll] - Whether to hide header on scroll, or scroll threshold in pixels.
3074
3074
  * @prop {Array<React.ReactNode>} [props.links] - Array of link elements for navigation.
3075
3075
  * @prop {React.ReactNode} [props.nav] - Navigation content to display.
3076
- * @prop {LibAllColors} [props.backgroundColor="primary"] - Background color for the header.
3077
- * @prop {LibAllColors} [props.textColor="white"] - Text color for header content.
3078
- * @prop {LibColorsHover} [props.linksColor="white"] - Color for navigation links.
3076
+ * @prop {LibAllColors} [props.backgroundColor="primary"] - Background color for the header. Default: "primary".
3077
+ * @prop {LibAllColors} [props.navMobileBackground=backgroundColor] - Background color for mobile navigation. Default: backgroundColor value.
3078
+ * @prop {LibAllColors} [props.textColor="white"] - Text color for header content. Default: "white".
3079
+ * @prop {LibColorsHover} [props.linksColor="white"] - Color for navigation links. Default: "white".
3080
+ * @prop {LibAllColors} [props.headerOpenMobileBackground=backgroundColor] - Background color when mobile menu is open. Default: backgroundColor value.
3079
3081
  *
3080
3082
  * @returns {JSX.Element} The rendered Header component.
3081
3083
  *
@@ -3137,6 +3139,8 @@ declare const Footer: FC$1<ILibFooter>;
3137
3139
  * url="https://mywebsite.com"
3138
3140
  * />
3139
3141
  *
3142
+ * @extends ILibMeta
3143
+ *
3140
3144
  * @prop {React.ReactNode} [props.children] - Additional meta tags or head elements to include.
3141
3145
  * @prop {string} [props.title] - Page title for the document and social media.
3142
3146
  * @prop {string} [props.favicon] - URL path to the favicon icon file.
@@ -3146,7 +3150,7 @@ declare const Footer: FC$1<ILibFooter>;
3146
3150
  * @prop {string} [props.author] - Author name for the page content.
3147
3151
  * @prop {string} [props.authorUrl] - URL to the author's profile or website.
3148
3152
  * @prop {string} [props.publisher] - Publisher name for the content.
3149
- * @prop {string} [props.type] - Open Graph type (e.g., "website", "article").
3153
+ * @prop {string} [props.type="website"] - Open Graph type. Possible values: "website", "article". Default: "website".
3150
3154
  * @prop {string} [props.cover] - URL to the cover image for social media sharing.
3151
3155
  * @prop {string} [props.siteName] - Name of the website or application.
3152
3156
  * @prop {string} [props.language] - Language locale code (e.g., "en-US").
@@ -3155,7 +3159,9 @@ declare const Footer: FC$1<ILibFooter>;
3155
3159
  * @prop {string} [props.creator] - Creator name for the content.
3156
3160
  * @prop {string} [props.manifest] - URL path to the web app manifest file.
3157
3161
  * @prop {string} [props.category] - Category classification for the content.
3158
- * @prop {string} [props.twitterCard] - Twitter Card type (e.g., "summary", "summary_large_image").
3162
+ * @prop {string} [props.twitterCard="summary"] - Twitter Card type. Possible values: "summary", "summary_large_image". Default: "summary".
3163
+ * @prop {string} [props.appleTouchIcon] - URL path to the Apple touch icon file.
3164
+ * @prop {string} [props.themeColor] - Theme color for the browser interface.
3159
3165
  *
3160
3166
  * @returns {JSX.Element} The rendered Meta component with HTML head elements.
3161
3167
  *
package/dist/index.d.ts CHANGED
@@ -3056,26 +3056,28 @@ declare const Drawer: FC$1<ILibDrawer>;
3056
3056
  * </nav>
3057
3057
  * </Header>
3058
3058
  *
3059
- * @extends HTMLDivElement
3059
+ * @extends ILibHeader
3060
3060
  *
3061
3061
  * @prop {string} [props.className] - Additional CSS classes to apply to the header container.
3062
- * @prop {React.ElementType} [props.element="header"] - HTML element type to render as the container.
3062
+ * @prop {React.ElementType} [props.element="header"] - HTML element type to render as the container. Default: "header".
3063
3063
  * @prop {React.Ref<HTMLDivElement>} [props.ref] - Ref to the header element.
3064
- * @prop {React.ReactNode} [props.logo] - Logo content to display in the header.
3065
- * @prop {"left" | "right"} [props.burgerPosition="right"] - Position of the burger menu button.
3066
- * @prop {LibColorsHover | object} [props.burgerColor="white"] - Color for the burger menu button, can be a single color or object with open/closed states.
3067
3064
  * @prop {React.ReactNode} [props.children] - Content to display in the navigation area.
3068
- * @prop {"left" | "right"} [props.navDesktopPosition="right"] - Position of the navigation on desktop screens.
3069
- * @prop {"drawer" | "fullscreen"} [props.navMobileVariant="drawer"] - Variant for mobile navigation display.
3065
+ * @prop {React.ReactNode} [props.logo] - Logo content to display in the header.
3066
+ * @prop {"left" | "right"} [props.burgerPosition="right"] - Position of the burger menu button. Possible values: "left", "right". Default: "right".
3067
+ * @prop {LibColorsHover | { open: LibColorsHover; closed: LibColorsHover }} [props.burgerColor="white"] - Color for the burger menu button, can be a single color or object with open/closed states. Default: "white".
3068
+ * @prop {"left" | "right"} [props.navDesktopPosition="right"] - Position of the navigation on desktop screens. Possible values: "left", "right". Default: "right".
3069
+ * @prop {"drawer" | "full" | "top"} [props.navMobileVariant="drawer"] - Variant for mobile navigation display. Possible values: "drawer", "full", "top". Default: "drawer".
3070
3070
  * @prop {boolean} [props.enableScrollingOpen] - Whether to allow page scrolling when mobile menu is open.
3071
3071
  * @prop {React.ReactNode} [props.search] - Search component to display in the header.
3072
- * @prop {"relative" | "absolute" | "fixed"} [props.position="relative"] - CSS position property for the header.
3072
+ * @prop {"relative" | "absolute" | "fixed"} [props.position="relative"] - CSS position property for the header. Possible values: "relative", "absolute", "fixed". Default: "relative".
3073
3073
  * @prop {boolean | number} [props.hideOnScroll] - Whether to hide header on scroll, or scroll threshold in pixels.
3074
3074
  * @prop {Array<React.ReactNode>} [props.links] - Array of link elements for navigation.
3075
3075
  * @prop {React.ReactNode} [props.nav] - Navigation content to display.
3076
- * @prop {LibAllColors} [props.backgroundColor="primary"] - Background color for the header.
3077
- * @prop {LibAllColors} [props.textColor="white"] - Text color for header content.
3078
- * @prop {LibColorsHover} [props.linksColor="white"] - Color for navigation links.
3076
+ * @prop {LibAllColors} [props.backgroundColor="primary"] - Background color for the header. Default: "primary".
3077
+ * @prop {LibAllColors} [props.navMobileBackground=backgroundColor] - Background color for mobile navigation. Default: backgroundColor value.
3078
+ * @prop {LibAllColors} [props.textColor="white"] - Text color for header content. Default: "white".
3079
+ * @prop {LibColorsHover} [props.linksColor="white"] - Color for navigation links. Default: "white".
3080
+ * @prop {LibAllColors} [props.headerOpenMobileBackground=backgroundColor] - Background color when mobile menu is open. Default: backgroundColor value.
3079
3081
  *
3080
3082
  * @returns {JSX.Element} The rendered Header component.
3081
3083
  *
@@ -3137,6 +3139,8 @@ declare const Footer: FC$1<ILibFooter>;
3137
3139
  * url="https://mywebsite.com"
3138
3140
  * />
3139
3141
  *
3142
+ * @extends ILibMeta
3143
+ *
3140
3144
  * @prop {React.ReactNode} [props.children] - Additional meta tags or head elements to include.
3141
3145
  * @prop {string} [props.title] - Page title for the document and social media.
3142
3146
  * @prop {string} [props.favicon] - URL path to the favicon icon file.
@@ -3146,7 +3150,7 @@ declare const Footer: FC$1<ILibFooter>;
3146
3150
  * @prop {string} [props.author] - Author name for the page content.
3147
3151
  * @prop {string} [props.authorUrl] - URL to the author's profile or website.
3148
3152
  * @prop {string} [props.publisher] - Publisher name for the content.
3149
- * @prop {string} [props.type] - Open Graph type (e.g., "website", "article").
3153
+ * @prop {string} [props.type="website"] - Open Graph type. Possible values: "website", "article". Default: "website".
3150
3154
  * @prop {string} [props.cover] - URL to the cover image for social media sharing.
3151
3155
  * @prop {string} [props.siteName] - Name of the website or application.
3152
3156
  * @prop {string} [props.language] - Language locale code (e.g., "en-US").
@@ -3155,7 +3159,9 @@ declare const Footer: FC$1<ILibFooter>;
3155
3159
  * @prop {string} [props.creator] - Creator name for the content.
3156
3160
  * @prop {string} [props.manifest] - URL path to the web app manifest file.
3157
3161
  * @prop {string} [props.category] - Category classification for the content.
3158
- * @prop {string} [props.twitterCard] - Twitter Card type (e.g., "summary", "summary_large_image").
3162
+ * @prop {string} [props.twitterCard="summary"] - Twitter Card type. Possible values: "summary", "summary_large_image". Default: "summary".
3163
+ * @prop {string} [props.appleTouchIcon] - URL path to the Apple touch icon file.
3164
+ * @prop {string} [props.themeColor] - Theme color for the browser interface.
3159
3165
  *
3160
3166
  * @returns {JSX.Element} The rendered Meta component with HTML head elements.
3161
3167
  *
package/dist/index.js CHANGED
@@ -69413,7 +69413,7 @@ var Header = ({
69413
69413
  links,
69414
69414
  nav,
69415
69415
  backgroundColor = "primary",
69416
- navMobileBackground,
69416
+ navMobileBackground = backgroundColor,
69417
69417
  textColor = "white",
69418
69418
  linksColor = "white",
69419
69419
  headerOpenMobileBackground = backgroundColor,
@@ -69462,14 +69462,15 @@ var Header = ({
69462
69462
  isMobile && /* @__PURE__ */ jsx366(HeaderSearch, { ...searchProps })
69463
69463
  ] }),
69464
69464
  className: clsx(
69465
- "z-999 flex gap-2 [&>a]:outline-none transition-all duration-200 ease-in-out",
69465
+ "z-999 flex gap-2 [&>a]:outline-none w-fit transition-all duration-200 ease-in-out",
69466
69466
  "fixed md:relative",
69467
69467
  "flex-col md:flex-row px-[5%] md:px-0",
69468
69468
  genRingColorChildren[linksColor],
69469
69469
  `${genBgAllColors[navMobileBackground ?? "primary-500"]} md:bg-transparent`,
69470
69470
  navDesktopPosition === "left" && "grow",
69471
69471
  navMobileVariant === "drawer" && [
69472
- "top-[56px] md:top-[unset] w-[70%] md:w-fit h-[calc(100svh-56px)] md:h-[unset]",
69472
+ "top-[56px] md:top-[unset] h-[calc(100svh-56px)] md:h-[unset]",
69473
+ "w-[70%] md:w-fit",
69473
69474
  navDesktopPosition === "left" ? isOpen ? "left-0 md:left-[unset]" : "left-[-70%] md:left-[unset]" : isOpen ? "right-0 md:right-[unset]" : "right-[-70%] md:right-[unset]"
69474
69475
  ],
69475
69476
  navMobileVariant === "full" && [