Перейти до основного вмісту

React Hooks

Застаріле найменування

У цьому пакеті наразі використовуються застарілі угоди про іменування, успадковані від його вихідного форка. Посилання на «plebbit» у коді, API та конфігурації буде переміщено до «bitsocial» у майбутньому випуску. Функціональність не змінена.

Пакет bitsocial-react-hooks надає знайомий API хуків React для взаємодії з протоколом Bitsocial. Він обробляє отримання каналів, коментарів і профілів авторів, керування обліковими записами, публікацію вмісту та підписку на спільноти — і все це не покладається на центральний сервер.

Ця бібліотека є основним інтерфейсом, який використовується 5chan та іншими клієнтськими програмами Bitsocial.

примітка

bitsocial-react-hooks — це тимчасовий форк plebbit/plebbit-react-hooks, який підтримується для розробки за допомогою ШІ. Він використовується безпосередньо з GitHub, а не публікується в npm.

монтаж​

Оскільки пакет ще не на npm, встановіть його безпосередньо з GitHub, прикріпивши до певного хешу коміту:

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?) -- повертає останню відредаговану версію коментаря

Спільноти​

Отримати метадані та налаштування спільноти.

  • useSubplebbit(subplebbitAddress?) -- отримує спільноту за адресою
  • useSubplebbits(subplebbitAddresses?) -- отримує кілька спільнот
  • useSubplebbitStats(subplebbitAddress?) -- повертає кількість підписок і публікацій

Автори​

Перегляньте профілі авторів і метадані.

  • useAuthor(authorAddress?) -- отримує профіль автора
  • useAuthorComments(options?) -- повертає коментарі певного автора
  • useResolvedAuthorAddress(authorAddress?) -- перетворює зрозумілу людині адресу (наприклад, ENS) на її адресу протоколу

Канали​

Підпишіться на канали вмісту та розбийте їх на сторінки.

  • useFeed(options?) -- повертає розбитий на сторінки канал дописів з однієї чи кількох спільнот
  • useBufferedFeeds(feedOptions?) -- попередня буферизація кількох каналів для швидшого відтворення
  • useAuthorFeed(authorAddress?) -- повертає стрічку дописів певного автора

Дії​

Публікуйте вміст і виконуйте операції запису.

  • usePublishComment(options?) -- опублікуйте новий коментар або відповідь
  • usePublishVote(options?) -- проголосувати за або проти
  • useSubscribe(options?) -- підписатися або скасувати підписку на спільноту

держав і РПЦ​

Відстежуйте стан з’єднання та взаємодійте з віддаленим демоном Bitsocial.

  • useClientsStates(options?) -- повертає стан підключення клієнтів IPFS/pubsub
  • usePlebbitRpcSettings() -- повертає поточну конфігурацію демона RPC

розвиток​

Щоб працювати з бібліотекою хуків локально:

Попередні вимоги: Node.js, увімкнено Corepack, Yarn 4

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

Зверніться до сховища README для тестування та збірки команд.

Посилання​