browser.input.ime

สำคัญ: API นี้ใช้ได้ใน ChromeOS เท่านั้น

คำอธิบาย

ใช้ chrome.input.ime API เพื่อใช้ IME ที่กำหนดเองสำหรับ ChromeOS ซึ่งจะช่วยให้ส่วนขยายจัดการการกดแป้นพิมพ์ ตั้งค่าการจัดองค์ประกอบ และจัดการหน้าต่างตัวเลือกได้

สิทธิ์

input

คุณต้องประกาศสิทธิ์ "input" ในไฟล์ Manifest ของส่วนขยายเพื่อใช้ input.ime API เช่น

{
  "name": "My extension",
  ...
  "permissions": [
    "input"
  ],
  ...
}

ความพร้อมใช้งาน

ChromeOS เท่านั้น

ตัวอย่าง

โค้ดต่อไปนี้จะสร้าง IME ที่แปลงตัวอักษรที่พิมพ์เป็นตัวพิมพ์ใหญ่

var context_id = -1;

browser.input.ime.onFocus.addListener(function(context) {
  context_id = context.contextID;
});

browser.input.ime.onKeyEvent.addListener(
  function(engineID, keyData) {
    if (keyData.type == "keydown" && keyData.key.match(/^[a-z]$/)) {
      browser.input.ime.commitText({"contextID": context_id,
                                    "text": keyData.key.toUpperCase()});
      return true;
    } else {
      return false;
    }
  }
);

ประเภท

AssistiveWindowButton

Chrome 85 ขึ้นไป browser.* ตั้งแต่ Chrome 148

รหัสของปุ่มในหน้าต่างความช่วยเหลือพิเศษ

ค่าแจกแจง

"undo"

"addToDictionary"

AssistiveWindowProperties

Chrome 85 ขึ้นไป browser.* ตั้งแต่ Chrome 148

พร็อพเพอร์ตี้ของหน้าต่างความช่วยเหลือพิเศษ

พร็อพเพอร์ตี้

• announceString

  สตริง ไม่บังคับ

  สตริงสำหรับ ChromeVox เพื่อประกาศ

• ประเภท

  "undo"
  

• มองเห็นได้

  บูลีน

  ตั้งค่าเป็น "จริง" เพื่อแสดง AssistiveWindow และตั้งค่าเป็น "เท็จ" เพื่อซ่อน

AssistiveWindowType

Chrome 85 ขึ้นไป browser.* ตั้งแต่ Chrome 148

ประเภทของหน้าต่างความช่วยเหลือพิเศษ

ค่า

"undo"

AutoCapitalizeType

Chrome 69 ขึ้นไป browser.* ตั้งแต่ Chrome 148

ประเภทการใช้อักษรตัวพิมพ์ใหญ่อัตโนมัติของช่องข้อความ

ค่าแจกแจง

"characters"

"words"

"sentences"

InputContext

อธิบายบริบทอินพุต

พร็อพเพอร์ตี้

• autoCapitalize

  AutoCapitalizeType

  Chrome 69 ขึ้นไป browser.* ตั้งแต่ Chrome 148

  ประเภทการใช้อักษรตัวพิมพ์ใหญ่อัตโนมัติของช่องข้อความ

• autoComplete

  บูลีน

  ระบุว่าช่องข้อความต้องการการเติมข้อความอัตโนมัติหรือไม่

• autoCorrect

  บูลีน

  ช่องข้อความต้องการการแก้ไขอัตโนมัติหรือไม่

• contextID

  ตัวเลข

  ซึ่งใช้เพื่อระบุเป้าหมายของการดำเนินการกับช่องข้อความ รหัสนี้จะใช้ไม่ได้ทันทีที่มีการเรียก onBlur

• shouldDoLearning

  บูลีน

  เบราว์เซอร์ Chrome 68 ขึ้นไป * ตั้งแต่ Chrome 148

  ระบุว่าควรใช้ข้อความที่ป้อนในช่องข้อความเพื่อปรับปรุงคำแนะนำในการพิมพ์สำหรับผู้ใช้หรือไม่

