README.md

مستندات مربوط به استفاده از سرچیا

لیست محتوا

• توضیحات

• تکنولوژی

• تنظیمات

• توابع

توضیحات

این کتابخانه جهت تسهیل استفاده از خدمات جست‌وجو به عنوان سرویس توسعه داده‌شده‌است

تکنولوژی

• javascript

تنظیمات

جهت استفاده از این کتاب‌خانه لازم است قبل از فراخوانی توابع فایل حاوی توابع در صفحه بارگزاری شود
لازم است فقط یک بار قبل از استفاده از توابع مقادیر مربوط به تنظیمات مقداردهی شود
بدیهی است در صورت عدم مقداردهی هر یک از موارد، مقدار پیش‌فرض اعمال خواهد شد

<script type="text/javascript" src="https://github.com/mehmaj/searchia-api-client/blob/main/searchia-api-client.js"></script>
<script type="text/javascript">
     window.onload = function () {
     searchiaInstantSearchTemplate:"<tr><td>${this.position}</td><td>${this.docId}</td><td>${this.depth}</td><td>${this.title}</td></tr>",
     searchiaInstantSearchResultContainer:"searchia-res-container",
     searchiaSearchTemplate:"<tr><td>${this.position}</td><td>${this.docId}</td><td>${this.depth}</td><td>${this.title}</td></tr>",
     searchiaSearchResultContainer:"searchia-res-container",
     searchiaTotalHitsContainer:"searchia-total-hits",
     searchiaSearchTime:"searchia-search-time",
     searchiaIndexName:"yazd_uni",
     searchiaAPIKey:"WewDcp6ocko8ZY0",
     searchiaSearchInputId:'searchia-search-box',
     searciaFrom:0,
     searchiaNRPP:10,
     runSearchiaOnInputChange:true
    });
  };
</script>

قبل از ساختن قالب‌ها لازم است بدانید:

قالب‌ها تگ‌های htlmای هستند که به ازای هر element باید به selectorای که در تنظیمات مشخص شده‌اند اضافه شود

برای استفاده از مقادیر موجود در سند(document) می‌توانید از عبارت ${this.token} استفاده کنید با این توضیح که به‌جای کلمه token هر ویژگی(field) موجود در سندی که قبلا در سرچیا ذخیره شده است، قابل استفاده است

مقادیر docId و position همواره در تمام سندها به صورت پیش‌فرض قابل دسترسی هستند

searchiaInstantSearchTemplate

قالب مربوط به جست‌و‌جوی سریع

searchiaInstantSearchResultContainer

selector مربوط به نتایج جست‌و‌جوی سریع

searchiaSearchTemplate

قالب مربوط به جست‌و‌جو

searchiaSearchResultContainer

selector مربوط به نتایج جست‌و‌جو

searchiaTotalHitsContainer

selector مربوط به تعداد کل نتایج بازیابی شده

searchiaSearchTime

selector مربوط به زمان واکشی نتایج

searchiaIndexName

نام index که در سرچیا تعریف شده‌است

searchiaAPIKey

apiKey که از سرچیا دریافت کرده‌اید

searchiaSearchInputId

selector مربوط به input مربوط به جست‌و‌جو

searciaFrom

ردیف شروع واکشی نتایج

searchiaNRPP

تعداد نتایج واکشی شده (Number Of Results Per Page)

runSearchiaOnInputChange

در صورتی که مقدار این مورد برابر true باشد با تغییر input مربوط به جستجو(searchiaSearchInputId) به صورت خودکار تابع instantSearch() با پرس‌و‌جو موجود در input جست‌و‌جو فراخوانی خواهد‌شد

توابع

این کتاب‌خانه به طور کلی شامل ۴ تابع است که نحوه استفاده از هر کدام به شرح زیر است:

جست‌و‌جوی سریع

instantSearch(query,nrpp);

• توضیحات جست‌و‌جوی سریع ؟؟؟

جست‌و‌جو

search(query,from,nrpp);

• توضیحات جست‌و‌جو ؟؟؟

کلیک

click(query,docId,position);

• کلیک کاربر بر روی نتیجه جست‌و‌جو

اضافه کردن محصول به سبد خرید

addToCart(docId);

• اضافه کردن محصول به سبد خرید توسط کاربر