دیگ

ListBoxv1.0.0

فهرست گزینه‌های همیشه‌روی‌صفحه (نه داخل پاپ‌اور مثل Select) با انتخاب تکی یا چندتایی، ناوبری فلشی و typeahead. پایهٔ Autocomplete و ComboBox هم همین کامپوننت است.

ری‌اکت ۱۹ و 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/listbox.json
pnpm dlx digdesign@latest add https://docs.digdesign.ir/r/listbox.json
yarn dlx digdesign@latest add https://docs.digdesign.ir/r/listbox.json
bunx --bun digdesign@latest add https://docs.digdesign.ir/r/listbox.json

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

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

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

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

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

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

استفاده

import { ListBox, ListBoxItem } from "@/components/ui/listbox"

<ListBox value={value} onValueChange={setValue} aria-label="میوه">
  <ListBoxItem value="apple">سیب</ListBoxItem>
  <ListBoxItem value="banana">موز</ListBoxItem>
</ListBox>

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

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

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

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

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

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

ترکیب اجزا

ListBox خودش هیچ پاپ‌اور/تریگری ندارد؛ برای فهرست دائمی‌روی‌صفحه (مثل ستون کناری ایمیل) مستقیم استفاده کنید.

برای فهرست شناور روی یک دکمه، آن را داخل Popover بگذارید؛ Select و Autocomplete دقیقاً همین کار را با پیاده‌سازی داخلی خودشان می‌کنند.

دسترس‌پذیری

  • role=listbox روی ظرف و role=option روی هر آیتم؛ aria-selected و aria-multiselectable خودکار مدیریت می‌شوند.
  • فقط یک آیتم tabIndex=0 دارد (roving-tabindex)؛ باقی با فلش بالا/پایین قابل‌دسترسی‌اند، Home/End به اول/آخر می‌پرد.
  • تایپ کردن حروف، به اولین گزینه‌ای که با آن حروف شروع می‌شود می‌پرد (typeahead).
  • حتماً aria-label یا aria-labelledby روی ListBox بگذارید.

مرجع API

ListBox

ویژگینوعپیش‌فرضتوضیح
selectionMode"single" | "multiple""single"حالت انتخاب.
value / defaultValuestring | string[]—بسته به selectionMode، رشته یا آرایه.
onValueChange(value) => void—فراخوانی هنگام تغییر انتخاب.

ListBoxItem

ویژگینوعپیش‌فرضتوضیح
valuestring—مقدار یکتای گزینه.
disabledbooleanfalseغیرفعال کردن گزینه.

ListBoxSection

ویژگینوعپیش‌فرضتوضیح
titleReact.ReactNode—عنوان بخش.

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

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

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

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

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

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