Toggle

دکمه‌ای که وضعیتش را نگه می‌دارد: یک بار کلیک روشن می‌شود، بار بعد خاموش. جایگزین فشرده‌ای برای چک‌باکس وقتی گزینه آیکونی است و در نوار ابزار می‌نشیند.

ری‌اکت ۱۹ و Next.js با پیاده‌سازی دسترس‌پذیری داخلی دیگویو ۳ با Composition API و Reka UISvelte ۵ با runes و Bits UIانگولار با signals و Angular CDK

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

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

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

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

نصب

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

نصب سریع با لینک سخت و دیسک مشترکپکیج‌منیجر پیش‌فرض Node.jsYarn نسخهٔ ۲ به بالا (Berry)رانتایم و پکیج‌منیجر Bun
pnpm dlx dig-ui@latest add https://design-system-tau-green.vercel.app/r/toggle.json
npx dig-ui@latest add https://design-system-tau-green.vercel.app/r/toggle.json
yarn dlx dig-ui@latest add https://design-system-tau-green.vercel.app/r/toggle.json
bunx --bun dig-ui@latest add https://design-system-tau-green.vercel.app/r/toggle.json

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

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

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

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

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

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

استفاده

import { Toggle } from "@/components/ui/toggle"

<Toggle aria-label="درشت">
  <Bold />
</Toggle>

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

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

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

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

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

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

ترکیب اجزا

کل ظاهر از toggleVariants می‌آید که همین فایل صادر می‌کند؛ گروه ضامن هم دقیقاً همین را وارد می‌کند، پس دکمهٔ تکی و دکمه‌های داخل گروه هیچ‌وقت از هم جدا نمی‌افتند. اگر ظاهر تازه‌ای لازم دارید، variant را در همین cva اضافه کنید تا هر دو جا با هم عوض شوند. برای انتخاب بین چند گزینه به‌جای چند Toggle مستقل از ToggleGroup استفاده کنید تا ناوبری صفحه‌کلید درست باشد.

دسترس‌پذیری

  • حالت روشن با aria-pressed و data-state=on اعلام می‌شود؛ صفحه‌خوان «فشرده» یا «فشرده‌نشده» می‌خواند.
  • دکمه‌ای که فقط آیکون دارد حتماً باید aria-label بگیرد.
  • با Space و Enter تغییر حالت می‌دهد، دقیقاً مثل یک دکمهٔ معمولی.
  • اگر گزینه بخشی از یک فرم است و باید ارسال شود، چک‌باکس انتخاب درست‌تری است؛ Toggle مقدار فرم نمی‌فرستد.

مرجع API

Toggle

ویژگینوعپیش‌فرضتوضیح
pressed / onPressedChangeboolean / (pressed: boolean) => voidحالت کنترل‌شدهٔ روشن و خاموش.
defaultPressedbooleanfalseحالت اولیه در وضعیت کنترل‌نشده.
variant"default" | "outline""default"بدون کادر یا با کادر و سایهٔ خفیف.
size"sm" | "default" | "lg" | "icon-sm" | "icon" | "icon-lg""default"ارتفاع و حداقل عرض دکمه. سه‌تای icon* مربع‌اند و برای دکمهٔ فقط‌آیکونی‌اند (بدون پدینگ افقی).
disabledbooleanfalseغیرفعال کردن دکمه.
asChildbooleanfalseرفتار ضامن را روی فرزند سوار می‌کند.

toggleVariants

همان cva استایل‌ها؛ گروه ضامن و هر کامپوننت دیگری که بخواهد ظاهر یکسان بدهد از این وارد می‌کند.

ویژگینوعپیش‌فرضتوضیح
toggleVariants({ variant, size })(props) => stringرشتهٔ کلاس‌ها را برمی‌گرداند؛ با cn روی عنصر دلخواه بگذارید.

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

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

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

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

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

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