@jinglescode/nostr-chat-plugin
v0.0.11
Published
A chat room React component that uses NOSTR protocol for messaging.
Downloads
28
Readme
Nostr Chat Provider
A chat room React component that uses NOSTR protocol for messaging.
Usage
Install the package using npm:
npm install @jinglescode/nostr-chat-plugin
In your _app.tsx
file, import NostrChatProvider
and wrap your component with it:
import { NostrChatProvider } from "@jinglescode/nostr-chat-plugin";
export default function App({ Component, pageProps }: AppProps) {
return (
<NostrChatProvider>
<Component {...pageProps} />
</NostrChatProvider>
);
}
To use the chat component, import useNostrChat
:
import { useNostrChat } from "@jinglescode/nostr-chat-plugin";
const { subscribeRoom, publishMessage, messages, generateNsec, setUser } =
useNostrChat();
API
First, depending if your user has a nostr key, if not, you can generate one:
const {
nsec: string;
pubkey: string;
} = generateNsec();
For users that already have a nostr key, you can set it:
setUser({
nsec: nsec,
pubkey: pubkey,
});
Then, when user enters a page with chat, you can subscribe to a room ID:
subscribeRoom("room-id-here");
Doing so will populate and listen for new messages
from the room.
When the connected user wants to send a message, they can publish a message to the room:
publishMessage("message here");