• spellCheck

  บูลีน

  ช่องข้อความต้องการการตรวจตัวสะกดหรือไม่

• ประเภท

  InputContextType

  ประเภทค่าที่ช่องข้อความนี้แก้ไข (ข้อความ ตัวเลข URL ฯลฯ)

InputContextType

Chrome 44 ขึ้นไป browser.* ตั้งแต่ Chrome 148

ประเภทค่าที่ช่องข้อความนี้แก้ไข (ข้อความ ตัวเลข URL ฯลฯ)

ค่าแจกแจง

"text"

"search"

"tel"

"url"

"email"

"number"

"password"

"null"

KeyboardEvent

ดู http://www.w3.org/TR/DOM-Level-3-Events/#events-KeyboardEvent

พร็อพเพอร์ตี้

• altKey

  บูลีน ไม่บังคับ

  มีการกดแป้น ALT หรือไม่

• altgrKey

  บูลีน ไม่บังคับ

  Chrome 79 ขึ้นไป เบราว์เซอร์* ตั้งแต่ Chrome 148

  มีการกดแป้น ALTGR หรือไม่

• capsLock

  บูลีน ไม่บังคับ

  เปิดใช้ CAPS_LOCK หรือไม่

• รหัส

  สตริง

  ค่าของแป้นจริงที่กด ค่านี้จะไม่ได้รับผลกระทบจากรูปแบบแป้นพิมพ์ปัจจุบันหรือสถานะตัวแก้ไข

• ctrlKey

  บูลีน ไม่บังคับ

  มีการกดปุ่ม CTRL หรือไม่

• extensionId

  สตริง ไม่บังคับ

  รหัสส่วนขยายของผู้ส่งเหตุการณ์สำคัญนี้

• แป้น

  สตริง

  ค่าของแป้นที่กด

• keyCode

  number ไม่บังคับ

  keyCode ของ HTML ที่เลิกใช้งานแล้ว ซึ่งเป็นรหัสตัวเลขที่ขึ้นอยู่กับระบบและการใช้งาน ซึ่งแสดงถึงตัวระบุที่ไม่มีการแก้ไขซึ่งเชื่อมโยงกับแป้นที่กด

• requestId

  สตริง ไม่บังคับ

  (เลิกใช้งานแล้ว) รหัสของคำขอ ใช้พารามิเตอร์ requestId จากเหตุการณ์ onKeyEvent แทน

• shiftKey

  บูลีน ไม่บังคับ

  มีการกดแป้น SHIFT หรือไม่

• ประเภท

  KeyboardEventType

  keyup หรือ keydown อย่างใดอย่างหนึ่ง

KeyboardEventType

Chrome 44 ขึ้นไป browser.* ตั้งแต่ Chrome 148

ค่าแจกแจง

"keyup"

"keydown"

MenuItem

รายการเมนูที่วิธีการป้อนข้อมูลใช้เพื่อโต้ตอบกับผู้ใช้จากเมนูภาษา

พร็อพเพอร์ตี้

• เลือกแล้ว

  บูลีน ไม่บังคับ

  ระบุว่าควรวาดรายการนี้ด้วยเครื่องหมายถูก

• เปิดอยู่

  บูลีน ไม่บังคับ

  ระบุว่าเปิดใช้รายการนี้แล้ว

• id

  สตริง

  สตริงที่จะส่งไปยัง Callback ที่อ้างอิง MenuItem นี้

• ป้ายกำกับ

  สตริง ไม่บังคับ

  ข้อความที่แสดงในเมนูสำหรับรายการนี้

• รูปแบบ

  MenuItemStyle ไม่บังคับ

  ประเภทของรายการในเมนู

• มองเห็นได้

  บูลีน ไม่บังคับ

  ระบุว่ารายการนี้มองเห็นได้

MenuItemStyle

Chrome 44 ขึ้นไป browser.* ตั้งแต่ Chrome 148

ประเภทของรายการในเมนู ปุ่มตัวเลือกระหว่างตัวคั่นจะถือว่าจัดกลุ่มแล้ว

