رفتن به محتوای اصلی
  • معرفی
  • نصب
  • Tailwind
  • وب کامپوننت‌ها (بدون React)
  • دوزبانه، فارسی و انگلیسی
  • پلاگین‌های فیگما
  • استفاده با هوش مصنوعی
  • آیکون‌ها
  • راهنمای آیکون‌ها
  • سفارشی‌سازی و تم
  • حرکت و ریزتعامل‌ها
  • حالت‌های کامپوننت‌ها
  • فونت و تایپوگرافی
  • دسترس‌پذیری
  • نوشتن متن رابط
  • رنگ‌ها
  • برند کاشی
  • مقایسه با دیگران
  • نسخه‌ها
  • سیاست تغییرات
  • مهاجرت به ۲.۰
  • امنیت
  • حجم کامپوننت‌ها
  • فیلد فارسی
  • دیت‌پیکر شمسی
  • کد تأیید (OTP)
  • بازهٔ تاریخ شمسی
  • انتخاب ماه
  • شمارش معکوس
  • هیت‌مپ فعالیت
  • انتخاب استان
  • نقشهٔ ایران
  • فرم نشانی
  • انتخاب نوبت
  • ویرایش نگارشی
  • نمایش مبلغ
  • بازهٔ قیمت
  • کارت بانکی
  • رسید پرداخت
  • برگ تقویم
  • لوگوی بانک‌ها
  • ابزارهای فارسی
  • آپلود فایل
  • آکاردئون
  • آواتار
  • اسپلیتر
  • استپر
  • اسکلتون
  • اسلایدر
  • اعتبارسنجی فرم
  • امتیاز ستاره‌ای
  • انتخاب چندتایی
  • انتخاب رنگ
  • بج
  • بردکرامب
  • برگهٔ پایین
  • بنر
  • پاپ‌اور
  • تایم‌لاین
  • تب‌ها
  • تور معرفی
  • توست
  • تولتیپ
  • جداکننده و کلید میان‌بر
  • جدول داده
  • جستجو با پیشنهاد
  • چک‌باکس
  • چیپس
  • حالت خالی
  • دراپ‌داون
  • دکمه
  • دکمهٔ کپی
  • دیالوگ
  • رادیو
  • سایدبار
  • سگمنت
  • سلکت
  • سوییچ
  • صفحه‌بندی
  • قدرت رمز عبور
  • کارت
  • کارت آمار
  • کاروسل
  • کامبوباکس
  • کامند پالت
  • کشو
  • گروه دکمه
  • گیج
  • منوی راست‌کلیک
  • نمای درختی
  • نمودار
  • نمونهٔ رنگ
  • نوار پیشرفت
  • نوار ناوبری
  • ورودی
  • ورودی تگ
  • ورودی عدد
  • ویرایش درجا
  • هشدار
شروع کنید

جستجو با پیشنهاد

جعبهٔ جستجو با جستجوهای اخیر و پرطرفدار و پیشنهاد هنگام تایپ؛ الگوی جستجوی فروشگاه‌های اینترنتی.

npm i @kashi-ui/react @kashi-ui/css
import { SearchSuggest } from "@kashi-ui/react";

CSS را یک بار در ریشهٔ برنامه وارد کنید: import "@kashi-ui/css"حجم: ۲٫۲ کیلوبایت + هستهٔ مشترکراهنمای نصب

import { SearchSuggest } from "@kashi-ui/react";

نمونه

روی فیلد بزنید: با فیلد خالی، جستجوهای اخیر (با «پاک کردن») و جستجوهای پرطرفدار با آیکون روند دیده می‌شوند. با تایپ، پیشنهادها با قسمت پیداشدهٔ پررنگ می‌آیند.

روی فیلد بزنید

<SearchSuggest
placeholder="جستجو در همهٔ کالاها"
recent={recent}
onClearRecent={() => setRecent([])}
popular={["ساعت مچی زنانه", "عروسک", "اسکوتر برقی"]}
suggestions={products}
onSearch={(q) => router.push(`/search?q=${q}`)}
/>

ذخیرهٔ خودکار جستجوهای اخیر

اگر جستجوهای اخیر را خودتان نگه نمی‌دارید، storageKey بدهید. هر جستجو (حداکثر ۸ مورد) در مرورگر کاربر ذخیره می‌شود و «پاک کردن» همه را حذف می‌کند.

<SearchSuggest storageKey="shop-recent" popular={popular} onSearch={search} />

پیشنهاد از سرور

به‌جای آرایه، تابعی بدهید که برای هر عبارت فهرست برگرداند؛ مثلاً از نتیجهٔ آخرین درخواست. جستجوی آرایه‌ای «ی» و «ک» عربی و نیم‌فاصله را یکسان می‌بیند.

