دیگ

Autocompletev1.1.0

فیلد متنی که هر چه تایپ می‌کنید، فهرست گزینه‌ها را فیلتر می‌کند؛ ترکیب Input و ListBox در یک کامپوننت، با مدل combobox (فوکوس همیشه روی خودِ فیلد می‌ماند).

شبیه به این هم هست:DropdownComboBoxکدام را انتخاب کنم؟
ری‌اکت ۱۹ و Next.js با پیاده‌سازی دسترس‌پذیری داخلی دیگویو ۳ با Composition API — هنوز برای این کامپوننت پورت نشدهSvelte ۵ با runes — هنوز برای این کامپوننت پورت نشدهانگولار با signals و دایرکتیوهای standalone — هنوز برای این کامپوننت پورت نشده

این کامپوننت فعلاً برای ۱ فریم‌ورک از ۴ فریم‌ورک آماده است.

این نمونه هنوز برای Vue پورت نشده است؛ آنچه می‌بینید نسخهٔ ری‌اکت است.

این نمونه هنوز برای Svelte پورت نشده است؛ آنچه می‌بینید نسخهٔ ری‌اکت است.

این نمونه هنوز برای Angular پورت نشده است؛ آنچه می‌بینید نسخهٔ ری‌اکت است.

نصب

با CLI اختصاصی digdesign کامپوننت را از رجیستری دیگ نصب کنید؛ وابستگی‌ها و فایل‌ها خودکار اضافه می‌شوند.

پکیج‌منیجر پیش‌فرض Node.jsنصب سریع با لینک سخت و دیسک مشترکYarn نسخهٔ ۲ به بالا (Berry)رانتایم و پکیج‌منیجر Bun
npx digdesign@latest add https://docs.digdesign.ir/r/autocomplete.json
pnpm dlx digdesign@latest add https://docs.digdesign.ir/r/autocomplete.json
yarn dlx digdesign@latest add https://docs.digdesign.ir/r/autocomplete.json
bunx --bun digdesign@latest add https://docs.digdesign.ir/r/autocomplete.json

این کامپوننت هنوز برای Vue پورت نشده است.

نسخهٔ ری‌اکت آماده است؛ پورت این فریم‌ورک در دست کار است.

این کامپوننت هنوز برای Svelte پورت نشده است.

نسخهٔ ری‌اکت آماده است؛ پورت این فریم‌ورک در دست کار است.

این کامپوننت هنوز برای Angular پورت نشده است.

نسخهٔ ری‌اکت آماده است؛ پورت این فریم‌ورک در دست کار است.

استفاده

import { Autocomplete } from "@/components/ui/autocomplete"

<Autocomplete
  items={cities}
  value={city}
  onValueChange={setCity}
  placeholder="شهر را جستجو کنید…"
/>

این کامپوننت هنوز برای Vue پورت نشده است.

نسخهٔ ری‌اکت آماده است؛ پورت این فریم‌ورک در دست کار است.

این کامپوننت هنوز برای Svelte پورت نشده است.

نسخهٔ ری‌اکت آماده است؛ پورت این فریم‌ورک در دست کار است.

این کامپوننت هنوز برای Angular پورت نشده است.

نسخهٔ ری‌اکت آماده است؛ پورت این فریم‌ورک در دست کار است.

ترکیب اجزا

Autocomplete دیتا-محور است: فهرست items را به‌عنوان آرایهٔ { value, label } می‌دهید، نه فرزند JSX (برخلاف ListBox).

فیلتر روی برچسب‌ها با نرمال‌سازی حروف عربی/فارسی (ی/ك در برابر ی/ک) انجام می‌شود تا تایپ با هر دو صورت نویسه‌ها کار کند.

دسترس‌پذیری

  • role=combobox روی input با aria-expanded/aria-controls/aria-activedescendant؛ فهرست role=listbox و هر گزینه role=option است.
  • فوکوس واقعیِ کیبورد همیشه روی input می‌ماند؛ گزینهٔ هایلایت‌شده فقط با aria-activedescendant معرفی می‌شود، نه با جابه‌جایی فوکوس.
  • فلش بالا/پایین بین گزینه‌های فیلترشده حرکت می‌کند، Enter گزینهٔ هایلایت‌شده را تایید می‌کند و Escape فهرست را می‌بندد و مقدار را به آخرین انتخاب برمی‌گرداند.
  • idهای input، listbox و گزینه‌ها برای هر نمونه یکتاست (پیش‌فرض React.useId)؛ برای برچسبِ قابل‌دیدن id بدهید و همان را در Label htmlFor بگذارید.

مرجع API

Autocomplete

ویژگینوعپیش‌فرضتوضیح
items{ value: string; label: string; disabled?: boolean }[]—فهرست کامل گزینه‌ها.
value / defaultValuestring—مقدار انتخاب‌شدهٔ کنترل‌شده یا اولیه.
onValueChange(value: string) => void—فراخوانی هنگام انتخاب یک گزینه.
placeholderstring"جستجو…"متن راهنمای فیلد.
emptyTextstring"چیزی پیدا نشد"متن هنگام خالی‌بودن نتیجهٔ فیلتر.
disabledbooleanfalseغیرفعال کردن کل فیلد.
invalidbooleanfalseفیلد نامعتبر است: حاشیهٔ خطا و aria-invalid روی خودِ ورودی. پیام خطا را جدا بنویسید و با aria-describedby وصلش کنید.
idstringReact.useId()id ورودی، برای اتصال <Label htmlFor>. idهای listbox و گزینه‌ها از همین ساخته می‌شوند؛ بدون آن هر نمونه یک id یکتای خودکار می‌گیرد، پس چند Autocomplete در یک صفحه تداخل ندارند.

این کامپوننت هنوز برای Vue پورت نشده است.

نسخهٔ ری‌اکت آماده است؛ پورت این فریم‌ورک در دست کار است.

این کامپوننت هنوز برای Svelte پورت نشده است.

نسخهٔ ری‌اکت آماده است؛ پورت این فریم‌ورک در دست کار است.

این کامپوننت هنوز برای Angular پورت نشده است.

نسخهٔ ری‌اکت آماده است؛ پورت این فریم‌ورک در دست کار است.