ค่าแจกแจง

"ตรวจ"

"radio"

"separator"

MenuParameters

Chrome 88 ขึ้นไป browser.* ตั้งแต่ Chrome 148

พร็อพเพอร์ตี้

• engineID

  สตริง

  รหัสของเครื่องมือที่จะใช้

• รายการ

  MenuItem[]

  MenuItems ที่จะเพิ่มหรืออัปเดต ระบบจะเพิ่มรายการตามลำดับที่มีอยู่ในอาร์เรย์

MouseButton

Chrome 44 ขึ้นไป browser.* ตั้งแต่ Chrome 148

ปุ่มเมาส์ที่คลิก

ค่าแจกแจง

"left"

"middle"

"right"

ScreenType

Chrome 44 ขึ้นไป browser.* ตั้งแต่ Chrome 148

ประเภทหน้าจอที่เปิดใช้งาน IME

ค่าแจกแจง

"normal"

"login"

"ล็อก"

"secondary-login"

UnderlineStyle

Chrome 44 ขึ้นไป browser.* ตั้งแต่ Chrome 148

ประเภทของขีดเส้นใต้เพื่อแก้ไขกลุ่มนี้

ค่าแจกแจง

"underline"

"doubleUnderline"

"noUnderline"

WindowPosition

Chrome 44 ขึ้นไป browser.* ตั้งแต่ Chrome 148

ตำแหน่งที่จะแสดงหน้าต่างตัวเลือก หากตั้งค่าเป็น "cursor" หน้าต่างจะเลื่อนตามเคอร์เซอร์ หากตั้งค่าเป็น "composition" หน้าต่างจะล็อกไว้ที่จุดเริ่มต้นขององค์ประกอบ

ค่าแจกแจง

"cursor"

"composition"

เมธอด

clearComposition()

browser.input.ime.clearComposition(
  parameters: object,
): Promise<boolean>

ล้างองค์ประกอบปัจจุบัน หากส่วนขยายนี้ไม่ได้เป็นเจ้าของ IME ที่ใช้งานอยู่ การดำเนินการนี้จะไม่สำเร็จ

พารามิเตอร์

• พารามิเตอร์

  ออบเจ็กต์

  • contextID

    ตัวเลข

    รหัสของบริบทที่จะล้างองค์ประกอบ

การคืนสินค้า

• Promise<boolean>

  Chrome 111 ขึ้นไป browser.* ตั้งแต่ Chrome 148

  แก้ไขเมื่อการดำเนินการเสร็จสมบูรณ์ด้วยบูลีนที่ระบุว่าข้อความได้รับการยอมรับหรือไม่ หากดำเนินการไม่สำเร็จ ระบบจะปฏิเสธ Promise

commitText()

browser.input.ime.commitText(
  parameters: object,
): Promise<boolean>

ยืนยันข้อความที่ระบุไปยังอินพุตปัจจุบัน

พารามิเตอร์

• พารามิเตอร์

  ออบเจ็กต์

  • contextID

    ตัวเลข

    รหัสของบริบทที่จะคอมมิตข้อความ

  • ข้อความ

    สตริง

    ข้อความที่จะคอมมิต

การคืนสินค้า

• Promise<boolean>

  Chrome 111 ขึ้นไป browser.* ตั้งแต่ Chrome 148

  แก้ไขเมื่อการดำเนินการเสร็จสมบูรณ์ด้วยบูลีนที่ระบุว่าข้อความได้รับการยอมรับหรือไม่ หากดำเนินการไม่สำเร็จ ระบบจะปฏิเสธ Promise

deleteSurroundingText()

browser.input.ime.deleteSurroundingText(
  parameters: object,
): Promise<void>

ลบข้อความรอบๆ เคอร์เซอร์ข้อความ

พารามิเตอร์

