پرش به مطلب اصلی

React Hooks

بسته bitsocial-react-hooks یک React hooks API آشنا برای تعامل با پروتکل Bitsocial فراهم می کند. این کار واکشی فیدها، نظرات، و نمایه‌های نویسنده، مدیریت حساب‌ها، انتشار محتوا و اشتراک در انجمن‌ها را انجام می‌دهد - همه بدون اتکا به سرور مرکزی.

این کتابخانه رابط اصلی است که توسط 5chan و دیگر برنامه‌های سرویس گیرنده Bitsocial استفاده می‌شود.

یادداشت

bitsocial-react-hooks در حال حاضر مستقیماً از GitHub مصرف می شود نه اینکه در npm منتشر شود.

نصب و راه اندازی​

از آنجایی که بسته هنوز روی npm نیست، آن را مستقیماً از GitHub نصب کنید و به یک هش commit خاص پین کنید:

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

<commit-hash> را با commitی که می خواهید هدف قرار دهید جایگزین کنید.

نمای کلی API​

قلاب ها به دسته های کاربردی سازماندهی می شوند. در زیر خلاصه ای از پرکاربردترین قلاب ها در هر دسته آورده شده است. برای امضاها، پارامترها و انواع بازگشت کامل، به [مرجع کامل API در GitHub] (https://github.com/bitsocialnet/bitsocial-react-hooks).) مراجعه کنید

حساب ها​

حساب‌های کاربری محلی، هویت و تنظیمات را مدیریت کنید.

  • 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 فعلی را برمی گرداند

توسعه​

برای کار بر روی کتابخانه هوک به صورت محلی:

پیش نیازها: Node.js، Corepack فعال، Yarn 4

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

برای دستورات تست و ساخت به مخزن README مراجعه کنید.

پیوندها​