@react-hive/honey-layout 1.0.0 → 1.1.0

package/dist/helpers.d.ts

@@ -1,27 +1,34 @@
 import { HTMLAttributes } from 'react';
-import { HoneyBreakpointName, HoneyCSSArrayValue, HoneyCSSDimensionShortHandValue, HoneyCSSDimensionUnit, HoneyCSSMultiValue, HoneyCSSMediaRule, HoneySpacings, HoneyThemedProps, HoneyColorKey, HoneyFontName, HoneyCSSColor, HoneyDimensionName, Nullable, HoneyCSSProperties, HoneyBreakpoints, HoneyScreenState } from './types';
+import { FlattenSimpleInterpolation } from 'styled-components';
+import { HoneyBreakpointName, HoneyCSSArrayValue, HoneyCSSDimensionShortHandValue, HoneyCSSDimensionUnit, HoneyCSSMultiValue, HoneyCSSMediaRule, HoneySpacings, HoneyThemedProps, HoneyColorKey, HoneyFontName, HoneyCSSColor, HoneyDimensionName, Nullable, HoneyCSSProperties, HoneyBreakpoints, HoneyScreenState, HoneyCSSDimensionValue } from './types';
 /**
  * Conditional type to determine the return type of the `resolveSpacing` function.
  *
- * @template MultiValue - Type of the spacing value, can be a single value or an array of values.
+ * @template MultiValue - Type of the spacing value can be a single value or an array of values.
  * @template Unit - CSS length unit, which can be null or a specific unit type.
- * @template T - Type of the numeric value.
  */
-type ResolveSpacingResult<MultiValue extends HoneyCSSMultiValue<T>, Unit extends Nullable<HoneyCSSDimensionUnit>, T extends number> = Unit extends null ? MultiValue extends HoneyCSSArrayValue<T> ? HoneyCSSArrayValue<T> : T : MultiValue extends HoneyCSSArrayValue<T> ? HoneyCSSDimensionShortHandValue<MultiValue, NonNullable<Unit>> : `${T}${Unit}`;
+export type ResolveSpacingResult<MultiValue extends HoneyCSSMultiValue<number>, Unit extends Nullable<HoneyCSSDimensionUnit>> = Unit extends null ? MultiValue extends HoneyCSSArrayValue<number> ? HoneyCSSArrayValue<number> : number : MultiValue extends HoneyCSSArrayValue<number> ? HoneyCSSDimensionShortHandValue<MultiValue, NonNullable<Unit>> : `${number}${Unit}`;
 /**
- * Resolves the spacing value based on the provided `value`, `unit`, and `type`.
- *
- * @template MultiValue - Type of the spacing value, can be a single value or an array of values.
- * @template Unit - CSS length unit, which can be null or a specific unit type.
- * @template T - Type of the numeric value.
- *
- * @param value - The spacing factor to be applied, which can be a single number or an array of 2, 3, or 4 numbers.
- * @param unit - The CSS unit to be used for the calculated value, e.g., 'px', 'em'. Set `null` to apply no unit. Default: 'px'.
- * @param type - The type of spacing to be used from the theme, e.g., 'base', 'small', 'large'. Default: 'base'.
- *
- * @returns The resolved spacing value, either as a single number or a string of space-separated numbers, optionally with the specified unit.
+ * Resolves a spacing value or multiple spacing values based on the provided input, CSS unit, and spacing type.
+ * This function calculates the appropriate spacing values from a theme and formats them with the specified CSS unit.
+ *
+ * @template MultiValue - Represents the spacing value(s), which could be a single number or an array of numbers (e.g., [1, 2, 3, 4]).
+ * @template Unit - The CSS unit used for the resolved spacing value, e.g., 'px', 'em'. Defaults to 'px'.
+ *
+ * @param {MultiValue} value - The spacing factor(s) to be applied. It can be:
+ * - A single number representing a multiplier for the base spacing value.
+ * - An array of numbers representing multiple multipliers for base spacing values (e.g., for margins or padding).
+ * @param {Unit} [unit='px'] - The CSS unit to use for the calculated value. If `null` or `undefined`, no unit is applied.
+ * Defaults to 'px'.
+ * @param {keyof HoneySpacings} [type='base'] - The type of spacing to use from the theme. Determines which base spacing
+ * value to use for calculations (e.g., 'base', 'small', 'large'). Defaults to 'base'.
+ *
+ * @returns {(props: HoneyThemedProps) => ResolveSpacingResult<MultiValue, Unit>} - A function that takes `HoneyThemedProps`
+ * (containing the theme object) and returns the resolved spacing value(s). The result is either:
+ * - A single calculated value (e.g., '16px') if the input is a single number.
+ * - A string of space-separated values (e.g., '8px 16px 24px 32px') if the input is an array of numbers.
  */
-export declare const resolveSpacing: <MultiValue extends HoneyCSSMultiValue<T>, Unit extends Nullable<HoneyCSSDimensionUnit> = "px", T extends number = number>(value: MultiValue, unit?: Unit, type?: keyof HoneySpacings) => ({ theme }: HoneyThemedProps) => ResolveSpacingResult<MultiValue, Unit, T>;
+export declare const resolveSpacing: <MultiValue extends HoneyCSSMultiValue<number>, Unit extends Nullable<HoneyCSSDimensionUnit> = "px">(value: MultiValue, unit?: Unit, type?: keyof HoneySpacings) => ((props: HoneyThemedProps) => ResolveSpacingResult<MultiValue, Unit>);
 /**
  * Resolves a color value based on the provided color key and optional alpha value.
  *
@@ -41,15 +48,15 @@ export declare const resolveColor: (colorKey: HoneyColorKey, alpha?: number) =>
  *
  * @returns A function that takes the theme and returns the CSS for the specified font.
  */
-export declare const resolveFont: (fontName: HoneyFontName) => ({ theme }: HoneyThemedProps) => import('styled-components').FlattenSimpleInterpolation;
+export declare const resolveFont: (fontName: HoneyFontName) => ({ theme }: HoneyThemedProps) => FlattenSimpleInterpolation;
 /**
  * Resolves a specific dimension value from the theme configuration.
  *
- * @param dimensionName - The name of the dimension to resolve.
+ * @param {HoneyDimensionName} dimensionName - The name of the dimension to resolve.
  *
  * @returns A function that takes the theme and returns the resolved dimension value from the theme.
  */
-export declare const resolveDimension: (dimensionName: HoneyDimensionName) => ({ theme }: HoneyThemedProps) => `${number}px` | `${number}cm` | `${number}mm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}em` | `${number}rem` | `${number}%` | `${number}vh` | `${number}vw` | `${number}vmin` | `${number}vmax`;
+export declare const resolveDimension: (dimensionName: HoneyDimensionName) => ({ theme }: HoneyThemedProps) => HoneyCSSDimensionValue;
 /**
  * Generates CSS styles based on the provided breakpoint and props.
  * Filters the props to include only those with breakpoints matching the specified breakpoint.
@@ -96,4 +103,3 @@ export declare const generateMediaStyles: <Props extends HoneyCSSProperties>(bre
  *  - `isXl`: Whether the screen width is less than the 'xl' breakpoint.
  */
 export declare const resolveScreenState: (breakpoints: Partial<HoneyBreakpoints> | undefined) => HoneyScreenState;
-export {};