• พารามิเตอร์

  ออบเจ็กต์

  • contextID

    ตัวเลข

    รหัสของบริบทที่จะลบข้อความโดยรอบ

  • engineID

    สตริง

    รหัสของเครื่องมือค้นหาที่ได้รับเหตุการณ์

  • ความยาว

    ตัวเลข

    จำนวนอักขระที่จะลบ

  • offset

    ตัวเลข

    ออฟเซ็ตจากตำแหน่งเคอร์เซอร์ข้อความที่การลบจะเริ่มต้น ค่านี้อาจเป็นค่าลบได้

การคืนสินค้า

• Promise<void>

  Chrome 111 ขึ้นไป browser.* ตั้งแต่ Chrome 148

  แก้ไขเมื่อการดำเนินการเสร็จสมบูรณ์

hideInputView()

browser.input.ime.hideInputView(): void

ซ่อนหน้าต่างมุมมองการป้อนข้อมูลซึ่งระบบแสดงขึ้นโดยอัตโนมัติ หากหน้าต่างมุมมองอินพุตซ่อนอยู่แล้ว ฟังก์ชันนี้จะไม่ดำเนินการใดๆ

keyEventHandled()

browser.input.ime.keyEventHandled(
  requestId: string,
  response: boolean,
): void

ระบุว่าเหตุการณ์สำคัญที่ onKeyEvent ได้รับได้รับการจัดการแล้ว ควรเรียกใช้เมธอดนี้เฉพาะในกรณีที่ Listener onKeyEvent เป็นแบบอะซิงโครนัส

พารามิเตอร์

• requestId

  สตริง

  รหัสคำขอของเหตุการณ์ที่จัดการแล้ว ซึ่งควรมาจาก keyEvent.requestId

• การตอบกลับ

  บูลีน

  เป็นจริงหากมีการจัดการการกดแป้นพิมพ์ เป็นเท็จหากไม่มี

sendKeyEvents()

browser.input.ime.sendKeyEvents(
  parameters: object,
): Promise<void>

ส่งเหตุการณ์สําคัญ ฟังก์ชันนี้คาดว่าจะใช้โดยแป้นพิมพ์เสมือน เมื่อผู้ใช้กดแป้นบนแป้นพิมพ์เสมือน ระบบจะใช้ฟังก์ชันนี้เพื่อเผยแพร่เหตุการณ์นั้นไปยังระบบ

พารามิเตอร์

• พารามิเตอร์

  ออบเจ็กต์

  • contextID

    ตัวเลข

    รหัสของบริบทที่จะส่งเหตุการณ์สำคัญ หรือ 0 เพื่อส่งเหตุการณ์สำคัญไปยังช่องที่ไม่ใช่ช่องป้อนข้อมูล

  • keyData

    KeyboardEvent[]

    ข้อมูลเกี่ยวกับเหตุการณ์สําคัญ

การคืนสินค้า

• Promise<void>

  Chrome 111 ขึ้นไป browser.* ตั้งแต่ Chrome 148

  แก้ไขเมื่อการดำเนินการเสร็จสมบูรณ์

setAssistiveWindowButtonHighlighted()

Chrome 86 ขึ้นไป browser.* ตั้งแต่ Chrome 148

browser.input.ime.setAssistiveWindowButtonHighlighted(
  parameters: object,
): Promise<void>

ไฮไลต์/ยกเลิกการไฮไลต์ปุ่มในหน้าต่างความช่วยเหลือพิเศษ

พารามิเตอร์

• พารามิเตอร์

  ออบเจ็กต์

  • announceString

    สตริง ไม่บังคับ

    ข้อความที่โปรแกรมอ่านหน้าจอจะอ่านออกเสียง

  • buttonID

    AssistiveWindowButton

    รหัสของปุ่ม

  • contextID

    ตัวเลข

    รหัสของบริบทที่เป็นเจ้าของหน้าต่างความช่วยเหลือ

  • ไฮไลต์ไว้

    บูลีน

    ควรไฮไลต์ปุ่มหรือไม่

  • windowType

    "undo"
    

    ประเภทหน้าต่างที่ปุ่มเป็นสมาชิก

การคืนสินค้า

• Promise<void>

  Chrome 111 ขึ้นไป browser.* ตั้งแต่ Chrome 148

  แก้ไขเมื่อการดำเนินการเสร็จสมบูรณ์ หากดำเนินการไม่สำเร็จ ระบบจะปฏิเสธ Promise

