@lens-protocol/react
Version:
Interacting with the Lens Protocol API using React.
30 lines (29 loc) • 976 B
TypeScript
import { Profile } from '@lens-protocol/api-bindings';
import { UseDeferredTask } from "../helpers/tasks.js";
export type UseRecommendProfileToggleArgs = {
profile: Profile;
};
/**
* This hook enables you to either recommend a peer profile or withdraw a previous recommendation.
*
* You MUST be authenticated via {@link useLogin} to use this hook.
*
* @example
* ```tsx
* import { Profile, useRecommendProfileToggle } from '@lens-protocol/react-web';
*
* function ProfileRecommendation({ profile }: { profile: Profile }) {
* const { execute: toggle, loading } = useRecommendProfileToggle();
*
* return (
* <button onClick={() => toggle({ profile })} disabled={loading}>
* {profile.peerToPeerRecommendedByMe ? `Remove recommendation` : `Recommend`}
* </button>
* );
* }
* ```
*
* @category Profiles
* @group Hooks
*/
export declare function useRecommendProfileToggle(): UseDeferredTask<void, never, UseRecommendProfileToggleArgs>;