API ของพาเลตคำสั่ง

Import

import-command.ts

import { type NuiCommand, NuiCommandPalette } from '@needless-ui/angular/command';

NuiCommandPalette

ไดอะล็อกแบบโมดัลที่มีช่องค้นหาคำสั่งของคุณ

Selector: nui-command-palette

NuiCommandPalette: พร็อพเพอร์ตี
ชื่อ	ชนิด	ค่าเริ่มต้น	คำอธิบาย
`commands`Input	`NuiCommand[]`		คำสั่งต่าง ๆ ในรูปออบเจกต์ `NuiCommand`
`open`สองทาง	`boolean`	`false`	พาเลตเปิดอยู่หรือไม่
`hotkey`Input	`string \| null`	`'mod+k'`	คีย์ลัดที่ใช้เปิดและปิดพาเลตจากทุกที่ หรือ `null` หากไม่ต้องการ `mod` คือ ⌘ บนอุปกรณ์ Apple และ Ctrl บนอุปกรณ์อื่น
`bindShortcuts`Input	`boolean`	`false`	ให้รันคำสั่งด้วยคีย์ลัดของคำสั่งนั้นเองได้ด้วย จากที่ใดก็ได้บนหน้า
`loop`Input	`boolean`	`true`	กดลงที่คำสั่งสุดท้ายจะไปยังคำสั่งแรก และกดขึ้นที่คำสั่งแรกจะไปยังคำสั่งสุดท้าย
`filtering`Input	`boolean`	`true`	กรองขณะพิมพ์ ปิดไว้เมื่อเซิร์ฟเวอร์เป็นผู้กรองคำสั่ง
`loading`Input	`boolean`	`false`	แสดงแถวกำลังโหลดระหว่างรอผลลัพธ์
`hints`Input	`boolean`	`true`	แสดงปุ่มที่ใช้ได้ไว้ที่ด้านล่าง
`virtual`Input	`boolean \| 'auto'`	`'auto'`	เรนเดอร์เฉพาะแถวที่มองเห็น: ทุกครั้ง ไม่เลย หรือ `auto` เมื่อเกิน 200 แถว
`label`Input	`string`	`'Command palette'`	ชื่อที่เข้าถึงได้ของไดอะล็อกและช่องค้นหา
`placeholder`Input	`string`	`'Type a command or search…'`	ข้อความที่แสดงในช่องค้นหาที่ว่างอยู่
`run`Output	`NuiCommand`		ส่งแต่ละคำสั่งที่ทำงานออกมา
`queryChange`Output	`string`		ส่งข้อความออกมาขณะพิมพ์ สำหรับการค้นหาที่เซิร์ฟเวอร์
`show`เมธอด	`() => void`		เปิดพาเลต
`hide`เมธอด	`() => void`		ปิดพาเลต
`toggle`เมธอด	`() => void`		เปิดพาเลต หรือปิดหากเปิดอยู่
`back`เมธอด	`() => void`		กลับไปยังหน้าก่อนหน้า

ข้อความทุกส่วนที่แสดงหรือประกาศก็เป็น input เช่นกัน จึงแปลได้: emptyLabel loadingLabel backLabel closeLabel moveLabel chooseLabel

NuiCommand

คำสั่งหนึ่งคำสั่ง หรือหน้าหนึ่งที่รวมคำสั่งไว้

NuiCommand: พร็อพเพอร์ตี
ชื่อ	ชนิด	คำอธิบาย
`label`พร็อพเพอร์ตี	`string`	ข้อความที่แสดงและใช้ค้นหา
`description`พร็อพเพอร์ตี	`string`	ข้อความรองใต้ป้ายกำกับ
`group`พร็อพเพอร์ตี	`string`	คำสั่งที่อยู่กลุ่มเดียวกันจะแสดงอยู่ใต้หัวข้อนั้น
`keywords`พร็อพเพอร์ตี	`string[]`	คำเพิ่มเติมที่การค้นหาจะจับคู่ด้วย เช่น คำพ้องความหมาย
`shortcut`พร็อพเพอร์ตี	`string`	ปุ่มที่แสดงคู่กับคำสั่ง เช่น `mod+shift+p`
`disabled`พร็อพเพอร์ตี	`boolean`	แสดงอยู่ แต่รันไม่ได้
`children`พร็อพเพอร์ตี	`NuiCommand[]`	คำสั่งในระดับถัดลงไป การเลือกคำสั่งนี้จะเปิดคำสั่งเหล่านั้นเป็นหน้า
`run`พร็อพเพอร์ตี	`() => void`	ทำงานเมื่อถูกเลือก หลังจากพาเลตปิดแล้ว
`id`พร็อพเพอร์ตี	`string`	ไว้ใช้เอง เช่น แยกคำสั่งออกจากกันใน `(run)`