کیبورد (Kbd)
نمایش کلیدهای کیبورد بهصورت استایلشده
معرفی
کامپوننت Kbd برای نمایش کلیدهای کیبورد در مستندات و راهنماها استفاده میشود. از تگ <kbd> HTML استفاده میکند که برای screen reader ها معنادار است.
چه زمانی استفاده نکنیم:
- برای کدهای inline برنامهنویسی — از تگ
<code>استفاده کنید - برای نمایش shortcut های interactive — از Button با tooltip استفاده کنید
استفاده
برای ذخیره:
Ctrl+S
import { Kbd } from '@parto-system-design/ui'<p>
برای ذخیره <Kbd>Ctrl</Kbd> + <Kbd>S</Kbd> را فشار دهید
</p>مثالها
ترکیب کلیدها
<div className="flex flex-wrap items-center gap-4">
<span className="flex items-center gap-1">
<Kbd>Ctrl</Kbd> + <Kbd>C</Kbd>
</span>
<span className="flex items-center gap-1">
<Kbd>Ctrl</Kbd> + <Kbd>V</Kbd>
</span>
<span className="flex items-center gap-1">
<Kbd>Ctrl</Kbd> + <Kbd>Z</Kbd>
</span>
</div>با KbdGroup
از KbdGroup برای گروهبندی چند کلید در کنار هم استفاده کنید:
import { Kbd, KbdGroup } from '@parto-system-design/ui'
;<KbdGroup>
<Kbd>Ctrl</Kbd>
<Kbd>Shift</Kbd>
<Kbd>P</Kbd>
</KbdGroup>در Tooltip
Kbd در داخل Tooltip با استایل متفاوت نمایش داده میشود:
<Tooltip>
<TooltipTrigger>ذخیره</TooltipTrigger>
<TooltipContent>
ذخیره سند <Kbd>Ctrl</Kbd> + <Kbd>S</Kbd>
</TooltipContent>
</Tooltip>کلیدهای ویژه
<div className="flex flex-wrap items-center gap-2">
<Kbd>⌘</Kbd>
<Kbd>⌥</Kbd>
<Kbd>⇧</Kbd>
<Kbd>⌃</Kbd>
<Kbd>⏎</Kbd>
<Kbd>⌫</Kbd>
<Kbd>Esc</Kbd>
<Kbd>Tab</Kbd>
</div>Props
Kbd
KbdGroup
راهنمای استفاده
بکنید
- از Kbd برای نمایش میانبرهای صفحهکلید در مستندات و tooltip ها استفاده کنید - از
KbdGroupبرای گروهبندی کلیدهای ترکیبی (مثل Ctrl+Shift+P) استفاده کنید - کلیدهای ویژه را با نمادهای استاندارد نمایش دهید (مثل ⌘ برای Command)
نکنید
- از Kbd برای نمایش کد برنامهنویسی استفاده نکنید — از
<code>یا بلوک کد استفاده کنید - از Kbd بدون توضیح متنی درباره عملکرد میانبر استفاده نکنید
دسترسیپذیری
- از تگ
<kbd>HTML استفاده میکند که برای screen reader ها معنادار است - screen reader متن داخل
<kbd>را بهعنوان کلید صفحهکلید اعلام میکند - در داخل Tooltip، استایل متفاوتی اعمال میشود تا خوانایی حفظ شود
کامپوننتهای مرتبط
- CopyButton — اگر نیاز به نمایش میانبر کپی با قابلیت اجرا دارید، نه فقط نمایش بصری
- Tooltip — اگر میخواهید میانبر صفحهکلید را بهعنوان راهنما در tooltip نمایش دهید