chrome.input.ime

Enum

Properties

• announceString

  string optional

  Strings for ChromeVox to announce.

• type

  AssistiveWindowType
• visible

  boolean

  Sets true to show AssistiveWindow, sets false to hide.

Enum

Enum

Properties

• autoCapitalize

  AutoCapitalizeType
  Chrome 69+

  The auto-capitalize type of the text field.

• autoComplete

  boolean

  Whether the text field wants auto-complete.

• autoCorrect

  boolean

  Whether the text field wants auto-correct.

• contextID

  number

  This is used to specify targets of text field operations. This ID becomes invalid as soon as onBlur is called.

• shouldDoLearning

  boolean
  Chrome 68+

  Whether text entered into the text field should be used to improve typing suggestions for the user.

• spellCheck

  boolean

  Whether the text field wants spell-check.

• type

  InputContextType

  Type of value this text field edits, (Text, Number, URL, etc)

Enum

Properties

• altgrKey

  boolean optional
  Chrome 79+

  Whether or not the ALTGR key is pressed.

• altKey

  boolean optional

  Whether or not the ALT key is pressed.

• capsLock

  boolean optional

  Whether or not the CAPS_LOCK is enabled.

• code

  string

  Value of the physical key being pressed. The value is not affected by current keyboard layout or modifier state.

• ctrlKey

  boolean optional

  Whether or not the CTRL key is pressed.

• extensionId

  string optional

  The extension ID of the sender of this keyevent.

• key

  string

  Value of the key being pressed

• keyCode

  number optional

  The deprecated HTML keyCode, which is system- and implementation-dependent numerical code signifying the unmodified identifier associated with the key pressed.

• requestId

  string optional

  (Deprecated) The ID of the request. Use the requestId param from the onKeyEvent event instead.

• shiftKey

  boolean optional

  Whether or not the SHIFT key is pressed.

• type

  KeyboardEventType

  One of keyup or keydown.

Enum

Properties

• checked

  boolean optional

  Indicates this item should be drawn with a check.

• enabled

  boolean optional

  Indicates this item is enabled.

• id

  string

  String that will be passed to callbacks referencing this MenuItem.

• label

  string optional

  Text displayed in the menu for this item.

• style

  MenuItemStyle optional

  The type of menu item.

• visible

  boolean optional

  Indicates this item is visible.

Enum

Properties

• engineID

  string

  ID of the engine to use.

• items

  MenuItem[]

  MenuItems to add or update. They will be added in the order they exist in the array.

Enum

Enum

Enum

Enum

Parameters

• parameters

  object
  • contextID

    number

    ID of the context where the composition will be cleared

• callback

  function optional

  Called when the operation completes with a boolean indicating if the text was accepted or not. On failure, runtime.lastError is set.

  If you specify the parameter, it should be a function that looks like this:

  (success: boolean) => {...}
  • success

    boolean

Parameters

• parameters

  object
  • contextID

    number

    ID of the context where the text will be committed

  • text

    string

    The text to commit

• callback

  function optional

  Called when the operation completes with a boolean indicating if the text was accepted or not. On failure, runtime.lastError is set.

  If you specify the parameter, it should be a function that looks like this:

  (success: boolean) => {...}
  • success

    boolean

Parameters

• parameters

  object
  • contextID

    number

    ID of the context where the surrounding text will be deleted.

  • engineID

    string

    ID of the engine receiving the event.

  • length

    number

    The number of characters to be deleted

  • offset

    number

    The offset from the caret position where deletion will start. This value can be negative.

• callback

  function optional

  Called when the operation completes.

  If you specify the parameter, it should be a function that looks like this:

  () => {...}

Parameters

• requestId

  string

  Request id of the event that was handled. This should come from keyEvent.requestId

• response

  boolean

  True if the keystroke was handled, false if not

Parameters

• parameters

  object
  • contextID

    number

    ID of the context where the key events will be sent, or zero to send key events to non-input field.

  • keyData

    KeyboardEvent[]

    Data on the key event.

• callback

  function optional

  Called when the operation completes.

  If you specify the parameter, it should be a function that looks like this:

  () => {...}

Parameters

• parameters

  object
  • announceString

    string optional

    The text for the screenreader to announce.

  • buttonID

    AssistiveWindowButton

    The ID of the button

  • contextID

    number

    ID of the context owning the assistive window.

  • highlighted

    boolean

    Whether the button should be highlighted.

  • windowType

    AssistiveWindowType

    The window type the button belongs to.

• callback

  function optional

  Called when the operation completes. On failure, runtime.lastError is set.

  If you specify the parameter, it should be a function that looks like this:

  () => {...}

Parameters

• parameters

  object
  • contextID

    number

    ID of the context owning the assistive window.

  • properties

    AssistiveWindowProperties

    Properties of the assistive window.

• callback

  function optional

  Called when the operation completes.

  If you specify the parameter, it should be a function that looks like this:

  (success: boolean) => {...}
  • success

    boolean

Parameters

