payload
Version:
Node, React and MongoDB Headless CMS and Application Framework
24 lines • 1.06 kB
TypeScript
import React from 'react';
/**
* Creates a higher-order component (HOC) that merges predefined properties (`toMergeIntoProps`)
* with any properties passed to the resulting component.
*
* Use this when you want to pre-specify some props for a component, while also allowing users to
* pass in their own props. The HOC ensures the passed props and predefined props are combined before
* rendering the original component.
*
* @example
* const PredefinedComponent = getMergedPropsComponent({
* Component: OriginalComponent,
* toMergeIntoProps: { someExtraValue: 5 }
* });
* // Using <PredefinedComponent customProp="value" /> will result in
* // <OriginalComponent customProp="value" someExtraValue={5} />
*
* @returns A higher-order component with combined properties.
*/
export declare function withMergedProps<ToMergeIntoProps, CompleteReturnProps>({ Component, toMergeIntoProps, }: {
Component: React.FC<CompleteReturnProps>;
toMergeIntoProps: ToMergeIntoProps;
}): React.FC<CompleteReturnProps>;
//# sourceMappingURL=index.d.ts.map