Hopp over til hovedinnhold

React Hooks

bitsocial-react-hooks-pakken gir en kjent React hooks API for samhandling med Bitsocial-protokollen. Den håndterer henting av feeder, kommentarer og forfatterprofiler, administrerer kontoer, publiserer innhold og abonnerer på fellesskap – alt uten å stole på en sentral server.

Dette biblioteket er det primære grensesnittet som brukes av 5chan og andre Bitsocial-klientapplikasjoner.

merknad

bitsocial-react-hooks forbrukes for øyeblikket direkte fra GitHub i stedet for publisert til npm.

Installasjon​

Fordi pakken ennå ikke er på npm, installer den direkte fra GitHub, fest til en spesifikk commit-hash:

yarn add https://github.com/bitsocialnet/bitsocial-react-hooks.git#<commit-hash>

Erstatt <commit-hash> med forpliktelsen du vil målrette mot.

API-oversikt​

Krokene er organisert i funksjonelle kategorier. Nedenfor er en oppsummering av de mest brukte krokene i hver kategori. For fullstendige signaturer, parametere og returtyper, se full API-referanse på GitHub.

Kontoer​

Administrer lokale brukerkontoer, identitet og innstillinger.

  • useAccount(accountName?) -- returnerer det aktive (eller navngitte) kontoobjektet
  • useAccounts() -- returnerer alle lokalt lagrede kontoer
  • useAccountComments(options?) -- returnerer kommentarer publisert av den aktive kontoen

Kommentarer​

Hent og samhandle med individuelle kommentarer og tråder.

  • useComment(commentCid?) -- henter en enkelt kommentar ved sin kunde-ID
  • useComments(commentCids?) -- henter flere kommentarer i batch
  • useEditedComment(comment?) -- returnerer den siste redigerte versjonen av en kommentar

Fellesskap​

Hent fellesskapsmetadata og -innstillinger.

  • Single-community lookup hook – henter et fellesskap etter adresse
  • Oppslagskrok for flere fellesskap -- henter flere fellesskap
  • Hook for fellesskapsstatistikk – returnerer antall abonnenter og innlegg

Forfattere​

Slå opp forfatterprofiler og metadata.

  • useAuthor(authorAddress?) -- henter en forfatterprofil
  • useAuthorComments(options?) -- returnerer kommentarer fra en bestemt forfatter
  • useResolvedAuthorAddress(authorAddress?) -- løser en menneskelesbar adresse (f.eks. ENS) til dens protokolladresse

Innmatinger​

Abonner på og paginer innholdsfeeder.

  • useFeed(options?) -- returnerer en paginert feed med innlegg fra ett eller flere fellesskap
  • useBufferedFeeds(feedOptions?) -- forhåndsbufferer flere feeder for raskere gjengivelse
  • useAuthorFeed(authorAddress?) -- returnerer en feed med innlegg av en bestemt forfatter

Handlinger​

Publiser innhold og utfør skriveoperasjoner.

  • usePublishComment(options?) -- publiser en ny kommentar eller svar
  • usePublishVote(options?) -- avgi en opp- eller nedstemme
  • useSubscribe(options?) -- abonner eller avregistrer et fellesskap

stater og RPC​

Overvåk tilkoblingstilstand og samhandle med en ekstern Bitsocial-demon.

  • useClientsStates(options?) -- returnerer tilkoblingstilstanden til IPFS/pubsub-klienter
  • RPC-innstillingshok -- returnerer gjeldende RPC-daemonkonfigurasjon

Utvikling​

Slik jobber du med hooks-biblioteket lokalt:

Forutsetninger: Node.js, Corepack aktivert, Garn 4

git clone https://github.com/bitsocialnet/bitsocial-react-hooks.git
cd bitsocial-react-hooks
corepack enable
yarn install

Se repository README for test- og byggekommandoer.

Lenker​