الانتقال إلى المحتوى الرئيسي

نظرة عامة

استورد Shortcut وformatShortcut من twenty-ui/primitives/typography. يشترك كلاهما في النموذج والرموز والفواصل نفسها. سجّل الاختصارات في تطبيقك. يقوم Shortcut بتنسيق التلميح فقط؛ ولا يسجل إجراءات لوحة المفاتيح. تستهدف السمات الأصلية ومعالجات الأحداث والأنماط وأسماء الفئات والمراجع عنصر span الخارجي الخاص به. ShortcutProps وShortcutFormatOptions نوعان عامان.

استخدام

التركيبات والتسلسلات

المصفوفة المسطحة هي مجموعة متزامنة: ['Mod', 'K'] تعني الضغط على Mod وK معًا. المصفوفة المتداخلة هي تسلسل مرتب: [['G'], ['P']] تعني الضغط على G، ثم P. كل مصفوفة متداخلة هي مجموعة واحدة، لذا فإن [['Mod', 'K'], ['Mod', 'C']] تعني الضغط على Mod وK، ثم Mod وC. استخدم مصفوفة ذات عنصر واحد لمفتاح واحد. يمكن أن يكون كلا شكلي المصفوفات للقراءة فقط. يعرض Mod وCommandOrControl مفتاح Command على macOS وiOS، ومفتاح Control في أماكن أخرى. تحتوي مفاتيح Command وControl وAlt وEnter الصريحة أيضًا على تسميات عرض. تُعرض السلاسل الأخرى كما تم توفيرها. يكون اكتشاف الجهاز آمنًا دون عموميات المتصفح؛ ويستبدله platform اختياريًا بالقيمة mac أو other. استخدم sequenceJoinLabel لنص الربط المترجم. يمكن أن يحافظ combinationSeparator على اصطلاح المضيف مثل +. يكون فاصل النص الافتراضي فارغًا على أجهزة Apple ومسافة في أماكن أخرى. يختار variant بين keys أو text أو button. يخفي visibility="desktop" التلميح عند عروض إطار العرض على الأجهزة المحمولة، بينما يظل always مرئيًا. تحتوي رموز المفاتيح على أسماء مقروءة ومتاحة. استخدم accessibleKeyLabels لترجمة أسماء المفاتيح الفردية في مخرجات قارئ الشاشة. وفّر aria-label أو aria-labelledby اسمًا مترجمًا للاختصار بأكمله، أو aria-hidden لتلميح زخرفي. تحتفظ الأزرار بأسماء إجراءاتها وتخفي تلميحاتها الزخرفية على الأجهزة المحمولة. تُبقي صفوف القوائم والقوائم المنسدلة تلميحاتها مرئية.

المظهر

استخدم keys لأغطية المفاتيح الفردية، وtext لتلميح مضمن، أو button للتلميح المضغوط داخل إجراء. تغيّر هذه المتغيرات العرض فقط.

الترحيل

تحتاج المصفوفات المسطحة المخزنة التي تمثل ضغطات مفاتيح متعاقبة إلى تداخل قبل تمريرها إلى shortcut: hotKeys.map((key) => [key]). يمكن تمرير المصفوفات التي تمثل مفاتيح متزامنة مباشرةً. تظل سلاسل المفاتيح رموزًا حرفية، لذا تحتوي ['Mod', '+'] على مفتاح زائد وتحتوي ['Space'] على مفتاح Space؛ ولا يلزم تحليل سلسلة الاختصار.

الإزاحة

Readonly<Record<string, string>>
Optional localized names for individual keys in screen reader output.
string
Optional separator between simultaneous keys. Defaults to no separator on Apple devices and a space elsewhere.
"mac" | "other"
Optional mac or other platform override. Defaults to server-safe device detection.
string
Text between sequence steps. Defaults to then.
ShortcutDefinition
مطلوب
Flat key array for a simultaneous combination, or nested key arrays for an ordered sequence of combinations.
"button" | "keys" | "text"
افتراضي:"keys"
Keycaps, inline text, or a separated button hint.
"always" | "desktop"
افتراضي:"always"
Always visible by default. Desktop hints hide on mobile viewports.