<SearchSuggest suggestions={(q) => results[q] ?? []} onChange={fetchSuggestions} />
ویژگی‌ها (props)
نامتوضیح، نوع و پیش‌فرض
value / defaultValue

متن جستجو

نوع: string

onChange

با هر تایپ

نوع: (query: string) => void

onSearch

با Enter یا انتخاب پیشنهاد، جستجوی اخیر یا پرطرفدار

نوع: (query: string) => void

recent

جستجوهای اخیر (کنترل‌شده)

نوع: string[]

onClearRecent

دکمهٔ «پاک کردن»

نوع: () => void

storageKey

ذخیرهٔ خودکار جستجوهای اخیر در localStorage

نوع: string

popular

جستجوهای پرطرفدار

نوع: string[]پیش‌فرض []

suggestions

پیشنهادها هنگام تایپ (حداکثر ۸)

نوع: string[](query) => string[]

placeholder / label / name

label برای صفحه‌خوان؛ پیش‌فرض «جستجو»

نوع: string

دسترس‌پذیری

فیلد نقش combobox دارد و پیشنهادها listbox هستند؛ با ↓ و ↑ بین پیشنهادها جابه‌جا می‌شوید، Enter جستجو می‌کند و Escape پنل را می‌بندد (و بار دوم متن را پاک می‌کند). جستجوهای اخیر و پرطرفدار دکمه‌اند و با Tab در دسترس‌اند. فرم نقش search دارد تا صفحه‌خوان آن را به‌عنوان بخش جستجو بشناسد.

راهنمای استفاده

کِی استفاده کنیم

  • جستجوی اصلی فروشگاه یا سایت محتوایی که کاربر معمولاً دوباره همان چیزها را جستجو می‌کند.
  • جایی که جستجوهای پرطرفدار به کشف محصول کمک می‌کند.

کِی استفاده نکنیم

درست و نادرست

  1. درست
    درست: حداکثر ۵ تا ۸ جستجوی پرطرفدار واقعی، به‌روز با آمار جستجو.
    نادرست
    نادرست: فهرست بلندی از کلمه‌ها که برای سئو یا تبلیغ پر شده.
  2. درست
    درست: دکمهٔ «پاک کردن» برای جستجوهای اخیر؛ کاربر باید بتواند تاریخچه‌اش را حذف کند.
    نادرست
    نادرست: تاریخچه‌ای که همیشه می‌ماند، حتی روی دستگاه مشترک.

متن

  • placeholder بگوید کجا جستجو می‌شود: «جستجو در همهٔ کالاها»، نه فقط «جستجو».
  • عنوان بخش‌ها کوتاه: «جستجوهای اخیر» و «جستجوهای پرطرفدار».

قاعده‌های کلی لحن، برچسب دکمه و پیام خطا: نوشتن متن رابط

وب کامپوننت

همین کامپوننت بدون React، برای HTML، وردپرس، Vue، Svelte و Angular: <kashi-search-suggest> در @kashi-ui/elements. فهرست‌ها با ویرگول (, یا ،) جدا می‌شوند. با storage-key جستجوهای اخیر در مرورگر ذخیره می‌شوند؛ با action فرم به همان نشانی و با پارامتر q ارسال می‌شود.

نصب

بدون ابزار ساخت، این دو خط را در <head> صفحه بگذارید:

CDN
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@kashi-ui/css/dist/kashi.css">
<script type="module" src="https://cdn.jsdelivr.net/npm/@kashi-ui/elements/dist/cdn/kashi-elements.js"></script>

یا با npm، و فقط همین بخش را وارد کنید:

npm
npm i @kashi-ui/elements @kashi-ui/css
import "@kashi-ui/css";
import "@kashi-ui/elements/commerce.js";

نمونه

<kashi-search-suggest
  placeholder="جستجو در همهٔ کالاها"
  popular="ساعت هوشمند، عروسک، اسکوتر برقی"
  suggestions="ساعت مچی زنانه، ساعت هوشمند، گوشی هوشمند، هدفون بی‌سیم، میز آرایش"
  storage-key="demo-recent"
></kashi-search-suggest>

ویژگی‌ها

ویژگی‌های وب کامپوننت
نامتوضیح، نوع و پیش‌فرض
placeholder

متن راهنمای فیلد

نوع: متن

popular

جستجوهای پرطرفدار

نوع: فهرست

suggestions

پیشنهادها هنگام تایپ

نوع: فهرست

recent

جستجوهای اخیر (اگر storage-key ندارید)

نوع: فهرست

storage-key

ذخیرهٔ خودکار جستجوهای اخیر در localStorage

نوع: متن

action

ارسال فرم جستجو به این نشانی

نوع: نشانی

name

نام فیلد در فرم

نوع: متنپیش‌فرض q

رویدادها و JavaScript

نامتوضیح
kashi-searchdetail: { query }
kashi-changedetail: { value }
.valueمتن فعلی