@aweebit/react-essentials 0.10.2 → 0.10.4

package/README.md

@@ -20,7 +20,7 @@
 const useEventListener: UseEventListener;
 ```
 
-Defined in: [hooks/useEventListener.ts:135](https://github.com/aweebit/react-essentials/blob/v0.10.2/src/hooks/useEventListener.ts#L135)
+Defined in: [hooks/useEventListener.ts:135](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/hooks/useEventListener.ts#L135)
 
 Adds `handler` as a listener for the event `eventName` of `target` with the
 provided `options` applied
@@ -71,7 +71,7 @@ function useReducerWithDeps<S, A>(
 ): [S, ActionDispatch<A>];
 ```
 
-Defined in: [hooks/useReducerWithDeps.ts:59](https://github.com/aweebit/react-essentials/blob/v0.10.2/src/hooks/useReducerWithDeps.ts#L59)
+Defined in: [hooks/useReducerWithDeps.ts:59](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/hooks/useReducerWithDeps.ts#L59)
 
 `useReducer` hook with an additional dependency array `deps` that resets the
 state to `initialState` when dependencies change
@@ -214,7 +214,7 @@ function useStateWithDeps<S>(
 ): [S, Dispatch<SetStateAction<S>>];
 ```
 
-Defined in: [hooks/useStateWithDeps.ts:62](https://github.com/aweebit/react-essentials/blob/v0.10.2/src/hooks/useStateWithDeps.ts#L62)
+Defined in: [hooks/useStateWithDeps.ts:62](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/hooks/useStateWithDeps.ts#L62)
 
 `useState` hook with an additional dependency array `deps` that resets the
 state to `initialState` when dependencies change
@@ -341,10 +341,10 @@ Dependencies that reset the state to `initialState`
 ## contextualize()
 
 ```ts
-function contextualize(jsx): ContextualizePipe;
+function contextualize(children): ContextualizePipe;
 ```
 
-Defined in: [misc/contextualize.tsx:79](https://github.com/aweebit/react-essentials/blob/v0.10.2/src/misc/contextualize.tsx#L79)
+Defined in: [misc/contextualize.tsx:79](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/misc/contextualize.tsx#L79)
 
 An alternative way to provide context values to component trees that avoids
 ever-increasing indentation
@@ -400,17 +400,17 @@ return contextualize(jsx)
 <tr>
 <td>
 
-`jsx`
+`children`
 
 </td>
 <td>
 
-`undefined` \| `Element`
+`ReactNode`
 
 </td>
 <td>
 
-The JSX to contextualize
+The children to contextualize
 
 </td>
 </tr>
@@ -425,8 +425,8 @@ An object with the following properties:
 
 - `with`: a function that accepts a context `Context` and a value `value` for
   it as arguments and returns
-  `contextualize(<Context.Provider value={value}>{jsx}</Context.Provider>)`
-- `end`: a function that returns `jsx`
+  `contextualize(<Context.Provider value={value}>{children}</Context.Provider>)`
+- `end`: a function that returns `children`
 
 ### See
 
@@ -444,7 +444,7 @@ function createSafeContext<T>(): <DisplayName>(displayName) => {
 };
 ```
 
-Defined in: [misc/createSafeContext.ts:62](https://github.com/aweebit/react-essentials/blob/v0.10.2/src/misc/createSafeContext.ts#L62)
+Defined in: [misc/createSafeContext.ts:62](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/misc/createSafeContext.ts#L62)
 
 For a given type `T`, returns a function that produces both a context of that
 type and a hook that returns the current context value if one was provided,
@@ -586,10 +586,10 @@ A function that accepts a single string argument `displayName` (e.g.
 ## wrapJSX()
 
 ```ts
-function wrapJSX(jsx): JSXWrapPipe;
+function wrapJSX(children): JSXWrapPipe;
 ```
 
-Defined in: [misc/wrapJSX.tsx:93](https://github.com/aweebit/react-essentials/blob/v0.10.2/src/misc/wrapJSX.tsx#L93)
+Defined in: [misc/wrapJSX.tsx:94](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/misc/wrapJSX.tsx#L94)
 
 An alternative way to compose JSX that avoids ever-increasing indentation
 
@@ -643,17 +643,17 @@ createRoot(document.getElementById('root')!).render(
 <tr>
 <td>
 
-`jsx`
+`children`
 
 </td>
 <td>
 
-`undefined` \| `Element`
+`ReactNode`
 
 </td>
 <td>
 
-The JSX to wrap
+The children to wrap
 
 </td>
 </tr>
@@ -668,8 +668,8 @@ An object with the following properties:
 
 - `with`: a function that accepts a component `Component` and props `props`
   for it as arguments and returns
-  `wrapJSX(<Component {...props}>{jsx}</Component>)`
-- `end`: a function that returns `jsx`
+  `wrapJSX(<Component {...props}>{children}</Component>)`
+- `end`: a function that returns `children`
 
 ### See
 
@@ -685,7 +685,7 @@ type UseEventListener = UseEventListenerWithImplicitWindowTarget &
   UseEventListenerWithAnyExplicitTarget;
 ```
 
-Defined in: [hooks/useEventListener.ts:12](https://github.com/aweebit/react-essentials/blob/v0.10.2/src/hooks/useEventListener.ts#L12)
+Defined in: [hooks/useEventListener.ts:12](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/hooks/useEventListener.ts#L12)
 
 The type of [`useEventListener`](#useeventlistener)
 
@@ -704,7 +704,7 @@ The type of [`useEventListener`](#useeventlistener)
 type UseEventListenerWithImplicitWindowTarget = <K>(...args) => void;
 ```
 
-Defined in: [hooks/useEventListener.ts:21](https://github.com/aweebit/react-essentials/blob/v0.10.2/src/hooks/useEventListener.ts#L21)
+Defined in: [hooks/useEventListener.ts:21](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/hooks/useEventListener.ts#L21)
 
 ### Type Parameters
 
@@ -772,7 +772,7 @@ type UseEventListenerWithExplicitGlobalTarget =
     UseEventListenerWithExplicitTarget<MathMLElement, MathMLElementEventMap>;
 ```
 
-Defined in: [hooks/useEventListener.ts:32](https://github.com/aweebit/react-essentials/blob/v0.10.2/src/hooks/useEventListener.ts#L32)
+Defined in: [hooks/useEventListener.ts:32](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/hooks/useEventListener.ts#L32)
 
 ### See
 
@@ -789,7 +789,7 @@ type UseEventListenerWithExplicitTarget<Target, EventMap> = <T, K>(
 ) => void;
 ```
 
-Defined in: [hooks/useEventListener.ts:44](https://github.com/aweebit/react-essentials/blob/v0.10.2/src/hooks/useEventListener.ts#L44)
+Defined in: [hooks/useEventListener.ts:44](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/hooks/useEventListener.ts#L44)
 
 ### Type Parameters
 
@@ -888,7 +888,7 @@ type UseEventListenerWithAnyExplicitTarget = UseEventListenerWithExplicitTarget<
 >;
 ```
 
-Defined in: [hooks/useEventListener.ts:56](https://github.com/aweebit/react-essentials/blob/v0.10.2/src/hooks/useEventListener.ts#L56)
+Defined in: [hooks/useEventListener.ts:56](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/hooks/useEventListener.ts#L56)
 
 ### See
 
@@ -909,7 +909,7 @@ type UseEventListenerWithImplicitWindowTargetArgs<K> =
     : never;
 ```
 
-Defined in: [hooks/useEventListener.ts:64](https://github.com/aweebit/react-essentials/blob/v0.10.2/src/hooks/useEventListener.ts#L64)
+Defined in: [hooks/useEventListener.ts:64](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/hooks/useEventListener.ts#L64)
 
 ### Type Parameters
 
@@ -954,7 +954,7 @@ type UseEventListenerWithExplicitTargetArgs<EventMap, T, K> = [
 ];
 ```
 
-Defined in: [hooks/useEventListener.ts:78](https://github.com/aweebit/react-essentials/blob/v0.10.2/src/hooks/useEventListener.ts#L78)
+Defined in: [hooks/useEventListener.ts:78](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/hooks/useEventListener.ts#L78)
 
 ### Type Parameters
 
@@ -1000,11 +1000,11 @@ Defined in: [hooks/useEventListener.ts:78](https://github.com/aweebit/react-esse
 ```ts
 type ContextualizePipe = {
   with: ContextualizeWith;
-  end: () => React.JSX.Element | undefined;
+  end: () => ReactNode;
 };
 ```
 
-Defined in: [misc/contextualize.tsx:13](https://github.com/aweebit/react-essentials/blob/v0.10.2/src/misc/contextualize.tsx#L13)
+Defined in: [misc/contextualize.tsx:13](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/misc/contextualize.tsx#L13)
 
 The return type of [`contextualize`](#contextualize)
 
@@ -1043,7 +1043,7 @@ The return type of [`contextualize`](#contextualize)
 </td>
 <td>
 
-() => `React.JSX.Element` \| `undefined`
+() => `ReactNode`
 
 </td>
 </tr>
@@ -1058,7 +1058,7 @@ The return type of [`contextualize`](#contextualize)
 type ContextualizeWith = <T>(Context, value) => ContextualizePipe;
 ```
 
-Defined in: [misc/contextualize.tsx:23](https://github.com/aweebit/react-essentials/blob/v0.10.2/src/misc/contextualize.tsx#L23)
+Defined in: [misc/contextualize.tsx:23](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/misc/contextualize.tsx#L23)
 
 ### Type Parameters
 
@@ -1132,11 +1132,11 @@ Defined in: [misc/contextualize.tsx:23](https://github.com/aweebit/react-essenti
 ```ts
 type JSXWrapPipe = {
   with: WrapJSXWith;
-  end: () => React.JSX.Element | undefined;
+  end: () => ReactNode;
 };
 ```
 
-Defined in: [misc/wrapJSX.tsx:17](https://github.com/aweebit/react-essentials/blob/v0.10.2/src/misc/wrapJSX.tsx#L17)
+Defined in: [misc/wrapJSX.tsx:18](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/misc/wrapJSX.tsx#L18)
 
 The return type of [`wrapJSX`](#wrapjsx)
 
@@ -1175,7 +1175,7 @@ The return type of [`wrapJSX`](#wrapjsx)
 </td>
 <td>
 
-() => `React.JSX.Element` \| `undefined`
+() => `ReactNode`
 
 </td>
 </tr>
@@ -1190,7 +1190,7 @@ The return type of [`wrapJSX`](#wrapjsx)
 type WrapJSXWith = <C>(...args) => JSXWrapPipe;
 ```
 
-Defined in: [misc/wrapJSX.tsx:27](https://github.com/aweebit/react-essentials/blob/v0.10.2/src/misc/wrapJSX.tsx#L27)
+Defined in: [misc/wrapJSX.tsx:28](https://github.com/aweebit/react-essentials/blob/v0.10.4/src/misc/wrapJSX.tsx#L28)
 
 ### Type Parameters
 

package/dist/misc/contextualize.d.ts

@@ -1,4 +1,4 @@
-import type { Context, default as React } from 'react';
+import type { Context, ReactNode } from 'react';
 /**
  * The return type of {@linkcode contextualize}
  *
@@ -8,7 +8,7 @@ import type { Context, default as React } from 'react';
  */
 export type ContextualizePipe = {
     with: ContextualizeWith;
-    end: () => React.JSX.Element | undefined;
+    end: () => ReactNode;
 };
 /**
  * @see
@@ -56,16 +56,16 @@ export type ContextualizeWith = <T>(Context: Context<T>, value: NoInfer<T>) => C
  *   .end();
  * ```
  *
- * @param jsx The JSX to contextualize
+ * @param children The children to contextualize
  *
  * @returns An object with the following properties:
  * - `with`: a function that accepts a context `Context` and a value `value` for
  *   it as arguments and returns
- *   `contextualize(<Context.Provider value={value}>{jsx}</Context.Provider>)`
- * - `end`: a function that returns `jsx`
+ *   `contextualize(<Context.Provider value={value}>{children}</Context.Provider>)`
+ * - `end`: a function that returns `children`
  *
  * @see
  * {@linkcode ContextualizePipe}
  */
-export declare function contextualize(jsx: React.JSX.Element | undefined): ContextualizePipe;
+export declare function contextualize(children: ReactNode): ContextualizePipe;
 //# sourceMappingURL=contextualize.d.ts.map

package/dist/misc/contextualize.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"contextualize.d.ts","sourceRoot":"","sources":["../../src/misc/contextualize.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,OAAO,CAAC;AAKvD;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,iBAAiB,CAAC;IACxB,GAAG,EAAE,MAAM,KAAK,CAAC,GAAG,CAAC,OAAO,GAAG,SAAS,CAAC;CAC1C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,EAChC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EACnB,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,KACd,iBAAiB,CAAC;AAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,wBAAgB,aAAa,CAC3B,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,OAAO,GAAG,SAAS,GACjC,iBAAiB,CAWnB"}
+{"version":3,"file":"contextualize.d.ts","sourceRoot":"","sources":["../../src/misc/contextualize.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAKhD;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,iBAAiB,CAAC;IACxB,GAAG,EAAE,MAAM,SAAS,CAAC;CACtB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,EAChC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EACnB,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,KACd,iBAAiB,CAAC;AAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,SAAS,GAAG,iBAAiB,CAWpE"}

package/dist/misc/contextualize.js

@@ -39,24 +39,24 @@ import { jsx as _jsx } from "react/jsx-runtime";
  *   .end();
  * ```
  *
- * @param jsx The JSX to contextualize
+ * @param children The children to contextualize
  *
  * @returns An object with the following properties:
  * - `with`: a function that accepts a context `Context` and a value `value` for
  *   it as arguments and returns
- *   `contextualize(<Context.Provider value={value}>{jsx}</Context.Provider>)`
- * - `end`: a function that returns `jsx`
+ *   `contextualize(<Context.Provider value={value}>{children}</Context.Provider>)`
+ * - `end`: a function that returns `children`
  *
  * @see
  * {@linkcode ContextualizePipe}
  */
-export function contextualize(jsx) {
+export function contextualize(children) {
     return {
         with(Context, value) {
-            return contextualize(_jsx(Context.Provider, { value: value, children: jsx }));
+            return contextualize(_jsx(Context.Provider, { value: value, children: children }));
         },
         end() {
-            return jsx;
+            return children;
         },
     };
 }

package/dist/misc/contextualize.js.map

@@ -1 +1 @@
-{"version":3,"file":"contextualize.js","sourceRoot":"","sources":["../../src/misc/contextualize.tsx"],"names":[],"mappings":";AA2BA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,MAAM,UAAU,aAAa,CAC3B,GAAkC;IAElC,OAAO;QACL,IAAI,CAAI,OAAmB,EAAE,KAAQ;YACnC,OAAO,aAAa,CAClB,KAAC,OAAO,CAAC,QAAQ,IAAC,KAAK,EAAE,KAAK,YAAG,GAAG,GAAoB,CACzD,CAAC;QACJ,CAAC;QACD,GAAG;YACD,OAAO,GAAG,CAAC;QACb,CAAC;KACF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"contextualize.js","sourceRoot":"","sources":["../../src/misc/contextualize.tsx"],"names":[],"mappings":";AA2BA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,MAAM,UAAU,aAAa,CAAC,QAAmB;IAC/C,OAAO;QACL,IAAI,CAAI,OAAmB,EAAE,KAAQ;YACnC,OAAO,aAAa,CAClB,KAAC,OAAO,CAAC,QAAQ,IAAC,KAAK,EAAE,KAAK,YAAG,QAAQ,GAAoB,CAC9D,CAAC;QACJ,CAAC;QACD,GAAG;YACD,OAAO,QAAQ,CAAC;QAClB,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/misc/wrapJSX.d.ts

@@ -1,4 +1,4 @@
-import type { ComponentProps, JSXElementConstructor, default as React } from 'react';
+import type { ComponentProps, JSXElementConstructor, default as React, ReactNode } from 'react';
 /**
  * The return type of {@linkcode wrapJSX}
  *
@@ -8,7 +8,7 @@ import type { ComponentProps, JSXElementConstructor, default as React } from 're
  */
 export type JSXWrapPipe = {
     with: WrapJSXWith;
-    end: () => React.JSX.Element | undefined;
+    end: () => ReactNode;
 };
 /**
  * @see
@@ -61,16 +61,16 @@ export type WrapJSXWith = <C extends keyof JSX.IntrinsicElements | JSXElementCon
  * );
  * ```
  *
- * @param jsx The JSX to wrap
+ * @param children The children to wrap
  *
  * @returns An object with the following properties:
  * - `with`: a function that accepts a component `Component` and props `props`
  *   for it as arguments and returns
- *   `wrapJSX(<Component {...props}>{jsx}</Component>)`
- * - `end`: a function that returns `jsx`
+ *   `wrapJSX(<Component {...props}>{children}</Component>)`
+ * - `end`: a function that returns `children`
  *
  * @see
  * {@linkcode JSXWrapPipe}
  */
-export declare function wrapJSX(jsx: React.JSX.Element | undefined): JSXWrapPipe;
+export declare function wrapJSX(children: ReactNode): JSXWrapPipe;
 //# sourceMappingURL=wrapJSX.d.ts.map

package/dist/misc/wrapJSX.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"wrapJSX.d.ts","sourceRoot":"","sources":["../../src/misc/wrapJSX.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,qBAAqB,EACrB,OAAO,IAAI,KAAK,EACjB,MAAM,OAAO,CAAC;AAKf;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,WAAW,CAAC;IAClB,GAAG,EAAE,MAAM,KAAK,CAAC,GAAG,CAAC,OAAO,GAAG,SAAS,CAAC;CAC1C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAErB,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,iBAAiB,GAAG,qBAAqB,CAAC,GAAG,CAAC,EACjE,GAAG,IAAI,EAAE;IACP,SAAS,EAAE,CAAC;IACZ,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,SAAS,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,GAClE;QACE,KAAK,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,mBAAmB,GACnC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC;KACtC,GACD;QACE,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,mBAAmB,GAClC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC;KACtC,CAAC;CACP,KACE,WAAW,CAAC;AAEnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,OAAO,GAAG,SAAS,GAAG,WAAW,CAcvE"}
+{"version":3,"file":"wrapJSX.d.ts","sourceRoot":"","sources":["../../src/misc/wrapJSX.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,qBAAqB,EACrB,OAAO,IAAI,KAAK,EAChB,SAAS,EACV,MAAM,OAAO,CAAC;AAKf;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,WAAW,CAAC;IAClB,GAAG,EAAE,MAAM,SAAS,CAAC;CACtB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAErB,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,iBAAiB,GAAG,qBAAqB,CAAC,GAAG,CAAC,EACjE,GAAG,IAAI,EAAE;IACP,SAAS,EAAE,CAAC;IACZ,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,SAAS,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,GAClE;QACE,KAAK,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,mBAAmB,GACnC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC;KACtC,GACD;QACE,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,mBAAmB,GAClC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC;KACtC,CAAC;CACP,KACE,WAAW,CAAC;AAEnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,wBAAgB,OAAO,CAAC,QAAQ,EAAE,SAAS,GAAG,WAAW,CAcxD"}

package/dist/misc/wrapJSX.js

@@ -37,24 +37,24 @@ import { jsx as _jsx } from "react/jsx-runtime";
  * );
  * ```
  *
- * @param jsx The JSX to wrap
+ * @param children The children to wrap
  *
  * @returns An object with the following properties:
  * - `with`: a function that accepts a component `Component` and props `props`
  *   for it as arguments and returns
- *   `wrapJSX(<Component {...props}>{jsx}</Component>)`
- * - `end`: a function that returns `jsx`
+ *   `wrapJSX(<Component {...props}>{children}</Component>)`
+ * - `end`: a function that returns `children`
  *
  * @see
  * {@linkcode JSXWrapPipe}
  */
-export function wrapJSX(jsx) {
+export function wrapJSX(children) {
     return {
         with(Component, props = {}) {
-            return wrapJSX(_jsx(Component, { ...props, children: jsx }));
+            return wrapJSX(_jsx(Component, { ...props, children: children }));
         },
         end() {
-            return jsx;
+            return children;
         },
     };
 }

package/dist/misc/wrapJSX.js.map

@@ -1 +1 @@
-{"version":3,"file":"wrapJSX.js","sourceRoot":"","sources":["../../src/misc/wrapJSX.tsx"],"names":[],"mappings":";AA2CA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,MAAM,UAAU,OAAO,CAAC,GAAkC;IACxD,OAAO;QACL,IAAI,CACF,SAEiC,EACjC,QAAgB,EAAE;YAElB,OAAO,OAAO,CAAC,KAAC,SAAS,OAAK,KAAK,YAAG,GAAG,GAAa,CAAC,CAAC;QAC1D,CAAC;QACD,GAAG;YACD,OAAO,GAAG,CAAC;QACb,CAAC;KACF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"wrapJSX.js","sourceRoot":"","sources":["../../src/misc/wrapJSX.tsx"],"names":[],"mappings":";AA4CA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,MAAM,UAAU,OAAO,CAAC,QAAmB;IACzC,OAAO;QACL,IAAI,CACF,SAEiC,EACjC,QAAgB,EAAE;YAElB,OAAO,OAAO,CAAC,KAAC,SAAS,OAAK,KAAK,YAAG,QAAQ,GAAa,CAAC,CAAC;QAC/D,CAAC;QACD,GAAG;YACD,OAAO,QAAQ,CAAC;QAClB,CAAC;KACF,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aweebit/react-essentials",
-  "version": "0.10.2",
+  "version": "0.10.4",
   "type": "module",
   "repository": "github:aweebit/react-essentials",
   "main": "dist/index.js",

package/src/misc/contextualize.tsx

@@ -1,4 +1,4 @@
-import type { Context, default as React } from 'react';
+import type { Context, ReactNode } from 'react';
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 import type { wrapJSX } from './wrapJSX.js';
@@ -12,7 +12,7 @@ import type { wrapJSX } from './wrapJSX.js';
  */
 export type ContextualizePipe = {
   with: ContextualizeWith;
-  end: () => React.JSX.Element | undefined;
+  end: () => ReactNode;
 };
 
 /**
@@ -65,28 +65,26 @@ export type ContextualizeWith = <T>(
  *   .end();
  * ```
  *
- * @param jsx The JSX to contextualize
+ * @param children The children to contextualize
  *
  * @returns An object with the following properties:
  * - `with`: a function that accepts a context `Context` and a value `value` for
  *   it as arguments and returns
- *   `contextualize(<Context.Provider value={value}>{jsx}</Context.Provider>)`
- * - `end`: a function that returns `jsx`
+ *   `contextualize(<Context.Provider value={value}>{children}</Context.Provider>)`
+ * - `end`: a function that returns `children`
  *
  * @see
  * {@linkcode ContextualizePipe}
  */
-export function contextualize(
-  jsx: React.JSX.Element | undefined,
-): ContextualizePipe {
+export function contextualize(children: ReactNode): ContextualizePipe {
   return {
     with<T>(Context: Context<T>, value: T) {
       return contextualize(
-        <Context.Provider value={value}>{jsx}</Context.Provider>,
+        <Context.Provider value={value}>{children}</Context.Provider>,
       );
     },
     end() {
-      return jsx;
+      return children;
     },
   };
 }

package/src/misc/wrapJSX.tsx

@@ -2,6 +2,7 @@ import type {
   ComponentProps,
   JSXElementConstructor,
   default as React,
+  ReactNode,
 } from 'react';
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -16,7 +17,7 @@ import type { contextualize } from './contextualize.js';
  */
 export type JSXWrapPipe = {
   with: WrapJSXWith;
-  end: () => React.JSX.Element | undefined;
+  end: () => ReactNode;
 };
 
 /**
@@ -79,18 +80,18 @@ export type WrapJSXWith =
  * );
  * ```
  *
- * @param jsx The JSX to wrap
+ * @param children The children to wrap
  *
  * @returns An object with the following properties:
  * - `with`: a function that accepts a component `Component` and props `props`
  *   for it as arguments and returns
- *   `wrapJSX(<Component {...props}>{jsx}</Component>)`
- * - `end`: a function that returns `jsx`
+ *   `wrapJSX(<Component {...props}>{children}</Component>)`
+ * - `end`: a function that returns `children`
  *
  * @see
  * {@linkcode JSXWrapPipe}
  */
-export function wrapJSX(jsx: React.JSX.Element | undefined): JSXWrapPipe {
+export function wrapJSX(children: ReactNode): JSXWrapPipe {
   return {
     with(
       Component:
@@ -98,10 +99,10 @@ export function wrapJSX(jsx: React.JSX.Element | undefined): JSXWrapPipe {
         | JSXElementConstructor<object>,
       props: object = {},
     ) {
-      return wrapJSX(<Component {...props}>{jsx}</Component>);
+      return wrapJSX(<Component {...props}>{children}</Component>);
     },
     end() {
-      return jsx;
+      return children;
     },
   };
 }