File size: 2,545 Bytes
1e92f2d | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 | import React, { Fragment } from 'react';
import { useDynamicWidgets } from '../connectors/useDynamicWidgets';
import { invariant } from '../lib/invariant';
import type { DynamicWidgetsConnectorParams } from 'instantsearch.js/es/connectors/dynamic-widgets/connectDynamicWidgets';
import type { ReactElement, ComponentType, ReactNode } from 'react';
function FallbackComponent() {
return null;
}
type AtLeastOne<
TTarget,
TMapped = { [Key in keyof TTarget]: Pick<TTarget, Key> }
> = Partial<TTarget> & TMapped[keyof TMapped];
export type DynamicWidgetsProps = Omit<
DynamicWidgetsConnectorParams,
'widgets' | 'fallbackWidget'
> &
AtLeastOne<{
children: ReactNode;
fallbackComponent: ComponentType<{ attribute: string }>;
}>;
export function DynamicWidgets({
children,
fallbackComponent: Fallback = FallbackComponent,
...props
}: DynamicWidgetsProps) {
const { attributesToRender } = useDynamicWidgets(props, {
$$widgetType: 'ais.dynamicWidgets',
});
const widgets: Map<string, ReactNode> = new Map();
React.Children.forEach(children, (child) => {
const attribute = getWidgetAttribute(child);
invariant(
attribute !== undefined,
`<DynamicWidgets> only supports InstantSearch widgets with an \`attribute\` or \`attributes\` prop.`
);
widgets.set(attribute, child);
});
return (
<>
{attributesToRender.map((attribute) => (
<Fragment key={attribute}>
{widgets.get(attribute) || <Fallback attribute={attribute} />}
</Fragment>
))}
</>
);
}
function isReactElement(element: any): element is ReactElement {
return typeof element === 'object' && element.props;
}
function getWidgetAttribute(element: ReactNode): string | undefined {
if (!isReactElement(element)) {
return undefined;
}
if (element.props.attribute) {
return element.props.attribute;
}
if (Array.isArray(element.props.attributes)) {
return element.props.attributes[0];
}
if (element.props.children) {
invariant(
React.Children.count(element.props.children) === 1,
`<DynamicWidgets> only supports a single component in nested components. Make sure to not render multiple children in a parent component.
Example of an unsupported scenario:
\`\`\`
<DynamicWidgets>
<MyComponent>
<RefinementList attribute="brand" />
<Menu attribute="categories" />
</MyComponent>
</DynamicWidgets>
\`\`\`
`
);
return getWidgetAttribute(React.Children.only(element.props.children));
}
return undefined;
}
|