@zayne-labs/toolkit-react 0.9.4 → 0.9.6
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.
@@ -28,7 +28,13 @@ declare const matchesSlotComponent: (child: React.ReactNode, SlotComponent: Func
|
|
28
28
|
*/
|
29
29
|
declare const matchesAnySlotComponent: (child: React.ReactNode, SlotComponents: FunctionalComponent[]) => boolean;
|
30
30
|
type SlotOptions = {
|
31
|
+
/**
|
32
|
+
* @description The error message to throw when multiple slots are found for a given slot component
|
33
|
+
*/
|
31
34
|
errorMessage?: string;
|
35
|
+
/**
|
36
|
+
* @description When true, an AssertionError will be thrown if multiple slots are found for a given slot component
|
37
|
+
*/
|
32
38
|
throwOnMultipleSlotMatch?: boolean;
|
33
39
|
};
|
34
40
|
/**
|
@@ -37,13 +43,24 @@ type SlotOptions = {
|
|
37
43
|
* @throws { AssertionError } when throwOnMultipleSlotMatch is true and multiple slots are found
|
38
44
|
*/
|
39
45
|
declare const getSingleSlot: (children: React.ReactNode, SlotComponent: FunctionalComponent, options?: SlotOptions) => react.ReactNode;
|
40
|
-
type
|
46
|
+
type MultipleSlotsOptions = {
|
47
|
+
/**
|
48
|
+
* @description The error message to throw when multiple slots are found for a given slot component
|
49
|
+
* If a string is provided, the same message will be used for all slot components
|
50
|
+
* If an array is provided, each string in the array will be used as the errorMessage for the corresponding slot component
|
51
|
+
*/
|
41
52
|
errorMessage?: string | string[];
|
53
|
+
/**
|
54
|
+
* @description When true, an AssertionError will be thrown if multiple slots are found for a given slot component
|
55
|
+
* If a boolean is provided, the same value will be used for all slot components
|
56
|
+
* If an array is provided, each boolean in the array will be used as the throwOnMultipleSlotMatch value for the corresponding slot component
|
57
|
+
*/
|
58
|
+
throwOnMultipleSlotMatch?: boolean | boolean[];
|
42
59
|
};
|
43
60
|
/**
|
44
61
|
* @description The same as getSingleSlot, but for multiple slot components
|
45
62
|
*/
|
46
|
-
declare const getMultipleSlots: <const TSlotComponents extends FunctionalComponent[]>(children: React.ReactNode, SlotComponents: TSlotComponents, options?:
|
63
|
+
declare const getMultipleSlots: <const TSlotComponents extends FunctionalComponent[]>(children: React.ReactNode, SlotComponents: TSlotComponents, options?: MultipleSlotsOptions) => {
|
47
64
|
regularChildren: string[] | undefined[] | null[] | number[] | bigint[] | false[] | true[] | react.ReactElement<unknown, string | react.JSXElementConstructor<any>>[] | Iterable<react.ReactNode>[] | react.ReactPortal[] | Promise<string | number | bigint | boolean | react.ReactPortal | react.ReactElement<unknown, string | react.JSXElementConstructor<any>> | Iterable<react.ReactNode> | null | undefined>[];
|
48
65
|
slots: { [Key in keyof TSlotComponents]: ReturnType<TSlotComponents[Key]>; };
|
49
66
|
};
|
package/dist/esm/utils/index.js
CHANGED
@@ -11,7 +11,7 @@ var setRef = (ref, node) => {
|
|
11
11
|
ref.current = node;
|
12
12
|
};
|
13
13
|
var composeRefs = (refs) => {
|
14
|
-
const
|
14
|
+
const mergedRefCallBack = (node) => {
|
15
15
|
const cleanupFnArray = refs.map((ref) => setRef(ref, node));
|
16
16
|
const cleanupFn = () => cleanupFnArray.forEach((cleanup) => cleanup?.());
|
17
17
|
if (!node) {
|
@@ -20,7 +20,7 @@ var composeRefs = (refs) => {
|
|
20
20
|
}
|
21
21
|
return cleanupFn;
|
22
22
|
};
|
23
|
-
return
|
23
|
+
return mergedRefCallBack;
|
24
24
|
};
|
25
25
|
var matchesSlotComponent = (child, SlotComponent2) => {
|
26
26
|
if (!isValidElement(child)) {
|
@@ -63,11 +63,11 @@ var getSingleSlot = (children, SlotComponent2, options = {}) => {
|
|
63
63
|
return slotElement;
|
64
64
|
};
|
65
65
|
var getMultipleSlots = (children, SlotComponents, options) => {
|
66
|
-
const { errorMessage,
|
66
|
+
const { errorMessage, throwOnMultipleSlotMatch } = options ?? {};
|
67
67
|
const slots = SlotComponents.map(
|
68
68
|
(SlotComponent2, index) => getSingleSlot(children, SlotComponent2, {
|
69
|
-
|
70
|
-
|
69
|
+
errorMessage: isArray(errorMessage) ? errorMessage[index] : errorMessage,
|
70
|
+
throwOnMultipleSlotMatch: isArray(throwOnMultipleSlotMatch) ? throwOnMultipleSlotMatch[index] : throwOnMultipleSlotMatch
|
71
71
|
})
|
72
72
|
);
|
73
73
|
const regularChildren = getRegularChildren(children, SlotComponents);
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"sources":["../../../src/utils/composeRefs.ts","../../../src/utils/getSlotElement.ts","../../../src/utils/getSlotMap.ts","../../../src/utils/mergeProps.ts","../../../src/utils/mergeTwoProps.ts"],"names":["SlotComponent","toArray","isValidElement","isFunction","isPlainObject","mergeClassNames","mergeFunctions"],"mappings":";;;;;AAUa,IAAA,MAAA,GAAS,CAAO,GAAA,EAAwB,IAA8C,KAAA;AAClG,EAAA,IAAI,CAAC,GAAK,EAAA;AAEV,EAAI,IAAA,UAAA,CAAW,GAAG,CAAG,EAAA;AACpB,IAAA,OAAO,IAAI,IAAI,CAAA;AAAA;AAIhB,EAAA,GAAA,CAAI,OAAU,GAAA,IAAA;AACf;AAKa,IAAA,WAAA,GAAc,CAC1B,IACuB,KAAA;AACvB,EAAM,MAAA,WAAA,GAAiC,CAAC,IAAS,KAAA;AAChD,IAAM,MAAA,cAAA,GAAiB,KAAK,GAAI,CAAA,CAAC,QAAQ,MAAO,CAAA,GAAA,EAAK,IAAI,CAAC,CAAA;AAE1D,IAAA,MAAM,YAAY,MAAM,cAAA,CAAe,QAAQ,CAAC,OAAA,KAAY,WAAW,CAAA;AAGvE,IAAA,IAAI,CAAC,IAAM,EAAA;AACV,MAAU,SAAA,EAAA;AACV,MAAA;AAAA;AAGD,IAAO,OAAA,SAAA;AAAA,GACR;AAEA,EAAO,OAAA,WAAA;AACR;AC7Ba,IAAA,oBAAA,GAAuB,CAAC,KAAA,EAAwBA,cAAuC,KAAA;AACnG,EAAI,IAAA,CAAC,cAAe,CAAA,KAAK,CAAG,EAAA;AAC3B,IAAO,OAAA,KAAA;AAAA;AAGR,EAAI,IAAA,KAAA,CAAM,SAASA,cAAe,EAAA;AACjC,IAAO,OAAA,IAAA;AAAA;AAKR,EAAA,IAAK,KAAM,CAAA,IAAA,EAA+B,UAAgBA,KAAAA,cAAAA,CAA2B,UAAY,EAAA;AAChG,IAAO,OAAA,IAAA;AAAA;AAGR,EAAA,IAAK,KAAM,CAAA,IAAA,CAA6B,IAASA,KAAAA,cAAAA,CAAc,IAAM,EAAA;AACpE,IAAO,OAAA,IAAA;AAAA;AAGR,EAAA,OAAO,KAAM,CAAA,IAAA,CAAK,QAAS,EAAA,KAAMA,eAAc,QAAS,EAAA;AACzD;AAKa,IAAA,uBAAA,GAA0B,CAAC,KAAA,EAAwB,cAA0C,KAAA;AACzG,EAAM,MAAA,WAAA,GAAc,eAAe,IAAK,CAAA,CAACA,mBAAkB,oBAAqB,CAAA,KAAA,EAAOA,cAAa,CAAC,CAAA;AAErG,EAAO,OAAA,WAAA;AACR;AAWA,IAAM,wBAAA,GAA2B,CAChC,aAAA,EACAA,cACI,KAAA;AACJ,EAAA,IAAI,KAAQ,GAAA,CAAA;AAEZ,EAAA,KAAA,MAAW,SAAS,aAAe,EAAA;AAClC,IAAA,IAAI,CAAC,oBAAA,CAAqB,KAAOA,EAAAA,cAAa,CAAG,EAAA;AAEjD,IAAS,KAAA,IAAA,CAAA;AAAA;AAGV,EAAO,OAAA,KAAA;AACR,CAAA;AAOO,IAAM,gBAAgB,CAC5B,QAAA,EACAA,cACA,EAAA,OAAA,GAAuB,EACnB,KAAA;AACJ,EAAM,MAAA;AAAA,IACL,YAAe,GAAA,mDAAA;AAAA,IACf,wBAA2B,GAAA;AAAA,GACxB,GAAA,OAAA;AAEJ,EAAM,MAAA,aAAA,GAAgB,QAAyB,QAAQ,CAAA;AAEvD,EAAA,MAAM,WACL,GAAA,wBAAA,IAA4B,wBAAyB,CAAA,aAAA,EAAeA,cAAa,CAAI,GAAA,CAAA;AAEtF,EAAA,IAAI,WAAa,EAAA;AAChB,IAAM,MAAA,IAAI,eAAe,YAAY,CAAA;AAAA;AAGtC,EAAM,MAAA,WAAA,GAAc,cAAc,IAAK,CAAA,CAAC,UAAU,oBAAqB,CAAA,KAAA,EAAOA,cAAa,CAAC,CAAA;AAE5F,EAAO,OAAA,WAAA;AACR;AAWO,IAAM,gBAAmB,GAAA,CAC/B,QACA,EAAA,cAAA,EACA,OACI,KAAA;AAGJ,EAAA,MAAM,EAAE,YAAc,EAAA,GAAG,WAAY,EAAA,GAAI,WAAW,EAAC;AAErD,EAAA,MAAM,QAAQ,cAAe,CAAA,GAAA;AAAA,IAAI,CAACA,cAAAA,EAAe,KAChD,KAAA,aAAA,CAAc,UAAUA,cAAe,EAAA;AAAA,MACtC,GAAG,WAAA;AAAA,MACH,cAAc,OAAQ,CAAA,YAAY,CAAI,GAAA,YAAA,CAAa,KAAK,CAAI,GAAA;AAAA,KAC5D;AAAA,GACF;AAEA,EAAM,MAAA,eAAA,GAAkB,kBAAmB,CAAA,QAAA,EAAU,cAAc,CAAA;AAEnE,EAAO,OAAA,EAAE,iBAAiB,KAAM,EAAA;AACjC;AAKa,IAAA,kBAAA,GAAqB,CACjC,QAAA,EACA,yBACI,KAAA;AACJ,EAAM,MAAA,aAAA,GAAgB,QAAyB,QAAQ,CAAA;AAEvD,EAAA,MAAM,kBAAkB,aAAc,CAAA,MAAA;AAAA,IACrC,CAAC,KAAU,KAAA,CAAC,wBAAwB,KAAO,EAAA,OAAA,CAAQ,yBAAyB,CAAC;AAAA,GAC9E;AAEA,EAAO,OAAA,eAAA;AACR;ACvHa,IAAA,mBAAA,GAAsB,OAAO,eAAe;AAkC5C,IAAA,UAAA,GAAa,CACzB,QACI,KAAA;AACJ,EAAM,MAAA,aAAA,GAAgBC,QAAyB,QAAQ,CAAA;AAEvD,EAAA,MAAM,KAAmF,GAAA;AAAA,IACxF,SAAS;AAAC,GACX;AAEA,EAAA,KAAA,MAAW,SAAS,aAAe,EAAA;AAQlC,IAAM,MAAA,qBAAA,GACLC,eAAiC,KAAK,CAAA,IAClC,MAAM,IAA8B,CAAA,EAAA,KAAO,mBAC5C,IAAA,KAAA,CAAM,KAAM,CAAA,IAAA;AAEhB,IAAA,MAAM,+BACLA,cAAoC,CAAA,KAAK,CAAK,IAAA,KAAA,CAAM,MAAM,gBAAgB,CAAA;AAE3E,IAAI,IAAA,CAAC,qBAAyB,IAAA,CAAC,4BAA8B,EAAA;AAC5D,MAAM,KAAA,CAAA,OAAA,CAAQ,KAAK,KAAK,CAAA;AACxB,MAAA;AAAA;AAGD,IAAA,MAAM,WAAW,qBAAwB,GAAA,KAAA,CAAM,MAAM,IAAO,GAAA,KAAA,CAAM,MAAM,gBAAgB,CAAA;AAExF,IAAM,KAAA,CAAA,QAAQ,CAAI,GAAA,KAAA,CAAM,KAAM,CAAA,QAAA;AAAA;AAG/B,EAAO,OAAA,KAAA;AACR;AA0DO,IAAM,sBAAsB,MAA6D;AAC/F,EAAA,SAASF,eAER,KACC,EAAA;AACD,IAAO,OAAA,IAAA;AAAA;AAGR,EAAAA,eAAc,EAAK,GAAA,mBAAA;AAEnB,EAAOA,OAAAA,cAAAA;AACR;AAKO,IAAM,gBAAgB,mBAAoB;ACpIjD,IAAM,0BAAA,GAA6B,CAClC,YAAA,EACA,WACI,KAAA;AACJ,EAAA,KAAA,MAAW,QAAY,IAAA,MAAA,CAAO,IAAK,CAAA,YAAY,CAAG,EAAA;AACjD,IAAM,MAAA,iBAAA,GAAoB,aAAa,QAAQ,CAAA;AAC/C,IAAM,MAAA,gBAAA,GAAmB,YAAY,QAAQ,CAAA;AAE7C,IAAI,IAAA,QAAA,KAAa,WAAe,IAAA,QAAA,KAAa,OAAS,EAAA;AACrD,MAAA,YAAA,CAAa,QAAQ,CAAA,GAAI,eAAgB,CAAA,iBAAA,EAA6B,gBAA0B,CAAA;AAChG,MAAA;AAAA;AAGD,IAAA,IAAI,aAAa,OAAW,IAAA,aAAA,CAAc,iBAAiB,CAAK,IAAA,aAAA,CAAc,gBAAgB,CAAG,EAAA;AAEhG,MAAA,YAAA,CAAa,QAAQ,CAAI,GAAA,EAAE,GAAG,iBAAA,EAAmB,GAAG,gBAAiB,EAAA;AACrE,MAAA;AAAA;AAGD,IAAM,MAAA,SAAA,GAAY,QAAS,CAAA,UAAA,CAAW,IAAI,CAAA;AAE1C,IAAA,IAAI,aAAaG,UAAW,CAAA,iBAAiB,CAAKA,IAAAA,UAAAA,CAAW,gBAAgB,CAAG,EAAA;AAC/E,MAAA,YAAA,CAAa,QAAQ,CAAA,GAAI,cAAe,CAAA,gBAAA,EAAkB,iBAAiB,CAAA;AAC3E,MAAA;AAAA;AAGD,IAAA,YAAA,CAAa,QAAQ,CAAA,GAAI,gBAAqB,KAAA,MAAA,GAAY,gBAAmB,GAAA,iBAAA;AAAA;AAE/E,CAAA;AAEA,IAAM,uBAAA,GAA0B,CAC/B,YAAA,EACA,WACI,KAAA;AACJ,EAAA,KAAA,MAAW,QAAY,IAAA,MAAA,CAAO,IAAK,CAAA,WAAW,CAAG,EAAA;AAChD,IAAI,IAAA,YAAA,CAAa,QAAQ,CAAA,KAAM,MAAW,EAAA;AACzC,MAAa,YAAA,CAAA,QAAQ,CAAI,GAAA,WAAA,CAAY,QAAQ,CAAA;AAAA;AAC9C;AAEF,CAAA;AAKM,IAAA,UAAA,GAAa,IACf,UAC8B,KAAA;AACjC,EAAA,MAAM,eAAwC,EAAC;AAE/C,EAAA,KAAA,MAAW,eAAe,UAAY,EAAA;AACrC,IAAA,IAAI,CAAC,WAAa,EAAA;AAElB,IAAA,0BAAA,CAA2B,cAAc,WAAW,CAAA;AAGpD,IAAA,uBAAA,CAAwB,cAAc,WAAW,CAAA;AAAA;AAGlD,EAAO,OAAA,YAAA;AACR;ACxFM,IAAA,aAAA,GAAgB,CACrB,SAAA,EACA,UACY,KAAA;AACZ,EAAI,IAAA,CAAC,SAAa,IAAA,CAAC,UAAY,EAAA;AAC9B,IAAO,OAAA,UAAA,IAAc,aAAc,EAAC;AAAA;AAIrC,EAAM,MAAA,aAAA,GAAgB,EAAE,GAAG,UAAW,EAAA;AAEtC,EAAA,KAAA,MAAW,QAAY,IAAA,MAAA,CAAO,IAAK,CAAA,SAAS,CAAG,EAAA;AAC9C,IAAM,MAAA,aAAA,GAAiB,UAAsC,QAAQ,CAAA;AACrE,IAAM,MAAA,cAAA,GAAkB,WAAuC,QAAQ,CAAA;AAGvE,IAAA,IAAI,aAAa,OAAWC,IAAAA,aAAAA,CAAc,aAAa,CAAKA,IAAAA,aAAAA,CAAc,cAAc,CAAG,EAAA;AAC1F,MAAA,aAAA,CAAc,QAAQ,CAAI,GAAA,EAAE,GAAG,aAAA,EAAe,GAAG,cAAe,EAAA;AAChE,MAAA;AAAA;AAID,IAAI,IAAA,QAAA,KAAa,WAAe,IAAA,QAAA,KAAa,OAAS,EAAA;AACrD,MAAA,aAAA,CAAc,QAAQ,CAAA,GAAIC,eAAgB,CAAA,aAAA,EAAyB,cAAwB,CAAA;AAC3F,MAAA;AAAA;AAGD,IAAM,MAAA,SAAA,GAAY,QAAS,CAAA,UAAA,CAAW,IAAI,CAAA;AAG1C,IAAA,IAAI,aAAaF,UAAW,CAAA,aAAa,CAAKA,IAAAA,UAAAA,CAAW,cAAc,CAAG,EAAA;AACzE,MAAA,aAAA,CAAc,QAAQ,CAAA,GAAIG,cAAe,CAAA,cAAA,EAAgB,aAAa,CAAA;AAAA;AACvE;AAGD,EAAA,OAAO,EAAE,GAAG,SAAW,EAAA,GAAG,aAAc,EAAA;AACzC","file":"index.js","sourcesContent":["import { isFunction } from \"@zayne-labs/toolkit-type-helpers\";\nimport type { RefCallback } from \"react\";\n\ntype PossibleRef<TRef> = React.Ref<TRef> | undefined;\n\n/**\n * @description Set a given ref to a given value.\n *\n * This utility takes care of different types of refs: callback refs and RefObject(s)\n */\nexport const setRef = <TRef>(ref: PossibleRef<TRef>, node: TRef): ReturnType<RefCallback<TRef>> => {\n\tif (!ref) return;\n\n\tif (isFunction(ref)) {\n\t\treturn ref(node);\n\t}\n\n\t// eslint-disable-next-line no-param-reassign -- Mutation is needed here\n\tref.current = node;\n};\n\n/**\n * @description A utility to combine refs. Accepts callback refs and RefObject(s)\n */\nexport const composeRefs = <TRef extends HTMLElement>(\n\trefs: Array<PossibleRef<TRef>>\n): RefCallback<TRef> => {\n\tconst refCallBack: RefCallback<TRef> = (node) => {\n\t\tconst cleanupFnArray = refs.map((ref) => setRef(ref, node));\n\n\t\tconst cleanupFn = () => cleanupFnArray.forEach((cleanup) => cleanup?.());\n\n\t\t// == React 18 may not call the cleanup function so we need to call it manually on element unmount\n\t\tif (!node) {\n\t\t\tcleanupFn();\n\t\t\treturn;\n\t\t}\n\n\t\treturn cleanupFn;\n\t};\n\n\treturn refCallBack;\n};\n","import { toArray } from \"@zayne-labs/toolkit-core\";\nimport { AssertionError, type UnknownObject, isArray } from \"@zayne-labs/toolkit-type-helpers\";\nimport { isValidElement } from \"react\";\n\nexport type FunctionalComponent<TProps extends UnknownObject = never> = React.FunctionComponent<TProps>;\n\n/**\n * @description Checks if a react child (within the children array) matches the provided SlotComponent using multiple matching strategies:\n * 1. Matches by direct component reference\n * 2. Matches by slot symbol property\n * 3. Matches by stringified component\n * 4. Matches by component name\n */\nexport const matchesSlotComponent = (child: React.ReactNode, SlotComponent: FunctionalComponent) => {\n\tif (!isValidElement(child)) {\n\t\treturn false;\n\t}\n\n\tif (child.type === SlotComponent) {\n\t\treturn true;\n\t}\n\n\ttype WithSlot = { readonly slotSymbol?: unique symbol };\n\n\tif ((child.type as WithSlot | undefined)?.slotSymbol === (SlotComponent as WithSlot).slotSymbol) {\n\t\treturn true;\n\t}\n\n\tif ((child.type as FunctionalComponent).name === SlotComponent.name) {\n\t\treturn true;\n\t}\n\n\treturn child.type.toString() === SlotComponent.toString();\n};\n\n/**\n * @description Checks if a react child (within the children array) matches any of the provided SlotComponents.\n */\nexport const matchesAnySlotComponent = (child: React.ReactNode, SlotComponents: FunctionalComponent[]) => {\n\tconst matchesSlot = SlotComponents.some((SlotComponent) => matchesSlotComponent(child, SlotComponent));\n\n\treturn matchesSlot;\n};\n\ntype SlotOptions = {\n\terrorMessage?: string;\n\tthrowOnMultipleSlotMatch?: boolean;\n};\n\n/**\n * @description Counts how many times a slot component appears in an array of children\n * @internal\n */\nconst calculateSlotOccurrences = (\n\tchildrenArray: React.ReactNode[],\n\tSlotComponent: FunctionalComponent\n) => {\n\tlet count = 0;\n\n\tfor (const child of childrenArray) {\n\t\tif (!matchesSlotComponent(child, SlotComponent)) continue;\n\n\t\tcount += 1;\n\t}\n\n\treturn count;\n};\n\n/**\n * @description Retrieves a single slot element from a collection of React children that matches the provided SlotComponent component.\n *\n * @throws { AssertionError } when throwOnMultipleSlotMatch is true and multiple slots are found\n */\nexport const getSingleSlot = (\n\tchildren: React.ReactNode,\n\tSlotComponent: FunctionalComponent,\n\toptions: SlotOptions = {}\n) => {\n\tconst {\n\t\terrorMessage = \"Only one instance of the SlotComponent is allowed\",\n\t\tthrowOnMultipleSlotMatch = false,\n\t} = options;\n\n\tconst childrenArray = toArray<React.ReactNode>(children);\n\n\tconst shouldThrow =\n\t\tthrowOnMultipleSlotMatch && calculateSlotOccurrences(childrenArray, SlotComponent) > 1;\n\n\tif (shouldThrow) {\n\t\tthrow new AssertionError(errorMessage);\n\t}\n\n\tconst slotElement = childrenArray.find((child) => matchesSlotComponent(child, SlotComponent));\n\n\treturn slotElement;\n};\n\n// NOTE - You can imitate const type parameter by extending readonly[] | []\n\ntype GetMultipleSlotsOptions = Omit<SlotOptions, \"errorMessage\"> & {\n\terrorMessage?: string | string[];\n};\n\n/**\n * @description The same as getSingleSlot, but for multiple slot components\n */\nexport const getMultipleSlots = <const TSlotComponents extends FunctionalComponent[]>(\n\tchildren: React.ReactNode,\n\tSlotComponents: TSlotComponents,\n\toptions?: GetMultipleSlotsOptions\n) => {\n\ttype SlotsType = { [Key in keyof TSlotComponents]: ReturnType<TSlotComponents[Key]> };\n\n\tconst { errorMessage, ...restOptions } = options ?? {};\n\n\tconst slots = SlotComponents.map((SlotComponent, index) =>\n\t\tgetSingleSlot(children, SlotComponent, {\n\t\t\t...restOptions,\n\t\t\terrorMessage: isArray(errorMessage) ? errorMessage[index] : errorMessage,\n\t\t})\n\t) as SlotsType;\n\n\tconst regularChildren = getRegularChildren(children, SlotComponents);\n\n\treturn { regularChildren, slots };\n};\n\n/**\n * @description Returns all children that are not slot elements (i.e., don't match any of the provided slot components)\n */\nexport const getRegularChildren = <TChildren extends React.ReactNode>(\n\tchildren: TChildren,\n\tSlotComponentOrComponents: FunctionalComponent | FunctionalComponent[]\n) => {\n\tconst childrenArray = toArray<React.ReactNode>(children);\n\n\tconst regularChildren = childrenArray.filter(\n\t\t(child) => !matchesAnySlotComponent(child, toArray(SlotComponentOrComponents))\n\t);\n\n\treturn regularChildren as TChildren extends unknown[] ? TChildren : TChildren[];\n};\n","import { toArray } from \"@zayne-labs/toolkit-core\";\nimport type { AnyFunction, UnionToIntersection } from \"@zayne-labs/toolkit-type-helpers\";\nimport { isValidElement } from \"react\";\n\n/**\n * Possible children types that can be passed to a slot\n */\ntype PossibleSlotChildrenType =\n\t| AnyFunction<React.ReactNode | React.ReactNode[]>\n\t| React.ReactNode\n\t| React.ReactNode[];\n\n/**\n * Maps slot names to their corresponding children types\n */\ntype GetSlotMapResult<TSlotComponentProps extends GetSlotComponentProps> = UnionToIntersection<{\n\t[TName in keyof TSlotComponentProps as TSlotComponentProps[\"name\"]]: TSlotComponentProps[\"children\"];\n}>;\n\n/**\n * Symbol used to identify SlotComponent instances\n */\nexport const slotComponentSymbol = Symbol(\"SlotComponent\");\n\n/**\n * @description Creates a map of named slots from React children. Returns an object mapping slot names to their children,\n * with a default slot for unmatched children.\n *\n * @example\n * ```tsx\n * import { type GetSlotComponentProps, SlotComponent } from \"@zayne-labs/toolkit-react/utils\"\n *\n * type SlotProps = GetSlotComponentProps<\"header\" | \"footer\">;\n *\n * function Parent({ children }: { children: React.ReactNode }) {\n * const slots = getSlotMap<SlotProps>(children);\n *\n * return (\n * <div>\n * <header>{slots.header}</header>\n * <main>{slots.default}</main>\n * <footer>{slots.footer}</footer>\n * </div>\n * );\n * }\n * ```\n *\n * Usage:\n * ```tsx\n * <Parent>\n * <SlotComponent name=\"header\">Header Content</SlotComponent>\n * <div>Random stuff</div>\n * <SlotComponent name=\"footer\">Footer Content</SlotComponent>\n * </Parent>\n * ```\n */\nexport const getSlotMap = <TSlotComponentProps extends GetSlotComponentProps>(\n\tchildren: React.ReactNode\n) => {\n\tconst childrenArray = toArray<React.ReactNode>(children);\n\n\tconst slots: Record<string, PossibleSlotChildrenType> & { default: React.ReactNode[] } = {\n\t\tdefault: [],\n\t};\n\n\tfor (const child of childrenArray) {\n\t\ttype SlotElementProps = TSlotComponentProps & { \"data-slot-name\": never };\n\n\t\ttype RegularElementProps = Pick<TSlotComponentProps, \"children\"> & {\n\t\t\t\"data-slot-name\": string;\n\t\t\tname: never;\n\t\t};\n\n\t\tconst isSlotElementWithName =\n\t\t\tisValidElement<SlotElementProps>(child)\n\t\t\t&& (child.type as typeof SlotComponent).id === slotComponentSymbol\n\t\t\t&& child.props.name;\n\n\t\tconst isRegularElementWithSlotName =\n\t\t\tisValidElement<RegularElementProps>(child) && child.props[\"data-slot-name\"];\n\n\t\tif (!isSlotElementWithName && !isRegularElementWithSlotName) {\n\t\t\tslots.default.push(child);\n\t\t\tcontinue;\n\t\t}\n\n\t\tconst slotName = isSlotElementWithName ? child.props.name : child.props[\"data-slot-name\"];\n\n\t\tslots[slotName] = child.props.children;\n\t}\n\n\treturn slots as GetSlotMapResult<TSlotComponentProps> & { default: React.ReactNode[] };\n};\n\n/**\n * @description Produce props for the SlotComponent\n */\nexport type GetSlotComponentProps<\n\tTName extends string = string,\n\tTChildren extends PossibleSlotChildrenType = PossibleSlotChildrenType,\n> = {\n\t/** Content to render in the slot */\n\tchildren: TChildren;\n\t/** Name of the slot where content should be rendered */\n\tname: TName;\n};\n\n/**\n * @description Function used to create a slot component that defines named slots in a parent component. This component created doesn't render anything,\n * it's used purely for slot definition.\n *\n * @example\n * ```tsx\n * import { type GetSlotComponentProps, createSlotComponent, SlotComponent } from \"@zayne-labs/toolkit-react/utils\"\n *\n * type SlotProps = GetSlotComponentProps<\"header\" | \"footer\">;\n *\n * function Parent({ children }: { children: React.ReactNode }) {\n * const slots = getSlotMap<SlotProps>(children);\n *\n * return (\n * <div>\n * <header>{slots.header}</header>\n * <main>{slots.default}</main>\n * <footer>{slots.footer}</footer>\n * </div>\n * );\n * }\n *\n * Parent.Slot = createSlotComponent<SlotProps>();\n * // OR\n * Parent.Slot = SlotComponent<SlotProps>\n * ```\n *\n *\n * @example\n * Usage:\n\t```tsx\n * function App() {\n * return (\n * <Parent>\n * <Parent.Slot name=\"header\">Header Content</Parent.Slot>\n * <div>Default Content</div>\n * <Parent.Slot name=\"footer\">Footer Content</Parent.Slot>\n * </Parent>\n * );\n * }\n * ```\n */\n\nexport const createSlotComponent = <TBaseSlotComponentProps extends GetSlotComponentProps>() => {\n\tfunction SlotComponent<TSlotComponentProps extends TBaseSlotComponentProps>(\n\t\t// eslint-disable-next-line ts-eslint/no-unused-vars -- The props here are just for type definition really, as this component doesn't need to render anything\n\t\tprops: TSlotComponentProps\n\t) {\n\t\treturn null as React.ReactNode;\n\t}\n\n\tSlotComponent.id = slotComponentSymbol;\n\n\treturn SlotComponent;\n};\n\n/**\n * @description Slot component created by createSlotComponent\n */\nexport const SlotComponent = createSlotComponent();\n","import { mergeClassNames, mergeFunctions } from \"@zayne-labs/toolkit-core\";\nimport { isFunction, isPlainObject } from \"@zayne-labs/toolkit-type-helpers\";\n\n// const CSS_REGEX = /((?:--)?(?:\\w+-?)+)\\s*:\\s*([^;]*)/g;\n\n// const serialize = (style: string): Record<string, string> => {\n// \tconst res: Record<string, string> = {};\n// \tlet match: RegExpExecArray | null;\n// \twhile ((match = CSS_REGEX.exec(style))) {\n// \t\tres[match[1]!] = match[2]!;\n// \t}\n// \treturn res;\n// };\n\n// const css = (\n// \ta: Record<string, string> | string | undefined,\n// \tb: Record<string, string> | string | undefined\n// ): Record<string, string> | string => {\n// \tif (isString(a)) {\n// \t\tif (isString(b)) return `${a};${b}`;\n// \t\ta = serialize(a);\n// \t} else if (isString(b)) {\n// \t\tb = serialize(b);\n// \t}\n// \treturn Object.assign({}, a ?? {}, b ?? {});\n// };\n\ntype UnionToIntersection<TUnion> = (TUnion extends unknown ? (param: TUnion) => void : \"\") extends (\n\tparam: infer TParam\n) => void\n\t? TParam\n\t: \"\";\n\n/* eslint-disable no-param-reassign -- Mutation is fine here since it's an internally managed object */\nconst handleMergePropsIntoResult = (\n\tmergedResult: Record<string, unknown>,\n\tpropsObject: Record<string, unknown>\n) => {\n\tfor (const propName of Object.keys(mergedResult)) {\n\t\tconst mergedResultValue = mergedResult[propName];\n\t\tconst propsObjectValue = propsObject[propName];\n\n\t\tif (propName === \"className\" || propName === \"class\") {\n\t\t\tmergedResult[propName] = mergeClassNames(mergedResultValue as string, propsObjectValue as string);\n\t\t\tcontinue;\n\t\t}\n\n\t\tif (propName === \"style\" && isPlainObject(mergedResultValue) && isPlainObject(propsObjectValue)) {\n\t\t\t// mergedResult[propName] = css(mergedResultValue, propsObjectValue);\n\t\t\tmergedResult[propName] = { ...mergedResultValue, ...propsObjectValue };\n\t\t\tcontinue;\n\t\t}\n\n\t\tconst isHandler = propName.startsWith(\"on\");\n\n\t\tif (isHandler && isFunction(mergedResultValue) && isFunction(propsObjectValue)) {\n\t\t\tmergedResult[propName] = mergeFunctions(propsObjectValue, mergedResultValue);\n\t\t\tcontinue;\n\t\t}\n\n\t\tmergedResult[propName] = propsObjectValue !== undefined ? propsObjectValue : mergedResultValue;\n\t}\n};\n\nconst addMissingPropsToResult = (\n\tmergedResult: Record<string, unknown>,\n\tpropsObject: Record<string, unknown>\n) => {\n\tfor (const propName of Object.keys(propsObject)) {\n\t\tif (mergedResult[propName] === undefined) {\n\t\t\tmergedResult[propName] = propsObject[propName];\n\t\t}\n\t}\n};\n/* eslint-enable no-param-reassign -- Mutation is fine here since it's an internally managed object */\n\ntype UnknownProps = Record<never, never>;\n\nconst mergeProps = <TProps extends UnknownProps>(\n\t...parameters: Array<TProps | undefined>\n): UnionToIntersection<TProps> => {\n\tconst mergedResult: Record<string, unknown> = {};\n\n\tfor (const propsObject of parameters) {\n\t\tif (!propsObject) continue;\n\n\t\thandleMergePropsIntoResult(mergedResult, propsObject);\n\n\t\t// == Add props from propsObject that are not in the mergedResult\n\t\taddMissingPropsToResult(mergedResult, propsObject);\n\t}\n\n\treturn mergedResult as never;\n};\n\nexport { mergeProps };\n","import { mergeClassNames, mergeFunctions } from \"@zayne-labs/toolkit-core\";\nimport { isFunction, isPlainObject } from \"@zayne-labs/toolkit-type-helpers\";\n\ntype UnknownProps = Record<never, never>;\n\nconst mergeTwoProps = <TProps extends UnknownProps>(\n\tslotProps: TProps | undefined,\n\tchildProps: TProps | undefined\n): TProps => {\n\tif (!slotProps || !childProps) {\n\t\treturn childProps ?? slotProps ?? ({} as TProps);\n\t}\n\n\t// == all child props should override slotProps\n\tconst overrideProps = { ...childProps } as Record<string, unknown>;\n\n\tfor (const propName of Object.keys(slotProps)) {\n\t\tconst slotPropValue = (slotProps as Record<string, unknown>)[propName];\n\t\tconst childPropValue = (childProps as Record<string, unknown>)[propName];\n\n\t\t// == if it's `style`, we merge them\n\t\tif (propName === \"style\" && isPlainObject(slotPropValue) && isPlainObject(childPropValue)) {\n\t\t\toverrideProps[propName] = { ...slotPropValue, ...childPropValue };\n\t\t\tcontinue;\n\t\t}\n\n\t\t// == if it's `className` or `class`, we merge them\n\t\tif (propName === \"className\" || propName === \"class\") {\n\t\t\toverrideProps[propName] = mergeClassNames(slotPropValue as string, childPropValue as string);\n\t\t\tcontinue;\n\t\t}\n\n\t\tconst isHandler = propName.startsWith(\"on\");\n\n\t\t// == if the handler exists on both, we compose them\n\t\tif (isHandler && isFunction(slotPropValue) && isFunction(childPropValue)) {\n\t\t\toverrideProps[propName] = mergeFunctions(childPropValue, slotPropValue);\n\t\t}\n\t}\n\n\treturn { ...slotProps, ...overrideProps };\n};\n\nexport { mergeTwoProps };\n"]}
|
1
|
+
{"version":3,"sources":["../../../src/utils/composeRefs.ts","../../../src/utils/getSlotElement.ts","../../../src/utils/getSlotMap.ts","../../../src/utils/mergeProps.ts","../../../src/utils/mergeTwoProps.ts"],"names":["SlotComponent","toArray","isValidElement","isFunction","isPlainObject","mergeClassNames","mergeFunctions"],"mappings":";;;;;AAUa,IAAA,MAAA,GAAS,CAAO,GAAA,EAAwB,IAA8C,KAAA;AAClG,EAAA,IAAI,CAAC,GAAK,EAAA;AAEV,EAAI,IAAA,UAAA,CAAW,GAAG,CAAG,EAAA;AACpB,IAAA,OAAO,IAAI,IAAI,CAAA;AAAA;AAIhB,EAAA,GAAA,CAAI,OAAU,GAAA,IAAA;AACf;AAKa,IAAA,WAAA,GAAc,CAC1B,IACuB,KAAA;AACvB,EAAM,MAAA,iBAAA,GAAuC,CAAC,IAAS,KAAA;AACtD,IAAM,MAAA,cAAA,GAAiB,KAAK,GAAI,CAAA,CAAC,QAAQ,MAAO,CAAA,GAAA,EAAK,IAAI,CAAC,CAAA;AAE1D,IAAA,MAAM,YAAY,MAAM,cAAA,CAAe,QAAQ,CAAC,OAAA,KAAY,WAAW,CAAA;AAGvE,IAAA,IAAI,CAAC,IAAM,EAAA;AACV,MAAU,SAAA,EAAA;AACV,MAAA;AAAA;AAGD,IAAO,OAAA,SAAA;AAAA,GACR;AAEA,EAAO,OAAA,iBAAA;AACR;AC7Ba,IAAA,oBAAA,GAAuB,CAAC,KAAA,EAAwBA,cAAuC,KAAA;AACnG,EAAI,IAAA,CAAC,cAAe,CAAA,KAAK,CAAG,EAAA;AAC3B,IAAO,OAAA,KAAA;AAAA;AAGR,EAAI,IAAA,KAAA,CAAM,SAASA,cAAe,EAAA;AACjC,IAAO,OAAA,IAAA;AAAA;AAKR,EAAA,IAAK,KAAM,CAAA,IAAA,EAA+B,UAAgBA,KAAAA,cAAAA,CAA2B,UAAY,EAAA;AAChG,IAAO,OAAA,IAAA;AAAA;AAGR,EAAA,IAAK,KAAM,CAAA,IAAA,CAA6B,IAASA,KAAAA,cAAAA,CAAc,IAAM,EAAA;AACpE,IAAO,OAAA,IAAA;AAAA;AAGR,EAAA,OAAO,KAAM,CAAA,IAAA,CAAK,QAAS,EAAA,KAAMA,eAAc,QAAS,EAAA;AACzD;AAKa,IAAA,uBAAA,GAA0B,CAAC,KAAA,EAAwB,cAA0C,KAAA;AACzG,EAAM,MAAA,WAAA,GAAc,eAAe,IAAK,CAAA,CAACA,mBAAkB,oBAAqB,CAAA,KAAA,EAAOA,cAAa,CAAC,CAAA;AAErG,EAAO,OAAA,WAAA;AACR;AAiBA,IAAM,wBAAA,GAA2B,CAChC,aAAA,EACAA,cACI,KAAA;AACJ,EAAA,IAAI,KAAQ,GAAA,CAAA;AAEZ,EAAA,KAAA,MAAW,SAAS,aAAe,EAAA;AAClC,IAAA,IAAI,CAAC,oBAAA,CAAqB,KAAOA,EAAAA,cAAa,CAAG,EAAA;AAEjD,IAAS,KAAA,IAAA,CAAA;AAAA;AAGV,EAAO,OAAA,KAAA;AACR,CAAA;AAOO,IAAM,gBAAgB,CAC5B,QAAA,EACAA,cACA,EAAA,OAAA,GAAuB,EACnB,KAAA;AACJ,EAAM,MAAA;AAAA,IACL,YAAe,GAAA,mDAAA;AAAA,IACf,wBAA2B,GAAA;AAAA,GACxB,GAAA,OAAA;AAEJ,EAAM,MAAA,aAAA,GAAgB,QAAyB,QAAQ,CAAA;AAEvD,EAAA,MAAM,WACL,GAAA,wBAAA,IAA4B,wBAAyB,CAAA,aAAA,EAAeA,cAAa,CAAI,GAAA,CAAA;AAEtF,EAAA,IAAI,WAAa,EAAA;AAChB,IAAM,MAAA,IAAI,eAAe,YAAY,CAAA;AAAA;AAGtC,EAAM,MAAA,WAAA,GAAc,cAAc,IAAK,CAAA,CAAC,UAAU,oBAAqB,CAAA,KAAA,EAAOA,cAAa,CAAC,CAAA;AAE5F,EAAO,OAAA,WAAA;AACR;AAsBO,IAAM,gBAAmB,GAAA,CAC/B,QACA,EAAA,cAAA,EACA,OACI,KAAA;AAGJ,EAAA,MAAM,EAAE,YAAA,EAAc,wBAAyB,EAAA,GAAI,WAAW,EAAC;AAE/D,EAAA,MAAM,QAAQ,cAAe,CAAA,GAAA;AAAA,IAAI,CAACA,cAAAA,EAAe,KAChD,KAAA,aAAA,CAAc,UAAUA,cAAe,EAAA;AAAA,MACtC,cAAc,OAAQ,CAAA,YAAY,CAAI,GAAA,YAAA,CAAa,KAAK,CAAI,GAAA,YAAA;AAAA,MAC5D,0BAA0B,OAAQ,CAAA,wBAAwB,CACvD,GAAA,wBAAA,CAAyB,KAAK,CAC9B,GAAA;AAAA,KACH;AAAA,GACF;AAEA,EAAM,MAAA,eAAA,GAAkB,kBAAmB,CAAA,QAAA,EAAU,cAAc,CAAA;AAEnE,EAAO,OAAA,EAAE,iBAAiB,KAAM,EAAA;AACjC;AAKa,IAAA,kBAAA,GAAqB,CACjC,QAAA,EACA,yBACI,KAAA;AACJ,EAAM,MAAA,aAAA,GAAgB,QAAyB,QAAQ,CAAA;AAEvD,EAAA,MAAM,kBAAkB,aAAc,CAAA,MAAA;AAAA,IACrC,CAAC,KAAU,KAAA,CAAC,wBAAwB,KAAO,EAAA,OAAA,CAAQ,yBAAyB,CAAC;AAAA,GAC9E;AAEA,EAAO,OAAA,eAAA;AACR;AC1Ia,IAAA,mBAAA,GAAsB,OAAO,eAAe;AAkC5C,IAAA,UAAA,GAAa,CACzB,QACI,KAAA;AACJ,EAAM,MAAA,aAAA,GAAgBC,QAAyB,QAAQ,CAAA;AAEvD,EAAA,MAAM,KAAmF,GAAA;AAAA,IACxF,SAAS;AAAC,GACX;AAEA,EAAA,KAAA,MAAW,SAAS,aAAe,EAAA;AAQlC,IAAM,MAAA,qBAAA,GACLC,eAAiC,KAAK,CAAA,IAClC,MAAM,IAA8B,CAAA,EAAA,KAAO,mBAC5C,IAAA,KAAA,CAAM,KAAM,CAAA,IAAA;AAEhB,IAAA,MAAM,+BACLA,cAAoC,CAAA,KAAK,CAAK,IAAA,KAAA,CAAM,MAAM,gBAAgB,CAAA;AAE3E,IAAI,IAAA,CAAC,qBAAyB,IAAA,CAAC,4BAA8B,EAAA;AAC5D,MAAM,KAAA,CAAA,OAAA,CAAQ,KAAK,KAAK,CAAA;AACxB,MAAA;AAAA;AAGD,IAAA,MAAM,WAAW,qBAAwB,GAAA,KAAA,CAAM,MAAM,IAAO,GAAA,KAAA,CAAM,MAAM,gBAAgB,CAAA;AAExF,IAAM,KAAA,CAAA,QAAQ,CAAI,GAAA,KAAA,CAAM,KAAM,CAAA,QAAA;AAAA;AAG/B,EAAO,OAAA,KAAA;AACR;AA0DO,IAAM,sBAAsB,MAA6D;AAC/F,EAAA,SAASF,eAER,KACC,EAAA;AACD,IAAO,OAAA,IAAA;AAAA;AAGR,EAAAA,eAAc,EAAK,GAAA,mBAAA;AAEnB,EAAOA,OAAAA,cAAAA;AACR;AAKO,IAAM,gBAAgB,mBAAoB;ACpIjD,IAAM,0BAAA,GAA6B,CAClC,YAAA,EACA,WACI,KAAA;AACJ,EAAA,KAAA,MAAW,QAAY,IAAA,MAAA,CAAO,IAAK,CAAA,YAAY,CAAG,EAAA;AACjD,IAAM,MAAA,iBAAA,GAAoB,aAAa,QAAQ,CAAA;AAC/C,IAAM,MAAA,gBAAA,GAAmB,YAAY,QAAQ,CAAA;AAE7C,IAAI,IAAA,QAAA,KAAa,WAAe,IAAA,QAAA,KAAa,OAAS,EAAA;AACrD,MAAA,YAAA,CAAa,QAAQ,CAAA,GAAI,eAAgB,CAAA,iBAAA,EAA6B,gBAA0B,CAAA;AAChG,MAAA;AAAA;AAGD,IAAA,IAAI,aAAa,OAAW,IAAA,aAAA,CAAc,iBAAiB,CAAK,IAAA,aAAA,CAAc,gBAAgB,CAAG,EAAA;AAEhG,MAAA,YAAA,CAAa,QAAQ,CAAI,GAAA,EAAE,GAAG,iBAAA,EAAmB,GAAG,gBAAiB,EAAA;AACrE,MAAA;AAAA;AAGD,IAAM,MAAA,SAAA,GAAY,QAAS,CAAA,UAAA,CAAW,IAAI,CAAA;AAE1C,IAAA,IAAI,aAAaG,UAAW,CAAA,iBAAiB,CAAKA,IAAAA,UAAAA,CAAW,gBAAgB,CAAG,EAAA;AAC/E,MAAA,YAAA,CAAa,QAAQ,CAAA,GAAI,cAAe,CAAA,gBAAA,EAAkB,iBAAiB,CAAA;AAC3E,MAAA;AAAA;AAGD,IAAA,YAAA,CAAa,QAAQ,CAAA,GAAI,gBAAqB,KAAA,MAAA,GAAY,gBAAmB,GAAA,iBAAA;AAAA;AAE/E,CAAA;AAEA,IAAM,uBAAA,GAA0B,CAC/B,YAAA,EACA,WACI,KAAA;AACJ,EAAA,KAAA,MAAW,QAAY,IAAA,MAAA,CAAO,IAAK,CAAA,WAAW,CAAG,EAAA;AAChD,IAAI,IAAA,YAAA,CAAa,QAAQ,CAAA,KAAM,MAAW,EAAA;AACzC,MAAa,YAAA,CAAA,QAAQ,CAAI,GAAA,WAAA,CAAY,QAAQ,CAAA;AAAA;AAC9C;AAEF,CAAA;AAKM,IAAA,UAAA,GAAa,IACf,UAC8B,KAAA;AACjC,EAAA,MAAM,eAAwC,EAAC;AAE/C,EAAA,KAAA,MAAW,eAAe,UAAY,EAAA;AACrC,IAAA,IAAI,CAAC,WAAa,EAAA;AAElB,IAAA,0BAAA,CAA2B,cAAc,WAAW,CAAA;AAGpD,IAAA,uBAAA,CAAwB,cAAc,WAAW,CAAA;AAAA;AAGlD,EAAO,OAAA,YAAA;AACR;ACxFM,IAAA,aAAA,GAAgB,CACrB,SAAA,EACA,UACY,KAAA;AACZ,EAAI,IAAA,CAAC,SAAa,IAAA,CAAC,UAAY,EAAA;AAC9B,IAAO,OAAA,UAAA,IAAc,aAAc,EAAC;AAAA;AAIrC,EAAM,MAAA,aAAA,GAAgB,EAAE,GAAG,UAAW,EAAA;AAEtC,EAAA,KAAA,MAAW,QAAY,IAAA,MAAA,CAAO,IAAK,CAAA,SAAS,CAAG,EAAA;AAC9C,IAAM,MAAA,aAAA,GAAiB,UAAsC,QAAQ,CAAA;AACrE,IAAM,MAAA,cAAA,GAAkB,WAAuC,QAAQ,CAAA;AAGvE,IAAA,IAAI,aAAa,OAAWC,IAAAA,aAAAA,CAAc,aAAa,CAAKA,IAAAA,aAAAA,CAAc,cAAc,CAAG,EAAA;AAC1F,MAAA,aAAA,CAAc,QAAQ,CAAI,GAAA,EAAE,GAAG,aAAA,EAAe,GAAG,cAAe,EAAA;AAChE,MAAA;AAAA;AAID,IAAI,IAAA,QAAA,KAAa,WAAe,IAAA,QAAA,KAAa,OAAS,EAAA;AACrD,MAAA,aAAA,CAAc,QAAQ,CAAA,GAAIC,eAAgB,CAAA,aAAA,EAAyB,cAAwB,CAAA;AAC3F,MAAA;AAAA;AAGD,IAAM,MAAA,SAAA,GAAY,QAAS,CAAA,UAAA,CAAW,IAAI,CAAA;AAG1C,IAAA,IAAI,aAAaF,UAAW,CAAA,aAAa,CAAKA,IAAAA,UAAAA,CAAW,cAAc,CAAG,EAAA;AACzE,MAAA,aAAA,CAAc,QAAQ,CAAA,GAAIG,cAAe,CAAA,cAAA,EAAgB,aAAa,CAAA;AAAA;AACvE;AAGD,EAAA,OAAO,EAAE,GAAG,SAAW,EAAA,GAAG,aAAc,EAAA;AACzC","file":"index.js","sourcesContent":["import { isFunction } from \"@zayne-labs/toolkit-type-helpers\";\nimport type { RefCallback } from \"react\";\n\ntype PossibleRef<TRef> = React.Ref<TRef> | undefined;\n\n/**\n * @description Set a given ref to a given value.\n *\n * This utility takes care of different types of refs: callback refs and RefObject(s)\n */\nexport const setRef = <TRef>(ref: PossibleRef<TRef>, node: TRef): ReturnType<RefCallback<TRef>> => {\n\tif (!ref) return;\n\n\tif (isFunction(ref)) {\n\t\treturn ref(node);\n\t}\n\n\t// eslint-disable-next-line no-param-reassign -- Mutation is needed here\n\tref.current = node;\n};\n\n/**\n * @description A utility to combine refs. Accepts callback refs and RefObject(s)\n */\nexport const composeRefs = <TRef extends HTMLElement>(\n\trefs: Array<PossibleRef<TRef>>\n): RefCallback<TRef> => {\n\tconst mergedRefCallBack: RefCallback<TRef> = (node) => {\n\t\tconst cleanupFnArray = refs.map((ref) => setRef(ref, node));\n\n\t\tconst cleanupFn = () => cleanupFnArray.forEach((cleanup) => cleanup?.());\n\n\t\t// == React 18 may not call the cleanup function so we need to call it manually on element unmount\n\t\tif (!node) {\n\t\t\tcleanupFn();\n\t\t\treturn;\n\t\t}\n\n\t\treturn cleanupFn;\n\t};\n\n\treturn mergedRefCallBack;\n};\n","import { toArray } from \"@zayne-labs/toolkit-core\";\nimport { AssertionError, type UnknownObject, isArray } from \"@zayne-labs/toolkit-type-helpers\";\nimport { isValidElement } from \"react\";\n\nexport type FunctionalComponent<TProps extends UnknownObject = never> = React.FunctionComponent<TProps>;\n\n/**\n * @description Checks if a react child (within the children array) matches the provided SlotComponent using multiple matching strategies:\n * 1. Matches by direct component reference\n * 2. Matches by slot symbol property\n * 3. Matches by stringified component\n * 4. Matches by component name\n */\nexport const matchesSlotComponent = (child: React.ReactNode, SlotComponent: FunctionalComponent) => {\n\tif (!isValidElement(child)) {\n\t\treturn false;\n\t}\n\n\tif (child.type === SlotComponent) {\n\t\treturn true;\n\t}\n\n\ttype WithSlot = { readonly slotSymbol?: unique symbol };\n\n\tif ((child.type as WithSlot | undefined)?.slotSymbol === (SlotComponent as WithSlot).slotSymbol) {\n\t\treturn true;\n\t}\n\n\tif ((child.type as FunctionalComponent).name === SlotComponent.name) {\n\t\treturn true;\n\t}\n\n\treturn child.type.toString() === SlotComponent.toString();\n};\n\n/**\n * @description Checks if a react child (within the children array) matches any of the provided SlotComponents.\n */\nexport const matchesAnySlotComponent = (child: React.ReactNode, SlotComponents: FunctionalComponent[]) => {\n\tconst matchesSlot = SlotComponents.some((SlotComponent) => matchesSlotComponent(child, SlotComponent));\n\n\treturn matchesSlot;\n};\n\ntype SlotOptions = {\n\t/**\n\t * @description The error message to throw when multiple slots are found for a given slot component\n\t */\n\terrorMessage?: string;\n\t/**\n\t * @description When true, an AssertionError will be thrown if multiple slots are found for a given slot component\n\t */\n\tthrowOnMultipleSlotMatch?: boolean;\n};\n\n/**\n * @description Counts how many times a slot component appears in an array of children\n * @internal\n */\nconst calculateSlotOccurrences = (\n\tchildrenArray: React.ReactNode[],\n\tSlotComponent: FunctionalComponent\n) => {\n\tlet count = 0;\n\n\tfor (const child of childrenArray) {\n\t\tif (!matchesSlotComponent(child, SlotComponent)) continue;\n\n\t\tcount += 1;\n\t}\n\n\treturn count;\n};\n\n/**\n * @description Retrieves a single slot element from a collection of React children that matches the provided SlotComponent component.\n *\n * @throws { AssertionError } when throwOnMultipleSlotMatch is true and multiple slots are found\n */\nexport const getSingleSlot = (\n\tchildren: React.ReactNode,\n\tSlotComponent: FunctionalComponent,\n\toptions: SlotOptions = {}\n) => {\n\tconst {\n\t\terrorMessage = \"Only one instance of the SlotComponent is allowed\",\n\t\tthrowOnMultipleSlotMatch = false,\n\t} = options;\n\n\tconst childrenArray = toArray<React.ReactNode>(children);\n\n\tconst shouldThrow =\n\t\tthrowOnMultipleSlotMatch && calculateSlotOccurrences(childrenArray, SlotComponent) > 1;\n\n\tif (shouldThrow) {\n\t\tthrow new AssertionError(errorMessage);\n\t}\n\n\tconst slotElement = childrenArray.find((child) => matchesSlotComponent(child, SlotComponent));\n\n\treturn slotElement;\n};\n\n// NOTE - You can imitate const type parameter by extending readonly[] | []\n\ntype MultipleSlotsOptions = {\n\t/**\n\t * @description The error message to throw when multiple slots are found for a given slot component\n\t * If a string is provided, the same message will be used for all slot components\n\t * If an array is provided, each string in the array will be used as the errorMessage for the corresponding slot component\n\t */\n\terrorMessage?: string | string[];\n\t/**\n\t * @description When true, an AssertionError will be thrown if multiple slots are found for a given slot component\n\t * If a boolean is provided, the same value will be used for all slot components\n\t * If an array is provided, each boolean in the array will be used as the throwOnMultipleSlotMatch value for the corresponding slot component\n\t */\n\tthrowOnMultipleSlotMatch?: boolean | boolean[];\n};\n\n/**\n * @description The same as getSingleSlot, but for multiple slot components\n */\nexport const getMultipleSlots = <const TSlotComponents extends FunctionalComponent[]>(\n\tchildren: React.ReactNode,\n\tSlotComponents: TSlotComponents,\n\toptions?: MultipleSlotsOptions\n) => {\n\ttype SlotsType = { [Key in keyof TSlotComponents]: ReturnType<TSlotComponents[Key]> };\n\n\tconst { errorMessage, throwOnMultipleSlotMatch } = options ?? {};\n\n\tconst slots = SlotComponents.map((SlotComponent, index) =>\n\t\tgetSingleSlot(children, SlotComponent, {\n\t\t\terrorMessage: isArray(errorMessage) ? errorMessage[index] : errorMessage,\n\t\t\tthrowOnMultipleSlotMatch: isArray(throwOnMultipleSlotMatch)\n\t\t\t\t? throwOnMultipleSlotMatch[index]\n\t\t\t\t: throwOnMultipleSlotMatch,\n\t\t})\n\t) as SlotsType;\n\n\tconst regularChildren = getRegularChildren(children, SlotComponents);\n\n\treturn { regularChildren, slots };\n};\n\n/**\n * @description Returns all children that are not slot elements (i.e., don't match any of the provided slot components)\n */\nexport const getRegularChildren = <TChildren extends React.ReactNode>(\n\tchildren: TChildren,\n\tSlotComponentOrComponents: FunctionalComponent | FunctionalComponent[]\n) => {\n\tconst childrenArray = toArray<React.ReactNode>(children);\n\n\tconst regularChildren = childrenArray.filter(\n\t\t(child) => !matchesAnySlotComponent(child, toArray(SlotComponentOrComponents))\n\t);\n\n\treturn regularChildren as TChildren extends unknown[] ? TChildren : TChildren[];\n};\n","import { toArray } from \"@zayne-labs/toolkit-core\";\nimport type { AnyFunction, UnionToIntersection } from \"@zayne-labs/toolkit-type-helpers\";\nimport { isValidElement } from \"react\";\n\n/**\n * Possible children types that can be passed to a slot\n */\ntype PossibleSlotChildrenType =\n\t| AnyFunction<React.ReactNode | React.ReactNode[]>\n\t| React.ReactNode\n\t| React.ReactNode[];\n\n/**\n * Maps slot names to their corresponding children types\n */\ntype GetSlotMapResult<TSlotComponentProps extends GetSlotComponentProps> = UnionToIntersection<{\n\t[TName in keyof TSlotComponentProps as TSlotComponentProps[\"name\"]]: TSlotComponentProps[\"children\"];\n}>;\n\n/**\n * Symbol used to identify SlotComponent instances\n */\nexport const slotComponentSymbol = Symbol(\"SlotComponent\");\n\n/**\n * @description Creates a map of named slots from React children. Returns an object mapping slot names to their children,\n * with a default slot for unmatched children.\n *\n * @example\n * ```tsx\n * import { type GetSlotComponentProps, SlotComponent } from \"@zayne-labs/toolkit-react/utils\"\n *\n * type SlotProps = GetSlotComponentProps<\"header\" | \"footer\">;\n *\n * function Parent({ children }: { children: React.ReactNode }) {\n * const slots = getSlotMap<SlotProps>(children);\n *\n * return (\n * <div>\n * <header>{slots.header}</header>\n * <main>{slots.default}</main>\n * <footer>{slots.footer}</footer>\n * </div>\n * );\n * }\n * ```\n *\n * Usage:\n * ```tsx\n * <Parent>\n * <SlotComponent name=\"header\">Header Content</SlotComponent>\n * <div>Random stuff</div>\n * <SlotComponent name=\"footer\">Footer Content</SlotComponent>\n * </Parent>\n * ```\n */\nexport const getSlotMap = <TSlotComponentProps extends GetSlotComponentProps>(\n\tchildren: React.ReactNode\n) => {\n\tconst childrenArray = toArray<React.ReactNode>(children);\n\n\tconst slots: Record<string, PossibleSlotChildrenType> & { default: React.ReactNode[] } = {\n\t\tdefault: [],\n\t};\n\n\tfor (const child of childrenArray) {\n\t\ttype SlotElementProps = TSlotComponentProps & { \"data-slot-name\": never };\n\n\t\ttype RegularElementProps = Pick<TSlotComponentProps, \"children\"> & {\n\t\t\t\"data-slot-name\": string;\n\t\t\tname: never;\n\t\t};\n\n\t\tconst isSlotElementWithName =\n\t\t\tisValidElement<SlotElementProps>(child)\n\t\t\t&& (child.type as typeof SlotComponent).id === slotComponentSymbol\n\t\t\t&& child.props.name;\n\n\t\tconst isRegularElementWithSlotName =\n\t\t\tisValidElement<RegularElementProps>(child) && child.props[\"data-slot-name\"];\n\n\t\tif (!isSlotElementWithName && !isRegularElementWithSlotName) {\n\t\t\tslots.default.push(child);\n\t\t\tcontinue;\n\t\t}\n\n\t\tconst slotName = isSlotElementWithName ? child.props.name : child.props[\"data-slot-name\"];\n\n\t\tslots[slotName] = child.props.children;\n\t}\n\n\treturn slots as GetSlotMapResult<TSlotComponentProps> & { default: React.ReactNode[] };\n};\n\n/**\n * @description Produce props for the SlotComponent\n */\nexport type GetSlotComponentProps<\n\tTName extends string = string,\n\tTChildren extends PossibleSlotChildrenType = PossibleSlotChildrenType,\n> = {\n\t/** Content to render in the slot */\n\tchildren: TChildren;\n\t/** Name of the slot where content should be rendered */\n\tname: TName;\n};\n\n/**\n * @description Function used to create a slot component that defines named slots in a parent component. This component created doesn't render anything,\n * it's used purely for slot definition.\n *\n * @example\n * ```tsx\n * import { type GetSlotComponentProps, createSlotComponent, SlotComponent } from \"@zayne-labs/toolkit-react/utils\"\n *\n * type SlotProps = GetSlotComponentProps<\"header\" | \"footer\">;\n *\n * function Parent({ children }: { children: React.ReactNode }) {\n * const slots = getSlotMap<SlotProps>(children);\n *\n * return (\n * <div>\n * <header>{slots.header}</header>\n * <main>{slots.default}</main>\n * <footer>{slots.footer}</footer>\n * </div>\n * );\n * }\n *\n * Parent.Slot = createSlotComponent<SlotProps>();\n * // OR\n * Parent.Slot = SlotComponent<SlotProps>\n * ```\n *\n *\n * @example\n * Usage:\n\t```tsx\n * function App() {\n * return (\n * <Parent>\n * <Parent.Slot name=\"header\">Header Content</Parent.Slot>\n * <div>Default Content</div>\n * <Parent.Slot name=\"footer\">Footer Content</Parent.Slot>\n * </Parent>\n * );\n * }\n * ```\n */\n\nexport const createSlotComponent = <TBaseSlotComponentProps extends GetSlotComponentProps>() => {\n\tfunction SlotComponent<TSlotComponentProps extends TBaseSlotComponentProps>(\n\t\t// eslint-disable-next-line ts-eslint/no-unused-vars -- The props here are just for type definition really, as this component doesn't need to render anything\n\t\tprops: TSlotComponentProps\n\t) {\n\t\treturn null as React.ReactNode;\n\t}\n\n\tSlotComponent.id = slotComponentSymbol;\n\n\treturn SlotComponent;\n};\n\n/**\n * @description Slot component created by createSlotComponent\n */\nexport const SlotComponent = createSlotComponent();\n","import { mergeClassNames, mergeFunctions } from \"@zayne-labs/toolkit-core\";\nimport { isFunction, isPlainObject } from \"@zayne-labs/toolkit-type-helpers\";\n\n// const CSS_REGEX = /((?:--)?(?:\\w+-?)+)\\s*:\\s*([^;]*)/g;\n\n// const serialize = (style: string): Record<string, string> => {\n// \tconst res: Record<string, string> = {};\n// \tlet match: RegExpExecArray | null;\n// \twhile ((match = CSS_REGEX.exec(style))) {\n// \t\tres[match[1]!] = match[2]!;\n// \t}\n// \treturn res;\n// };\n\n// const css = (\n// \ta: Record<string, string> | string | undefined,\n// \tb: Record<string, string> | string | undefined\n// ): Record<string, string> | string => {\n// \tif (isString(a)) {\n// \t\tif (isString(b)) return `${a};${b}`;\n// \t\ta = serialize(a);\n// \t} else if (isString(b)) {\n// \t\tb = serialize(b);\n// \t}\n// \treturn Object.assign({}, a ?? {}, b ?? {});\n// };\n\ntype UnionToIntersection<TUnion> = (TUnion extends unknown ? (param: TUnion) => void : \"\") extends (\n\tparam: infer TParam\n) => void\n\t? TParam\n\t: \"\";\n\n/* eslint-disable no-param-reassign -- Mutation is fine here since it's an internally managed object */\nconst handleMergePropsIntoResult = (\n\tmergedResult: Record<string, unknown>,\n\tpropsObject: Record<string, unknown>\n) => {\n\tfor (const propName of Object.keys(mergedResult)) {\n\t\tconst mergedResultValue = mergedResult[propName];\n\t\tconst propsObjectValue = propsObject[propName];\n\n\t\tif (propName === \"className\" || propName === \"class\") {\n\t\t\tmergedResult[propName] = mergeClassNames(mergedResultValue as string, propsObjectValue as string);\n\t\t\tcontinue;\n\t\t}\n\n\t\tif (propName === \"style\" && isPlainObject(mergedResultValue) && isPlainObject(propsObjectValue)) {\n\t\t\t// mergedResult[propName] = css(mergedResultValue, propsObjectValue);\n\t\t\tmergedResult[propName] = { ...mergedResultValue, ...propsObjectValue };\n\t\t\tcontinue;\n\t\t}\n\n\t\tconst isHandler = propName.startsWith(\"on\");\n\n\t\tif (isHandler && isFunction(mergedResultValue) && isFunction(propsObjectValue)) {\n\t\t\tmergedResult[propName] = mergeFunctions(propsObjectValue, mergedResultValue);\n\t\t\tcontinue;\n\t\t}\n\n\t\tmergedResult[propName] = propsObjectValue !== undefined ? propsObjectValue : mergedResultValue;\n\t}\n};\n\nconst addMissingPropsToResult = (\n\tmergedResult: Record<string, unknown>,\n\tpropsObject: Record<string, unknown>\n) => {\n\tfor (const propName of Object.keys(propsObject)) {\n\t\tif (mergedResult[propName] === undefined) {\n\t\t\tmergedResult[propName] = propsObject[propName];\n\t\t}\n\t}\n};\n/* eslint-enable no-param-reassign -- Mutation is fine here since it's an internally managed object */\n\ntype UnknownProps = Record<never, never>;\n\nconst mergeProps = <TProps extends UnknownProps>(\n\t...parameters: Array<TProps | undefined>\n): UnionToIntersection<TProps> => {\n\tconst mergedResult: Record<string, unknown> = {};\n\n\tfor (const propsObject of parameters) {\n\t\tif (!propsObject) continue;\n\n\t\thandleMergePropsIntoResult(mergedResult, propsObject);\n\n\t\t// == Add props from propsObject that are not in the mergedResult\n\t\taddMissingPropsToResult(mergedResult, propsObject);\n\t}\n\n\treturn mergedResult as never;\n};\n\nexport { mergeProps };\n","import { mergeClassNames, mergeFunctions } from \"@zayne-labs/toolkit-core\";\nimport { isFunction, isPlainObject } from \"@zayne-labs/toolkit-type-helpers\";\n\ntype UnknownProps = Record<never, never>;\n\nconst mergeTwoProps = <TProps extends UnknownProps>(\n\tslotProps: TProps | undefined,\n\tchildProps: TProps | undefined\n): TProps => {\n\tif (!slotProps || !childProps) {\n\t\treturn childProps ?? slotProps ?? ({} as TProps);\n\t}\n\n\t// == all child props should override slotProps\n\tconst overrideProps = { ...childProps } as Record<string, unknown>;\n\n\tfor (const propName of Object.keys(slotProps)) {\n\t\tconst slotPropValue = (slotProps as Record<string, unknown>)[propName];\n\t\tconst childPropValue = (childProps as Record<string, unknown>)[propName];\n\n\t\t// == if it's `style`, we merge them\n\t\tif (propName === \"style\" && isPlainObject(slotPropValue) && isPlainObject(childPropValue)) {\n\t\t\toverrideProps[propName] = { ...slotPropValue, ...childPropValue };\n\t\t\tcontinue;\n\t\t}\n\n\t\t// == if it's `className` or `class`, we merge them\n\t\tif (propName === \"className\" || propName === \"class\") {\n\t\t\toverrideProps[propName] = mergeClassNames(slotPropValue as string, childPropValue as string);\n\t\t\tcontinue;\n\t\t}\n\n\t\tconst isHandler = propName.startsWith(\"on\");\n\n\t\t// == if the handler exists on both, we compose them\n\t\tif (isHandler && isFunction(slotPropValue) && isFunction(childPropValue)) {\n\t\t\toverrideProps[propName] = mergeFunctions(childPropValue, slotPropValue);\n\t\t}\n\t}\n\n\treturn { ...slotProps, ...overrideProps };\n};\n\nexport { mergeTwoProps };\n"]}
|
package/package.json
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
{
|
2
2
|
"name": "@zayne-labs/toolkit-react",
|
3
3
|
"type": "module",
|
4
|
-
"version": "0.9.
|
4
|
+
"version": "0.9.6",
|
5
5
|
"description": "A collection of utility functions, types and composables used by my other projects. Nothing too fancy but can be useful.",
|
6
6
|
"author": "Ryan Zayne",
|
7
7
|
"license": "MIT",
|
@@ -50,8 +50,8 @@
|
|
50
50
|
}
|
51
51
|
},
|
52
52
|
"dependencies": {
|
53
|
-
"@zayne-labs/toolkit-
|
54
|
-
"@zayne-labs/toolkit-
|
53
|
+
"@zayne-labs/toolkit-type-helpers": "0.9.6",
|
54
|
+
"@zayne-labs/toolkit-core": "0.9.6"
|
55
55
|
},
|
56
56
|
"devDependencies": {
|
57
57
|
"@arethetypeswrong/cli": "^0.17.4",
|