Package Exports
- next-client-utils
- next-client-utils/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (next-client-utils) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
next-client-utils
π§© Utilities to bridge server and client components seamlessly in Next.js apps.
β¨ Features
- π±οΈ Interactive popups: Trigger popups on click or hover for any element.
- βοΈ SSR-friendly: Keep elements server-side rendered while using
WithPopup
. - π Server-side popup rendering: Dynamically generate popup content via
renderSSRPopUp
. - π― Customizable positioning: Fine-tune popup placement using flexible props.
- πͺ Essential React hooks: Includes
useOutsideClick
,useElementPositionChange
, and more. - π Debounce utility: Built-in and fully customizable debounce mechanism.
- π§± Column listing UI pattern: Automatically animates updated rows to the topβideal for chat or feed-style interfaces.
- β‘ Next.js-ready: Works out of the box with Server and Client Components.
π What does it look like?
// Server Component (module-1)
import { WithPopup } from 'next-client-utils';
export default function ServerComponent() {
return (
<WithPopup
PopUp={PopUp}
popupProps={{}} // Pass `{}` if your popup is typed as React.FC<{}>
triggerType="hover" // Optional, defaults to "click"
>
<div>Open PopUp</div>
</WithPopup>
);
}
// Client Component (module-2)
'use client';
type PopUpProp={
close?: () => void // make sure you make it optional or else typescript will throw error.
}
const PopUp: React.FC<PopUpProp> = (props) => {
// use props.close() to close modal
return <div><p>This is PopUp</p>
<button onClick={props.close?.()}>Close</button>
</div>; // Style this as needed
};
π Another Example?
// Server Component (module-1)
import { WithPopup } from 'next-client-utils';
export default function ServerComponent() {
return (
<WithPopup
PopUp={ProfileDetailPopUp}
popupProps={{
firstName: "Prateek",
lastName: "Sharma",
}}
gap={15} // Optional spacing between trigger and popup
childrenWrapperComponent={UserName}
>
<>SSR Text</>
</WithPopup>
);
}
// Client Components (module-2)
'use client';
type ProfileDetailPopUpProps = {
firstName: string;
lastName: string;
};
const ProfileDetailPopUp: React.FC<ProfileDetailPopUpProps> = ({ firstName, lastName }) => {
return <div>This is PopUp</div>; // Use props as needed
};
type UserNameProps = {
isPopUpActive: boolean; // Provided automatically
children: React.ReactNode;
};
const UserName: React.FC<UserNameProps> = ({ isPopUpActive, children }) => {
// Use isPopUpActive to apply dynamic styles
return <div>{children}</div>; // Receives 'SSR Text' as children
};
π§ Example: Rendering a Server Component as a Popup
// Server Component (module-1)
import {WithPopup} from 'next-client-utils';
export default function ServerComponent(props: any) {
// Define server-rendered popup via 'use server' function
const renderSSRPopUp = async (popupProps: any) => {
'use server';
return <AnotherServerComponent {...popupProps} />;
};
return (
<WithPopup
renderSSRPopUp={renderSSRPopUp}
popupProps={props} // Pass required props here
triggerType="hover" // Optional
>
<div>Open PopUp</div>
</WithPopup>
);
}
// Another Server Component (module-2)
export default function AnotherServerComponent(props: any) {
// Fetch data or perform server-side logic here
return <div>This PopUp is server-rendered</div>;
}
npm install next-client-utils
# or
yarn add next-client-utils
π€ Support
If you face any issues during integration or come across a bug, feel free to reach out to me on LinkedIn β happy to help!