ایمپورت
import { type NuiCommand, NuiCommandPalette } from '@needless-ui/angular/command';NuiCommandPalette
دیالوگی مودال با یک فیلد جستجو روی فرمانهای شما.
| نام | نوع | پیشفرض | توضیح |
|---|---|---|---|
commandsورودی | NuiCommand[] | فرمانها، بهصورت اشیای NuiCommand. | |
openدوطرفه | boolean | false | اینکه پالت باز است یا نه. |
hotkeyورودی | string | null | 'mod+k' | میانبری که پالت را از هر جا باز و بسته میکند، یا null برای هیچکدام. mod در دستگاههای Apple همان ⌘ و در بقیه Ctrl است. |
bindShortcutsورودی | boolean | false | فرمانها را با میانبرهای خودشان هم اجرا میکند، در هر جای صفحه. |
loopورودی | boolean | true | پایین رفتن از آخرین فرمان به اولی میرسد، و بالا رفتن از اولی به آخری. |
filteringورودی | boolean | true | هنگام تایپ فیلتر میکند. وقتی سرور فرمانها را فیلتر میکند، خاموشش کنید. |
loadingورودی | boolean | false | تا رسیدن نتایج، یک ردیف بارگذاری نشان میدهد. |
hintsورودی | boolean | true | کلیدهای قابلاستفاده را در پایین نشان میدهد. |
virtualورودی | boolean | 'auto' | 'auto' | فقط ردیفهای در دید را رندر میکند: همیشه، هرگز، یا با auto از ۲۰۰ ردیف به بالا. |
labelورودی | string | 'Command palette' | نام دسترسپذیر دیالوگ و فیلد جستجوی آن. |
placeholderورودی | string | 'Type a command or search…' | متنی که در فیلد جستجوی خالی نمایش داده میشود. |
runخروجی | NuiCommand | هر فرمانی را که اجرا میشود منتشر میکند. | |
queryChangeخروجی | string | متن را همزمان با تایپ منتشر میکند، برای جستجو در سرور. | |
showمتد | () => void | پالت را باز میکند. | |
hideمتد | () => void | پالت را میبندد. | |
toggleمتد | () => void | پالت را باز میکند، یا میبندد. | |
backمتد | () => void | به صفحهٔ قبلی برمیگردد. |
هر متنی که نشان میدهد یا اعلام میکند هم یک ورودی است، پس میتوانید ترجمهاش کنید: emptyLabel loadingLabel backLabel closeLabel moveLabel chooseLabel
NuiCommand
یک فرمان، یا صفحهای از فرمانها.
| نام | نوع | پیشفرض | توضیح |
|---|---|---|---|
labelویژگی | string | متنی که نمایش داده و جستجو میشود. | |
descriptionویژگی | string | متن ثانویه زیر برچسب. | |
groupویژگی | string | فرمانهایی که گروه یکسانی دارند زیر همان سرتیتر فهرست میشوند. | |
keywordsویژگی | string[] | واژههای دیگری که جستجو با آنها تطبیق میدهد، مثل مترادفها. | |
shortcutویژگی | string | کلیدهایی که کنارش نمایش داده میشوند، مثل mod+shift+p. | |
disabledویژگی | boolean | نمایش داده میشود، اما اجرا نمیشود. | |
childrenویژگی | NuiCommand[] | فرمانهای یک سطح پایینتر: انتخاب این فرمان آنها را بهصورت یک صفحه باز میکند. | |
runویژگی | () => void | وقتی انتخاب شود، پس از بسته شدن پالت، اجرا میشود. | |
idویژگی | string | برای استفادهٔ خودتان، مثلاً برای تشخیص فرمانها از هم در (run). |