@react-hive/honey-layout 1.0.0-beta → 1.0.0

package/dist/providers/HoneyLayoutProvider.d.ts

@@ -0,0 +1,16 @@
+import { PropsWithChildren } from 'react';
+import { DefaultTheme } from 'styled-components';
+import { HoneyScreenState } from '../types';
+import { UseHoneyMediaQueryOptions } from '../hooks';
+type HoneyLayoutContextValue = {
+    screenState: HoneyScreenState;
+};
+type HoneyLayoutProviderContentProps = {
+    mediaQueryOptions?: UseHoneyMediaQueryOptions;
+};
+type HoneyLayoutProviderProps = HoneyLayoutProviderContentProps & {
+    theme: DefaultTheme;
+};
+export declare const HoneyLayoutProvider: ({ theme, ...props }: PropsWithChildren<HoneyLayoutProviderProps>) => import("react/jsx-runtime").JSX.Element;
+export declare const useHoneyLayout: () => HoneyLayoutContextValue;
+export {};

package/dist/providers/HoneyLayoutThemeOverride.d.ts

@@ -0,0 +1,15 @@
+import { PropsWithChildren } from 'react';
+import { DefaultTheme } from 'styled-components';
+type HoneyLayoutThemeOverrideProps = {
+    theme: DefaultTheme;
+};
+/**
+ * Provides a theme override context to its children.
+ * Merges the provided theme with the existing theme from the `ThemeContext`.
+ *
+ * @param {PropsWithChildren<HoneyLayoutThemeOverrideProps>} props - The props for `HoneyLayoutThemeOverride`.
+ *
+ * @returns The ThemeProvider with the merged theme applied to its children.
+ */
+export declare const HoneyLayoutThemeOverride: ({ theme, ...props }: PropsWithChildren<HoneyLayoutThemeOverrideProps>) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/providers/index.d.ts

@@ -1 +1,2 @@
-export * from './HoneyThemeProvider';
+export * from './HoneyLayoutProvider';
+export * from './HoneyLayoutThemeOverride';

package/dist/types.d.ts

@@ -1,5 +1,5 @@
 import { ComponentType, ReactNode } from 'react';
-import { Interpolation } from 'styled-components';
+import { DefaultTheme, Interpolation } from 'styled-components';
 import { DataType } from 'csstype';
 import * as CSS from 'csstype';
 export type TimeoutId = ReturnType<typeof setTimeout>;
@@ -74,7 +74,7 @@ export type HoneyCSSMediaRule = {
     update?: 'none' | 'slow' | 'fast';
 };
 /**
- * Represents the breakpoints configuration for a responsive layout.
+ * Represents the breakpoints configuration in pixes for a responsive layout.
  *
  * Notes:
  * - `xs`: Extra small devices
@@ -97,7 +97,7 @@ export type HoneyBreakpointName = keyof HoneyBreakpoints;
  * @template CSSProperty - The CSS property this function will generate a value for.
  */
 type HoneyCSSPropertyValueFn<CSSProperty extends keyof CSS.Properties> = (props: {
-    theme: HoneyTheme;
+    theme: DefaultTheme;
 }) => CSS.Properties[CSSProperty];
 /**
  * Type representing numeric values for CSS dimension properties.
@@ -238,7 +238,7 @@ export interface BaseHoneyColors {
  * ```typescript
  * declare module '@react-hive/honey-layout' {
  *  interface HoneyColors {
- *    neutral: Record<'charcoalDark' | 'charcoalGray' | 'crimsonRed', HoneyColor>;
+ *    neutral: Record<'charcoalDark' | 'charcoalGray' | 'crimsonRed', HoneyCSSColor>;
  *  }
  * }
  * ```
@@ -256,8 +256,8 @@ export interface HoneyColors extends BaseHoneyColors {
  * Given the `HoneyColors` interface:
  * ```typescript
  * interface HoneyColors {
- *   primary: Record<'blue' | 'green', HoneyColor>;
- *   neutral: Record<'charcoalDark' | 'charcoalGray' | 'crimsonRed', HoneyColor>;
+ *   primary: Record<'blue' | 'green', HoneyCSSColor>;
+ *   neutral: Record<'charcoalDark' | 'charcoalGray' | 'crimsonRed', HoneyCSSColor>;
  * }
  * ```
  *
@@ -342,7 +342,7 @@ export type ComponentWithAs<T, P = object> = {
     as?: string | ComponentType<P>;
 } & T;
 export type HoneyModifierResultFn = () => Interpolation<{
-    theme: HoneyTheme;
+    theme: DefaultTheme;
 }>;
 export type HoneyModifier<Config = unknown> = (config?: Config) => HoneyModifierResultFn;
 /**

package/dist/utils.d.ts

@@ -90,7 +90,7 @@ export declare const getTransformationValues: (element: HTMLElement) => {
  *
  * @returns A flat array of items, excluding the nested list key and including `depthLevel`, `parentId`, and `totalNestedItems` properties.
  */