setAssistiveWindowProperties()

Chrome 85 ขึ้นไป browser.* ตั้งแต่ Chrome 148

browser.input.ime.setAssistiveWindowProperties(
  parameters: object,
): Promise<boolean>

แสดง/ซ่อนหน้าต่างความช่วยเหลือที่มีพร็อพเพอร์ตี้ที่ระบุ

พารามิเตอร์

• พารามิเตอร์

  ออบเจ็กต์

  • contextID

    ตัวเลข

    รหัสของบริบทที่เป็นเจ้าของหน้าต่างความช่วยเหลือ

  • พร็อพเพอร์ตี้

    AssistiveWindowProperties

    พร็อพเพอร์ตี้ของหน้าต่างความช่วยเหลือพิเศษ

การคืนสินค้า

• Promise<boolean>

  Chrome 111 ขึ้นไป browser.* ตั้งแต่ Chrome 148

  แก้ไขเมื่อการดำเนินการเสร็จสมบูรณ์

setCandidates()

browser.input.ime.setCandidates(
  parameters: object,
): Promise<boolean>

ตั้งค่ารายการผู้สมัครปัจจุบัน การดำเนินการนี้จะล้มเหลวหากส่วนขยายนี้ไม่ได้เป็นเจ้าของ IME ที่ใช้งานอยู่

พารามิเตอร์

• พารามิเตอร์

  ออบเจ็กต์

  • ผู้สมัคร

    object[]

    รายการตัวเลือกที่จะแสดงในหน้าต่างตัวเลือก

    • คำอธิบายประกอบ

      สตริง ไม่บังคับ

      ข้อความเพิ่มเติมที่อธิบายผู้สมัคร

    • ตัวเลือก

      สตริง

      ผู้สมัคร

    • id

      ตัวเลข

      รหัสของผู้สมัคร

    • ป้ายกำกับ

      สตริง ไม่บังคับ

      สตริงสั้นๆ ที่แสดงข้างตัวเลือก ซึ่งมักเป็นแป้นพิมพ์ลัดหรือดัชนี

    • parentId

      number ไม่บังคับ

      รหัสที่จะเพิ่มผู้สมัครเหล่านี้ไว้ด้านล่าง

    • การใช้งาน

      object ไม่บังคับ

      คำอธิบายการใช้งานหรือรายละเอียดของคำ

      • เนื้อความ

        สตริง

        สตริงเนื้อหาของคำอธิบายโดยละเอียด

      • title

        สตริง

        สตริงชื่อของคำอธิบายรายละเอียด

  • contextID

    ตัวเลข

    รหัสของบริบทที่เป็นเจ้าของหน้าต่างตัวเลือก

การคืนสินค้า

• Promise<boolean>

  Chrome 111 ขึ้นไป browser.* ตั้งแต่ Chrome 148

  แก้ไขเมื่อการดำเนินการเสร็จสมบูรณ์

setCandidateWindowProperties()

browser.input.ime.setCandidateWindowProperties(
  parameters: object,
): Promise<boolean>

ตั้งค่าพร็อพเพอร์ตี้ของหน้าต่างตัวเลือก การดำเนินการนี้จะล้มเหลวหากส่วนขยายไม่ได้เป็นเจ้าของ IME ที่ใช้งานอยู่

พารามิเตอร์

