Μετάβαση στο κύριο περιεχόμενο

React Hooks

Το πακέτο bitsocial-react-hooks παρέχει ένα οικείο React hooks API για αλληλεπίδραση με το πρωτόκολλο Bitsocial. Διαχειρίζεται τη λήψη ροών, σχολίων και προφίλ συντακτών, τη διαχείριση λογαριασμών, τη δημοσίευση περιεχομένου και την εγγραφή σε κοινότητες -- όλα αυτά χωρίς να βασίζεται σε κεντρικό διακομιστή.

Αυτή η βιβλιοθήκη είναι η κύρια διεπαφή που χρησιμοποιείται από το 5καν και άλλες εφαρμογές πελάτη Bitsocial.

σημείωμα

Το bitsocial-react-hooks καταναλώνεται αυτήν τη στιγμή απευθείας από το GitHub αντί να δημοσιεύεται σε npm.

Εγκατάσταση​

Επειδή το πακέτο δεν είναι ακόμα σε npm, εγκαταστήστε το απευθείας από το GitHub, καρφιτσώνοντας σε ένα συγκεκριμένο commit hash:

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

Αντικαταστήστε το <commit-hash> με την δέσμευση που θέλετε να στοχεύσετε.

Επισκόπηση API​

Τα άγκιστρα είναι οργανωμένα σε λειτουργικές κατηγορίες. Παρακάτω είναι μια σύνοψη των πιο συχνά χρησιμοποιούμενων γάντζων σε κάθε κατηγορία. Για πλήρεις υπογραφές, παραμέτρους και τύπους επιστροφής, δείτε το πλήρης αναφοράς API στο GitHub.

Λογαριασμοί​

Διαχειριστείτε τοπικούς λογαριασμούς χρηστών, ταυτότητα και ρυθμίσεις.

  • useAccount(accountName?) -- επιστρέφει το ενεργό (ή επώνυμο) αντικείμενο λογαριασμού
  • useAccounts() -- επιστρέφει όλους τους τοπικά αποθηκευμένους λογαριασμούς
  • useAccountComments(options?) -- επιστρέφει σχόλια που δημοσιεύονται από τον ενεργό λογαριασμό

Σχόλια​

Λήψη και αλληλεπίδραση με μεμονωμένα σχόλια και νήματα.

  • useComment(commentCid?) -- ανακτά ένα μόνο σχόλιο από το CID του
  • useComments(commentCids?) -- ανακτά πολλαπλά σχόλια ομαδικά
  • useEditedComment(comment?) -- επιστρέφει την πιο πρόσφατη επεξεργασμένη έκδοση ενός σχολίου

Κοινότητες​

Ανάκτηση μεταδεδομένων και ρυθμίσεων κοινότητας.

  • Άγκιστρο αναζήτησης μιας κοινότητας -- ανακτά μια κοινότητα ανά διεύθυνση
  • Άγκιστρο αναζήτησης πολλών κοινοτήτων -- ανακτά πολλές κοινότητες
  • Άγκιστρο στατιστικών κοινότητας -- επιστρέφει πλήθος συνδρομητών και αναρτήσεων

Συγγραφείς​

Αναζητήστε προφίλ συντακτών και μεταδεδομένα.

  • useAuthor(authorAddress?) -- ανακτά ένα προφίλ συντάκτη
  • useAuthorComments(options?) -- επιστρέφει σχόλια από συγκεκριμένο συγγραφέα
  • useResolvedAuthorAddress(authorAddress?) -- επιλύει μια αναγνώσιμη από τον άνθρωπο διεύθυνση (π.χ. ENS) στη διεύθυνση πρωτοκόλλου της

Τροφοδοσίες​

Εγγραφείτε και σελιδοποιήστε τις ροές περιεχομένου.

  • useFeed(options?) -- επιστρέφει μια σελιδοποιημένη ροή αναρτήσεων από μία ή περισσότερες κοινότητες
  • useBufferedFeeds(feedOptions?) -- αποθηκεύει εκ των προτέρων πολλές τροφοδοσίες για ταχύτερη απόδοση
  • useAuthorFeed(authorAddress?) -- επιστρέφει μια ροή αναρτήσεων από έναν συγκεκριμένο συγγραφέα

Δράσεις​

Δημοσιεύστε περιεχόμενο και εκτελέστε λειτουργίες εγγραφής.

  • usePublishComment(options?) -- δημοσιεύστε ένα νέο σχόλιο ή απάντηση
  • usePublishVote(options?) -- ψηφίστε θετικά ή αρνητικά
  • useSubscribe(options?) -- εγγραφείτε ή διαγραφείτε από μια κοινότητα

κράτη και RPC​

Παρακολουθήστε την κατάσταση σύνδεσης και αλληλεπιδράστε με έναν απομακρυσμένο δαίμονα Bitsocial.

  • useClientsStates(options?) -- επιστρέφει την κατάσταση σύνδεσης των πελατών IPFS/pubsub
  • Άγκιστρο ρυθμίσεων RPC -- επιστρέφει την τρέχουσα διαμόρφωση δαίμονα RPC

Ανάπτυξη​

Για να εργαστείτε στη βιβλιοθήκη hooks τοπικά:

Προαπαιτούμενα: Node.js, Corepack ενεργοποιημένο, Yarn 4

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

Ανατρέξτε στο αποθετήριο README για εντολές δοκιμής και κατασκευής.

Σύνδεσμοι​