-export declare const flattenNestedList: <OriginItem extends object>(items: OriginItem[] | undefined, itemIdKey: KeysWithNonArrayValues<OriginItem>, nestedItemsKey: KeysWithArrayValues<OriginItem>, result?: HoneyFlattenedItem<OriginItem, KeysWithArrayValues<OriginItem>>[], parentId?: OriginItem[KeysWithNonArrayValues<OriginItem>] | undefined, depthLevel?: number) => HoneyFlattenedItem<OriginItem, KeysWithArrayValues<OriginItem>>[];
+export declare const flattenNestedList: <OriginItem extends object>(items: OriginItem[] | undefined, itemIdKey: KeysWithNonArrayValues<OriginItem>, nestedItemsKey: KeysWithArrayValues<OriginItem>, result?: HoneyFlattenedItem<OriginItem, typeof nestedItemsKey>[], parentId?: OriginItem[KeysWithNonArrayValues<OriginItem>] | undefined, depthLevel?: number) => HoneyFlattenedItem<OriginItem, typeof nestedItemsKey>[];
 /**
  * Filters flattened items based on the specified parent ID and an optional predicate.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-hive/honey-layout",
-  "version": "1.0.0-beta",
+  "version": "1.0.0",
   "description": "",
   "keywords": [
     "react",
@@ -33,7 +33,7 @@
     "@mdx-js/react": "3.0.1",
     "react": "18.2.0",
     "react-dom": "18.2.0",
-    "react-router-dom": "6.24.1",
+    "react-router-dom": "6.26.1",
     "styled-components": "5.3.9",
     "highlight.js": "11.10.0"
   },
@@ -45,9 +45,9 @@
   "devDependencies": {
     "@testing-library/react": "16.0.0",
     "@types/jest": "29.5.12",
-    "@typescript-eslint/eslint-plugin": "7.16.0",
-    "@typescript-eslint/parser": "7.16.0",
-    "@types/react": "18.2.78",
+    "@typescript-eslint/eslint-plugin": "7.18.0",
+    "@typescript-eslint/parser": "7.18.0",
+    "@types/react": "18.2.79",
     "@types/react-dom": "18.2.25",
     "@types/styled-components": "5.1.34",
     "@types/mdx": "2.0.13",
@@ -64,10 +64,10 @@
     "jest": "29.7.0",
     "jest-environment-jsdom": "29.7.0",
     "prettier": "3.3.3",
-    "ts-jest": "29.2.4",
-    "typescript": "5.4.5",
-    "vite": "5.4.0",
-    "vite-plugin-dts": "4.0.2",
+    "ts-jest": "29.2.5",
+    "typescript": "5.5.4",
+    "vite": "5.4.2",
+    "vite-plugin-dts": "4.1.0",
     "vite-plugin-checker": "0.7.2"
   },
   "jest": {

package/dist/providers/HoneyThemeProvider.d.ts

@@ -1,14 +0,0 @@
-import { PropsWithChildren, JSX } from 'react';
-import { DefaultTheme } from 'styled-components';
-type HoneyThemeProviderProps = {
-    theme: DefaultTheme;
-};
-/**
- * Component for providing a merged theme to its children.
- * Merges the provided theme with the current theme from the context.
- *
- * @param {PropsWithChildren<HoneyThemeProviderProps>} props - Props containing the theme object.
- * @returns {JSX.Element} - The wrapped children with the merged theme.
- */
-export declare const HoneyThemeProvider: ({ children, theme, }: PropsWithChildren<HoneyThemeProviderProps>) => JSX.Element;
-export {};