• พารามิเตอร์

  ออบเจ็กต์

  • engineID

    สตริง

    รหัสของเครื่องมือที่จะตั้งค่าพร็อพเพอร์ตี้

  • พร็อพเพอร์ตี้

    ออบเจ็กต์

    • auxiliaryText

      สตริง ไม่บังคับ

      ข้อความที่แสดงที่ด้านล่างของหน้าต่างตัวเลือก

    • auxiliaryTextVisible

      บูลีน ไม่บังคับ

      True เพื่อแสดงข้อความเสริม False เพื่อซ่อน

    • currentCandidateIndex

      number ไม่บังคับ

      Chrome 84 ขึ้นไป browser.* ตั้งแต่ Chrome 148

      ดัชนีของผู้สมัครที่เลือกในปัจจุบันจากผู้สมัครทั้งหมด

    • cursorVisible

      บูลีน ไม่บังคับ

      เป็นจริงเพื่อแสดงเคอร์เซอร์ เป็นเท็จเพื่อซ่อนเคอร์เซอร์

    • pageSize

      number ไม่บังคับ

      จำนวนผู้สมัครที่จะแสดงต่อหน้า

    • totalCandidates

      number ไม่บังคับ

      Chrome 84 ขึ้นไป browser.* ตั้งแต่ Chrome 148

      จำนวนผู้สมัครทั้งหมดสำหรับกรอบเวลาของผู้สมัคร

    • แนวตั้ง

      บูลีน ไม่บังคับ

      เป็นจริงหากควรแสดงผลหน้าต่างตัวเลือกเป็นแนวตั้ง เป็นเท็จหากต้องการให้เป็นแนวนอน

    • มองเห็นได้

      บูลีน ไม่บังคับ

      เป็นจริงเพื่อแสดงหน้าต่างตัวเลือก เป็นเท็จเพื่อซ่อน

    • windowPosition

      WindowPosition ไม่บังคับ

      ตำแหน่งที่จะแสดงหน้าต่างตัวเลือก

การคืนสินค้า

• Promise<boolean>

  Chrome 111 ขึ้นไป browser.* ตั้งแต่ Chrome 148

  แก้ไขเมื่อการดำเนินการเสร็จสมบูรณ์

setComposition()

browser.input.ime.setComposition(
  parameters: object,
): Promise<boolean>

ตั้งค่าองค์ประกอบปัจจุบัน หากส่วนขยายนี้ไม่ได้เป็นเจ้าของ IME ที่ใช้งานอยู่ การดำเนินการนี้จะไม่สำเร็จ

พารามิเตอร์

• พารามิเตอร์

  ออบเจ็กต์

  • contextID

    ตัวเลข

    รหัสของบริบทที่จะตั้งค่าข้อความการเรียบเรียง

  • เคอร์เซอร์

    ตัวเลข

    ตำแหน่งในข้อความของเคอร์เซอร์

  • กลุ่ม

    object[] ไม่บังคับ

    รายการกลุ่มและประเภทที่เกี่ยวข้อง

    • end

      ตัวเลข

      ดัชนีของอักขระที่จะสิ้นสุดกลุ่มนี้หลังจากนั้น

    • start

      ตัวเลข

      ดัชนีของอักขระที่จะเริ่มส่วนนี้

    • รูปแบบ

      UnderlineStyle

      ประเภทของขีดเส้นใต้เพื่อแก้ไขกลุ่มนี้

  • selectionEnd

    number ไม่บังคับ

    ตำแหน่งในข้อความที่การเลือกสิ้นสุดลง

  • selectionStart

    number ไม่บังคับ

    ตำแหน่งในข้อความที่การเลือกเริ่มต้น

  • ข้อความ

    สตริง

    ข้อความที่จะตั้งค่า

การคืนสินค้า

• Promise<boolean>

  Chrome 111 ขึ้นไป browser.* ตั้งแต่ Chrome 148

  แก้ไขเมื่อการดำเนินการเสร็จสมบูรณ์ด้วยบูลีนที่ระบุว่าข้อความได้รับการยอมรับหรือไม่ หากดำเนินการไม่สำเร็จ ระบบจะปฏิเสธ Promise

setCursorPosition()

browser.input.ime.setCursorPosition(
  parameters: object,
): Promise<boolean>

ตั้งค่าตำแหน่งของเคอร์เซอร์ในหน้าต่างตัวเลือก การดำเนินการนี้จะไม่มีผลหากส่วนขยายนี้ไม่ได้เป็นเจ้าของ IME ที่ใช้งานอยู่

พารามิเตอร์