• parameters

  object
  • candidates

    object[]

    List of candidates to show in the candidate window

    • annotation

      string optional

      Additional text describing the candidate

    • candidate

      string

      The candidate

    • id

      number

      The candidate's id

    • label

      string optional

      Short string displayed to next to the candidate, often the shortcut key or index

    • parentId

      number optional

      The id to add these candidates under

    • usage

      object optional

      The usage or detail description of word.

      • body

        string

        The body string of detail description.

      • title

        string

        The title string of details description.

  • contextID

    number

    ID of the context that owns the candidate window.

• callback

  function optional

  Called when the operation completes.

  If you specify the parameter, it should be a function that looks like this:

  (success: boolean) => {...}
  • success

    boolean

Parameters

• parameters

  object
  • engineID

    string

    ID of the engine to set properties on.

  • properties

    object
    • auxiliaryText

      string optional

      Text that is shown at the bottom of the candidate window.

    • auxiliaryTextVisible

      boolean optional

      True to display the auxiliary text, false to hide it.

    • currentCandidateIndex

      number optional
      Chrome 84+

      The index of the current chosen candidate out of total candidates.

    • cursorVisible

      boolean optional

      True to show the cursor, false to hide it.

    • pageSize

      number optional

      The number of candidates to display per page.

    • totalCandidates

      number optional
      Chrome 84+

      The total number of candidates for the candidate window.

    • vertical

      boolean optional

      True if the candidate window should be rendered vertical, false to make it horizontal.

    • visible

      boolean optional

      True to show the Candidate window, false to hide it.

    • windowPosition

      WindowPosition optional

      Where to display the candidate window.

• callback

  function optional

  Called when the operation completes.

  If you specify the parameter, it should be a function that looks like this:

  (success: boolean) => {...}
  • success

    boolean

Parameters

• parameters

  object
  • contextID

    number

    ID of the context where the composition text will be set

  • cursor

    number

    Position in the text of the cursor.

  • segments

    object[] optional

    List of segments and their associated types.

    • end

      number

      Index of the character to end this segment after.

    • start

      number

      Index of the character to start this segment at

    • style

      UnderlineStyle

      The type of the underline to modify this segment.

  • selectionEnd

    number optional

    Position in the text that the selection ends at.

  • selectionStart

    number optional

    Position in the text that the selection starts at.

  • text

    string

    Text to set

• callback

  function optional

  Called when the operation completes with a boolean indicating if the text was accepted or not. On failure, runtime.lastError is set.

  If you specify the parameter, it should be a function that looks like this:

  (success: boolean) => {...}
  • success

    boolean

Parameters

• parameters

  object
  • candidateID

    number

    ID of the candidate to select.

  • contextID

    number

    ID of the context that owns the candidate window.

• callback

  function optional

  Called when the operation completes

  If you specify the parameter, it should be a function that looks like this:

  (success: boolean) => {...}
  • success

    boolean

Parameters

• parameters

  MenuParameters
• callback

  function optional

  If you specify the parameter, it should be a function that looks like this:

  () => {...}

Parameters

• parameters

  MenuParameters
• callback

  function optional

  Called when the operation completes

  If you specify the parameter, it should be a function that looks like this:

  () => {...}

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (engineID: string, screen: ScreenType) => {...}
  • engineID

    string

    ID of the engine receiving the event

  • screen

    ScreenType

    The screen type under which the IME is activated.

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (details: object) => {...}
  • details

    object
    • buttonID

      AssistiveWindowButton

      The ID of the button clicked.

    • windowType

      AssistiveWindowType

      The type of the assistive window.

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (contextID: number) => {...}
  • contextID

    number

    The ID of the text field that has lost focus. The ID is invalid after this call

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (engineID: string, candidateID: number, button: MouseButton) => {...}
  • engineID

    string

    ID of the engine receiving the event

  • candidateID

    number

    ID of the candidate that was clicked.

  • button

    MouseButton

    Which mouse buttons was clicked.

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (engineID: string) => {...}
  • engineID

    string

    ID of the engine receiving the event

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (context: InputContext) => {...}
  • context

    InputContext

    Describes the text field that has acquired focus.

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (context: InputContext) => {...}
  • context

    InputContext

    An InputContext object describing the text field that has changed.

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (engineID: string, keyData: KeyboardEvent, requestId: string) => {...}
  • engineID

    string

    ID of the engine receiving the event

  • keyData

    KeyboardEvent

    Data on the key event

  • requestId

    string
    Chrome 79+

    ID of the request. If the event listener returns undefined, then keyEventHandled must be called later with this requestId.

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (engineID: string, name: string) => {...}
  • engineID

    string

    ID of the engine receiving the event

  • name

    string

    Name of the MenuItem which was activated

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (engineID: string) => {...}
  • engineID

    string

    ID of the engine receiving the event

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (engineID: string, surroundingInfo: object) => {...}
  • engineID

    string

    ID of the engine receiving the event

  • surroundingInfo

    object

    The surrounding information.

    • anchor

      number

      The beginning position of the selection. This value indicates caret position if there is no selection.

    • focus

      number

      The ending position of the selection. This value indicates caret position if there is no selection.

    • offset

      number

      The offset position of text. Since text only includes a subset of text around the cursor, offset indicates the absolute position of the first character of text.

    • text

      string

      The text around the cursor. This is only a subset of all text in the input field.