{"id":50375275,"url":"https://github.com/jordan-sussman/phoenix-presence-react","last_synced_at":"2026-05-30T09:03:05.720Z","repository":{"id":360052328,"uuid":"1248516493","full_name":"jordan-sussman/phoenix-presence-react","owner":"jordan-sussman","description":"A lightweight React hook for real-time presence tracking with Elixir Phoenix Channels","archived":false,"fork":false,"pushed_at":"2026-05-24T19:05:47.000Z","size":135,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-24T20:26:14.200Z","etag":null,"topics":["elixir","elixir-phoenix","phoenix","presence","react","react-hooks","real-time"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jordan-sussman.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-05-24T18:39:22.000Z","updated_at":"2026-05-24T19:05:58.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/jordan-sussman/phoenix-presence-react","commit_stats":null,"previous_names":["jordan-sussman/phoenix-presence-react"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/jordan-sussman/phoenix-presence-react","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jordan-sussman%2Fphoenix-presence-react","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jordan-sussman%2Fphoenix-presence-react/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jordan-sussman%2Fphoenix-presence-react/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jordan-sussman%2Fphoenix-presence-react/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jordan-sussman","download_url":"https://codeload.github.com/jordan-sussman/phoenix-presence-react/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jordan-sussman%2Fphoenix-presence-react/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33686020,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-30T02:00:06.278Z","response_time":92,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["elixir","elixir-phoenix","phoenix","presence","react","react-hooks","real-time"],"created_at":"2026-05-30T09:03:03.807Z","updated_at":"2026-05-30T09:03:05.703Z","avatar_url":"https://github.com/jordan-sussman.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# phoenix-presence-react\n\nReact hook for [Phoenix Presence](https://hexdocs.pm/phoenix/Phoenix.Presence.html). Tracks who's online in real time via Phoenix channels.\n\nScreenshot from example app:\n\n\u003cimg src=\"example/example-screenshot.png\" width=\"600\"\u003e\n\n\n## Install\n\n```bash\nnpm install phoenix-presence-react\n```\n\n## Usage\n\n```tsx\nimport { usePresence } from \"phoenix-presence-react\";\n\nfunction OnlineUsers({\n  userId,\n  userName,\n}: {\n  userId: string;\n  userName: string;\n}) {\n  const { presence, isJoined } = usePresence({\n    topic: \"presence:lobby\",\n    params: { token: \"user-token\" }, // params passed to your Elixir channel's join/3\n  });\n\n  return (\n    \u003cdiv\u003e\n      \u003cdiv className={isJoined ? \"status-online\" : \"status-connecting\"} /\u003e\n      {presence.map((user) =\u003e (\n        \u003cAvatar\n          key={user.id}\n          name={user.name} // 'name' comes from metadata tracked in Elixir\n        /\u003e\n      ))}\n    \u003c/div\u003e\n  );\n}\n```\n\n### Build\n\nTo compile the library:\n\n```bash\nnpm install\nnpm run build\n```\n\n### Running the Example\n\nThe example uses a `mock-phoenix` implementation to simulate presence events without requiring a live Elixir backend.\n\n\nTo run the provided example app from screenshot:\n\n```bash\ncd example\nnpm install\nnpm run dev\n```\n\n## Advanced Usage\n\n### Typed Metadata\n\n```tsx\ninterface MyMeta {\n  name: string;\n  avatar_url: string;\n}\n\n// 'presence' will be typed as (MyMeta \u0026 { id: string })[]\nconst { presence } = usePresence\u003cMyMeta\u003e({ topic: \"room\" });\n```\n\n### Callbacks for side effects\n\n```tsx\nusePresence({\n  topic: \"room\",\n  onJoin: (id, current, newPres) =\u003e {\n    console.log(`${newPres.metas[0].name} joined!`);\n  },\n  onLeave: (id, current, leftPres) =\u003e {\n    console.log(`${leftPres.metas[0].name} left!`);\n  },\n});\n```\n\n### Access raw Presence state\n\n```tsx\nconst { state } = usePresence({ topic: \"room\" });\n/* \nstate is the raw Phoenix Record:\n{\n  \"user-1\": { metas: [{ name: \"Alice\", phx_ref: \"...\" }] },\n  \"user-2\": { metas: [{ name: \"Bob\", phx_ref: \"...\" }] }\n}\n*/\n```\n\n## Options\n\n```ts\nusePresence({\n  topic: \"presence:lobby\", // Default: \"presence:lobby\"\n  params: { token: \"...\" }, // Params for socket/channel\n  socketUrl: \"/socket\", // Default: \"/socket\" (only used if no socket/channel provided)\n  socket: externalSocket, // Optional: provide existing Phoenix Socket\n  channel: externalChannel, // Optional: provide existing Phoenix Channel\n});\n```\n\n## Return value\n\n```ts\n{\n  presence: (PresenceMeta \u0026 { id: string })[], // Flattened list of online users\n  state: Record\u003cstring, { metas: any[] }\u003e,     // Raw Phoenix presence state\n  isJoined: boolean,                           // Channel join status\n  error: Error | null,                         // Join error\n}\n```\n\n## Required Elixir backend\n\nYou need a Phoenix channel using `Phoenix.Presence`.\n\n### 1. Define your Presence module\n\n```elixir\ndefmodule MyAppWeb.Presence do\n  use Phoenix.Presence,\n    otp_app: :my_app,\n    pubsub_server: MyApp.PubSub\nend\n```\n\n### 2. Update your Channel\n\n```elixir\ndefmodule MyAppWeb.PresenceChannel do\n  use MyAppWeb, :channel\n  alias MyAppWeb.Presence\n\n  def join(\"presence:lobby\", _params, socket) do\n    send(self(), :after_join)\n    {:ok, socket}\n  end\n\n  def handle_info(:after_join, socket) do\n    {:ok, _} = Presence.track(socket, socket.assigns.user_id, %{\n      online_at: System.os_time(:second),\n      name: socket.assigns.user_name\n    })\n    push(socket, \"presence_state\", Presence.list(socket))\n    {:noreply, socket}\n  end\nend\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjordan-sussman%2Fphoenix-presence-react","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjordan-sussman%2Fphoenix-presence-react","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjordan-sussman%2Fphoenix-presence-react/lists"}