• พารามิเตอร์

  ออบเจ็กต์

  • candidateID

    ตัวเลข

    รหัสของผู้สมัครที่ต้องการเลือก

  • contextID

    ตัวเลข

    รหัสของบริบทที่เป็นเจ้าของหน้าต่างตัวเลือก

การคืนสินค้า

• Promise<boolean>

  Chrome 111 ขึ้นไป browser.* ตั้งแต่ Chrome 148

  แก้ไขเมื่อการดำเนินการเสร็จสมบูรณ์

setMenuItems()

browser.input.ime.setMenuItems(
  parameters: MenuParameters,
): Promise<void>

เพิ่มรายการเมนูที่ระบุลงในเมนูภาษาเมื่อ IME นี้ทำงานอยู่

พารามิเตอร์

• พารามิเตอร์

  MenuParameters

การคืนสินค้า

• Promise<void>

  Chrome 111 ขึ้นไป browser.* ตั้งแต่ Chrome 148

updateMenuItems()

browser.input.ime.updateMenuItems(
  parameters: MenuParameters,
): Promise<void>

อัปเดตสถานะของ MenuItem ที่ระบุ

พารามิเตอร์

• พารามิเตอร์

  MenuParameters

การคืนสินค้า

• Promise<void>

  Chrome 111 ขึ้นไป browser.* ตั้งแต่ Chrome 148

  แก้ไขเมื่อการดำเนินการเสร็จสมบูรณ์

กิจกรรม

onActivate

browser.input.ime.onActivate.addListener(
  callback: function,
)

ระบบจะส่งเหตุการณ์นี้เมื่อเปิดใช้งาน IME ซึ่งจะส่งสัญญาณว่า IME จะได้รับเหตุการณ์ onKeyPress

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (engineID: string, screen: ScreenType) => void

  • engineID

    สตริง

  • หน้าจอ

    ScreenType

onAssistiveWindowButtonClicked

Chrome 85 ขึ้นไป browser.* ตั้งแต่ Chrome 148

browser.input.ime.onAssistiveWindowButtonClicked.addListener(
  callback: function,
)

ระบบจะส่งเหตุการณ์นี้เมื่อมีการคลิกปุ่มในหน้าต่างช่วยเหลือ

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (details: object) => void

  • รายละเอียด

    ออบเจ็กต์

    • buttonID

      AssistiveWindowButton

      รหัสของปุ่มที่คลิก

    • windowType

      AssistiveWindowType

      ประเภทของหน้าต่างความช่วยเหลือ

onBlur

browser.input.ime.onBlur.addListener(
  callback: function,
)

ระบบจะส่งเหตุการณ์นี้เมื่อโฟกัสออกจากกล่องข้อความ ระบบจะส่งเหตุการณ์นี้ไปยังส่วนขยายทั้งหมดที่รอรับเหตุการณ์นี้อยู่ และผู้ใช้เปิดใช้ไว้

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (contextID: number) => void

  • contextID

    ตัวเลข

onCandidateClicked

browser.input.ime.onCandidateClicked.addListener(
  callback: function,
)

ระบบจะส่งเหตุการณ์นี้หากส่วนขยายนี้เป็นเจ้าของ IME ที่ใช้งานอยู่

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (engineID: string, candidateID: number, button: MouseButton) => void

  • engineID

    สตริง

  • candidateID

    ตัวเลข

  • ปุ่ม

    MouseButton

onDeactivated

browser.input.ime.onDeactivated.addListener(
  callback: function,
)

ระบบจะส่งเหตุการณ์นี้เมื่อปิดใช้งาน IME ซึ่งเป็นการส่งสัญญาณว่า IME จะไม่ได้รับเหตุการณ์ onKeyPress อีกต่อไป

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (engineID: string) => void

  • engineID

    สตริง

onFocus

browser.input.ime.onFocus.addListener(
  callback: function,
)

ระบบจะส่งเหตุการณ์นี้เมื่อโฟกัสเข้าสู่กล่องข้อความ ระบบจะส่งเหตุการณ์นี้ไปยังส่วนขยายทั้งหมดที่รอรับเหตุการณ์นี้อยู่ และผู้ใช้เปิดใช้ไว้

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (context: InputContext) => void

  • บริบท

    InputContext

