مرکزی مواد پر جائیں۔

React Hooks

میراثی نام

یہ پیکج فی الحال اپنے اپ اسٹریم فورک سے وراثت میں ملنے والے نام سازی کنونشنز کا استعمال کرتا ہے۔ کوڈ، APIs اور کنفیگریشن میں "plebbit" کے حوالے مستقبل کی ریلیز میں "bitsocial" میں منتقل کر دیے جائیں گے۔ فعالیت غیر متاثر ہے۔

bitsocial-react-hooks پیکیج بٹسوشل پروٹوکول کے ساتھ تعامل کے لیے ایک مانوس ری ایکٹ ہکس API فراہم کرتا ہے۔ یہ فیڈز، تبصرے، اور مصنف کے پروفائلز کی بازیافت، اکاؤنٹس کا نظم و نسق، مواد شائع کرنے، اور کمیونٹیز کو سبسکرائب کرنے کا انتظام کرتا ہے -- یہ سب کچھ مرکزی سرور پر انحصار کیے بغیر۔

یہ لائبریری بنیادی انٹرفیس ہے جسے 5chan اور دیگر بٹسوشل کلائنٹ ایپلی کیشنز کے ذریعے استعمال کیا جاتا ہے۔

نوٹ

bitsocial-react-hooks plebbit/plebbit-react-hooks کا ایک عارضی کانٹا ہے جسے AI کی مدد سے ترقی کے لیے رکھا گیا ہے۔ اسے npm پر شائع کرنے کے بجائے براہ راست GitHub سے استعمال کیا جاتا ہے۔

تنصیب​

چونکہ پیکیج ابھی تک npm پر نہیں ہے، اسے براہ راست GitHub سے انسٹال کریں، مخصوص کمٹ ہیش پر پن کرتے ہوئے:

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

<commit-hash> کو اس کمٹ سے تبدیل کریں جس کو آپ نشانہ بنانا چاہتے ہیں۔

API کا جائزہ​

ہکس کو فنکشنل زمروں میں منظم کیا گیا ہے۔ ذیل میں ہر زمرے میں سب سے زیادہ استعمال ہونے والے ہکس کا خلاصہ ہے۔ مکمل دستخطوں، پیرامیٹرز، اور واپسی کی اقسام کے لیے، دیکھیں GitHub پر مکمل API حوالہ.

اکاؤنٹس​

مقامی صارف کے اکاؤنٹس، شناخت اور ترتیبات کا نظم کریں۔

  • 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?) -- کسی کمیونٹی سے سبسکرائب یا ان سبسکرائب کریں۔

ریاستیں اور آر پی سی​

کنکشن کی حالت کی نگرانی کریں اور ریموٹ بٹسوشل ڈیمون کے ساتھ تعامل کریں۔

  • 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 سے رجوع کریں۔

لنکس​