onInputContextUpdate

browser.input.ime.onInputContextUpdate.addListener(
  callback: function,
)

ระบบจะส่งเหตุการณ์นี้เมื่อพร็อพเพอร์ตี้ของ InputContext ปัจจุบันมีการเปลี่ยนแปลง เช่น ประเภท ระบบจะส่งเหตุการณ์นี้ไปยังส่วนขยายทั้งหมดที่รอรับเหตุการณ์นี้อยู่ และผู้ใช้เปิดใช้ไว้

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (context: InputContext) => void

  • บริบท

    InputContext

onKeyEvent

browser.input.ime.onKeyEvent.addListener(
  callback: function,
)

เริ่มทำงานเมื่อมีการส่งเหตุการณ์สำคัญจากระบบปฏิบัติการ ระบบจะส่งเหตุการณ์ไปยังส่วนขยายหากส่วนขยายนี้เป็นเจ้าของ IME ที่ใช้งานอยู่ ฟังก์ชัน Listener ควรแสดงผลเป็น "จริง" หากมีการจัดการเหตุการณ์แล้ว และแสดงผลเป็น "เท็จ" หากยังไม่มีการจัดการ หากระบบจะประเมินเหตุการณ์แบบอะซิงโครนัส ฟังก์ชันนี้ต้องแสดงผลเป็น "ไม่ระบุ" และ IME ต้องเรียกใช้ keyEventHandled() พร้อมผลลัพธ์ในภายหลัง

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (engineID: string, keyData: KeyboardEvent, requestId: string) => boolean | undefined

  • engineID

    สตริง

  • keyData

    KeyboardEvent

  • requestId

    สตริง

  • returns

    boolean | undefined

onMenuItemActivated

browser.input.ime.onMenuItemActivated.addListener(
  callback: function,
)

เรียกใช้เมื่อผู้ใช้เลือกรายการเมนู

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (engineID: string, name: string) => void

  • engineID

    สตริง

  • name

    สตริง

onReset

browser.input.ime.onReset.addListener(
  callback: function,
)

ระบบจะส่งเหตุการณ์นี้เมื่อ Chrome สิ้นสุดเซสชันการป้อนข้อความที่ดำเนินอยู่

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (engineID: string) => void

  • engineID

    สตริง

onSurroundingTextChanged

browser.input.ime.onSurroundingTextChanged.addListener(
  callback: function,
)

ระบบจะเรียกใช้เมื่อมีการเปลี่ยนแปลงสตริงที่แก้ไขได้รอบๆ เคอร์เซอร์ หรือเมื่อมีการย้ายตำแหน่งเคอร์เซอร์ ความยาวของข้อความจำกัดอยู่ที่ 100 อักขระสำหรับการโต้ตอบแต่ละครั้ง

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (engineID: string, surroundingInfo: object) => void

  • engineID

    สตริง

  • surroundingInfo

    ออบเจ็กต์

    • แท็ก Anchor

      ตัวเลข

      ตำแหน่งเริ่มต้นของการเลือก ค่านี้จะระบุตำแหน่งเคอร์เซอร์ข้อความหากไม่มีการเลือก

    • โฟกัส

      ตัวเลข

      ตำแหน่งสิ้นสุดของส่วนที่เลือก ค่านี้จะระบุตำแหน่งเคอร์เซอร์ข้อความหากไม่มีการเลือก

    • offset

      ตัวเลข

      Chrome 46 ขึ้นไป browser.* ตั้งแต่ Chrome 148

      ตำแหน่งออฟเซ็ตของ text เนื่องจาก text มีเฉพาะชุดย่อยของข้อความรอบเคอร์เซอร์ ออฟเซ็ตจึงระบุตำแหน่งสัมบูรณ์ของอักขระตัวแรกของ text

    • ข้อความ

      สตริง

      ข้อความรอบเคอร์เซอร์ นี่เป็นเพียงส่วนหนึ่งของข้อความทั้งหมดในช่องป้อนข้อมูล