browser.input.ime

Descripción

Usa la API de chrome.input.ime para implementar un IME personalizado para ChromeOS. Esto permite que tu extensión controle las pulsaciones de teclas, establezca la composición y administre la ventana de candidatos.

Permisos

input

Debes declarar el permiso "input" en el manifiesto de la extensión para usar la API de input.ime. Por ejemplo:

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

Disponibilidad

Solo en ChromeOS

Ejemplos

El siguiente código crea un IME que convierte las letras escritas en mayúsculas.

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;
    }
  }
);

Tipos

AssistiveWindowButton

Chrome 85 y versiones posteriores browser.* desde Chrome 148

ID de los botones de la ventana de asistencia.

Enum

"undo"

"addToDictionary"

AssistiveWindowProperties

Chrome 85 y versiones posteriores browser.* desde Chrome 148

Son las propiedades de la ventana de asistencia.

Propiedades

  • announceString

    string opcional

    Son cadenas que ChromeVox anuncia.

  • tipo

    "undo"

  • visible

    booleano

    Establece el valor verdadero para mostrar AssistiveWindow y el valor falso para ocultarlo.

AssistiveWindowType

Chrome 85 y versiones posteriores browser.* desde Chrome 148

Es el tipo de ventana de asistencia.

Valor

"undo"

AutoCapitalizeType

Chrome 69 y versiones posteriores browser.* desde Chrome 148

Es el tipo de uso automático de mayúsculas del campo de texto.

Enum

"characters"

"palabras"

"sentences"

InputContext

Describe un contexto de entrada

Propiedades

  • autoCapitalize

    AutoCapitalizeType

    Chrome 69 y versiones posteriores browser.* desde Chrome 148

    Es el tipo de uso automático de mayúsculas del campo de texto.

  • autoComplete

    booleano

    Indica si el campo de texto requiere autocompletado.

  • autoCorrect

    booleano

    Indica si el campo de texto quiere corrección automática.

  • contextID

    número

    Se usa para especificar los destinos de las operaciones de campos de texto. Este ID deja de ser válido en cuanto se llama a onBlur.

  • shouldDoLearning

    booleano

    Chrome 68 y versiones posteriores browser.* desde Chrome 148

    Indica si el texto ingresado en el campo de texto se debe usar para mejorar las sugerencias de escritura para el usuario.

  • spellCheck

    booleano

    Indica si el campo de texto requiere corrección ortográfica.

  • Tipo de valor que edita este campo de texto (texto, número, URL, etc.)

InputContextType

Chrome 44 y versiones posteriores browser.* desde Chrome 148

Tipo de valor que edita este campo de texto (texto, número, URL, etc.)

Enum

"text"

"search"

"tel"

"url"

"email"

"number"

"password"

"null"

KeyboardEvent

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

Propiedades

  • altKey

    booleano opcional

    Indica si se presionó la tecla ALT.

  • altgrKey

    booleano opcional

    Chrome 79 y versiones posteriores browser.* desde Chrome 148

    Indica si se presionó la tecla ALTGR.

  • capsLock

    booleano opcional

    Indica si CAPS_LOCK está habilitado o no.

  • código

    string

    Es el valor de la tecla física que se presiona. El valor no se ve afectado por el diseño del teclado actual ni por el estado de la tecla modificadora.

  • ctrlKey

    booleano opcional

    Indica si se presionó la tecla CTRL.

  • extensionId

    string opcional

    Es el ID de extensión del remitente de este evento de tecla.

  • clave

    string

    Es el valor de la tecla que se presiona.

  • keyCode

    number opcional

    El keyCode de HTML obsoleto, que es un código numérico que depende del sistema y de la implementación, y que representa el identificador sin modificar asociado con la tecla presionada.

  • requestId

    string opcional

    (Obsoleto) Es el ID de la solicitud. En su lugar, usa el parámetro requestId del evento onKeyEvent.

  • shiftKey

    booleano opcional

    Indica si se presionó la tecla MAYÚSCULAS.

  • Puede ser keyup o keydown.

KeyboardEventType

Chrome 44 y versiones posteriores browser.* desde Chrome 148

Enum

"keyup"

"keydown"

MenuItem

Es un elemento de menú que usa un método de entrada para interactuar con el usuario desde el menú de idioma.

Propiedades

  • elemento marcado

    booleano opcional

    Indica que este elemento se debe dibujar con una marca de verificación.

  • habilitado

    booleano opcional

    Indica que este elemento está habilitado.

  • id

    string

    Es la cadena que se pasará a las devoluciones de llamada que hacen referencia a este MenuItem.

  • etiqueta

    string opcional

    Es el texto que se muestra en el menú para este elemento.

  • estilo

    MenuItemStyle opcional

    Es el tipo de elemento de menú.

  • visible

    booleano opcional

    Indica que este elemento es visible.

MenuItemStyle

Chrome 44 y versiones posteriores browser.* desde Chrome 148

Es el tipo de elemento de menú. Los botones de selección entre separadores se consideran agrupados.

Enum

"check"

"radio"

"separator"

MenuParameters

Chrome 88 y versiones posteriores browser.* desde Chrome 148

Propiedades

  • engineID

    string

    Es el ID del motor que se usará.

  • elementos

    MenuItem[]

    Son los elementos de menú que se agregarán o actualizarán. Se agregarán en el orden en que existen en el array.

MouseButton

Chrome 44 y versiones posteriores browser.* desde Chrome 148

Indica en qué botones del mouse se hizo clic.

Enum

"left"

"middle"

"right"

ScreenType

Chrome 44 y versiones posteriores browser.* desde Chrome 148

Es el tipo de pantalla en el que se activa el IME.

Enum

"normal"

"login"

"lock"

"secondary-login"

UnderlineStyle

Chrome 44 y versiones posteriores browser.* desde Chrome 148

Es el tipo de subrayado para modificar este segmento.

Enum

"underline"

"doubleUnderline"

"noUnderline"

WindowPosition

Chrome 44 y versiones posteriores browser.* desde Chrome 148

Dónde mostrar la ventana de candidatos. Si se establece en "cursor", la ventana sigue al cursor. Si se establece en "composition", la ventana se bloquea al principio de la composición.

Enum

"cursor"

"composition"

Métodos

clearComposition()

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

Borra la composición actual. Si esta extensión no es propietaria del IME activo, se produce un error.

Parámetros

  • Parámetros

    objeto

    • contextID

      número

      Es el ID del contexto en el que se borrará la composición.

Muestra

  • Promise<boolean>

    Chrome 111 y versiones posteriores browser.* desde Chrome 148

    Se resuelve cuando se completa la operación con un valor booleano que indica si se aceptó el texto o no. Si se produce un error, se rechazará la promesa.

commitText()

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

Confirma el texto proporcionado en la entrada actual.

Parámetros

  • Parámetros

    objeto

    • contextID

      número

      Es el ID del contexto en el que se confirmará el texto.

    • texto

      string

      Es el texto que se confirmará.

Muestra

  • Promise<boolean>

    Chrome 111 y versiones posteriores browser.* desde Chrome 148

    Se resuelve cuando se completa la operación con un valor booleano que indica si se aceptó el texto o no. Si se produce un error, se rechazará la promesa.

deleteSurroundingText()

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

Borra el texto que rodea el símbolo de intercalación.

Parámetros

  • Parámetros

    objeto

    • contextID

      número

      Es el ID del contexto en el que se borrará el texto circundante.

    • engineID

      string

      Es el ID del motor que recibe el evento.

    • longitud

      número

      Es la cantidad de caracteres que se borrarán.

    • offset

      número

      Es el desplazamiento desde la posición del signo de intercalación donde comenzará la eliminación. Este valor puede ser negativo.

Muestra

  • Promise<void>

    Chrome 111 y versiones posteriores browser.* desde Chrome 148

    Se resuelve cuando se completa la operación.

hideInputView()

browser.input.ime.hideInputView(): void

Oculta la ventana de vista de entrada, que el sistema muestra automáticamente. Si la ventana de vista de entrada ya está oculta, esta función no hará nada.

keyEventHandled()

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

Indica que se controla el evento de tecla que recibe onKeyEvent. Solo se debe llamar si el objeto de escucha onKeyEvent es asíncrono.

Parámetros

  • requestId

    string

    Es el ID de solicitud del evento que se controló. Debe provenir de keyEvent.requestId

  • respuesta

    booleano

    Verdadero si se controló la pulsación de tecla; falso si no

sendKeyEvents()

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

Envía los eventos clave. Se espera que los teclados virtuales usen esta función. Cuando un usuario presiona una o más teclas en un teclado virtual, se usa esta función para propagar ese evento al sistema.

Parámetros

  • Parámetros

    objeto

    • contextID

      número

      Es el ID del contexto en el que se enviarán los eventos de teclas, o cero para enviar eventos de teclas a un campo que no sea de entrada.

    • keyData

      KeyboardEvent[]

      Son los datos sobre el evento clave.

Muestra

  • Promise<void>

    Chrome 111 y versiones posteriores browser.* desde Chrome 148

    Se resuelve cuando se completa la operación.

setAssistiveWindowButtonHighlighted()

Chrome 86 y versiones posteriores browser.* desde Chrome 148 
browser.input.ime.setAssistiveWindowButtonHighlighted(
  parameters: object,
): Promise<void>

Destaca o quita el destacado de un botón en una ventana de asistencia.

Parámetros

  • Parámetros

    objeto

    • announceString

      string opcional

      Es el texto que anunciará el lector de pantalla.

    • El ID del botón

    • contextID

      número

      Es el ID del contexto que posee la ventana de asistencia.

    • destacado

      booleano

      Indica si se debe destacar el botón.

    • windowType

      "undo"

      Es el tipo de ventana al que pertenece el botón.

Muestra

  • Promise<void>

    Chrome 111 y versiones posteriores browser.* desde Chrome 148

    Se resuelve cuando se completa la operación. Si se produce un error, se rechazará la promesa.

setAssistiveWindowProperties()

Chrome 85 y versiones posteriores browser.* desde Chrome 148 
browser.input.ime.setAssistiveWindowProperties(
  parameters: object,
): Promise<boolean>

Muestra u oculta una ventana de asistencia con las propiedades dadas.

Parámetros

  • Parámetros

    objeto

    • contextID

      número

      Es el ID del contexto que posee la ventana de asistencia.

    • Son las propiedades de la ventana de asistencia.

Muestra

  • Promise<boolean>

    Chrome 111 y versiones posteriores browser.* desde Chrome 148

    Se resuelve cuando se completa la operación.

setCandidates()

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

Establece la lista de candidatos actual. Esto falla si esta extensión no es propietaria del IME activo

Parámetros

  • Parámetros

    objeto

    • candidatos

      object[]

      Lista de candidatos que se mostrarán en la ventana de candidatos

      • anotación

        string opcional

        Texto adicional que describe al candidato

      • candidato

        string

        El candidato

      • id

        número

        El ID del candidato

      • etiqueta

        string opcional

        Es una cadena corta que se muestra junto al candidato, a menudo la tecla de acceso directo o el índice.

      • parentId

        number opcional

        El ID con el que se agregarán estos candidatos

      • uso

        objeto opcional

        Es el uso o la descripción detallada de la palabra.

        • body

          string

          Es la cadena del cuerpo de la descripción detallada.

        • título

          string

          Es la cadena de título de la descripción de los detalles.

    • contextID

      número

      Es el ID del contexto al que pertenece la ventana de candidatos.

Muestra

  • Promise<boolean>

    Chrome 111 y versiones posteriores browser.* desde Chrome 148

    Se resuelve cuando se completa la operación.

setCandidateWindowProperties()

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

Establece las propiedades de la ventana de candidatos. Esto falla si la extensión no es propietaria del IME activo.

Parámetros

  • Parámetros

    objeto

    • engineID

      string

      Es el ID del motor en el que se establecerán las propiedades.

    • propiedades

      objeto

      • auxiliaryText

        string opcional

        Es el texto que se muestra en la parte inferior de la ventana de candidatos.

      • auxiliaryTextVisible

        booleano opcional

        Es verdadero para mostrar el texto auxiliar y falso para ocultarlo.

      • currentCandidateIndex

        number opcional

        Chrome 84 y versiones posteriores browser.* desde Chrome 148

        Es el índice del candidato elegido actualmente entre el total de candidatos.

      • cursorVisible

        booleano opcional

        True para mostrar el cursor y False para ocultarlo.

      • pageSize

        number opcional

        Es la cantidad de candidatos que se mostrarán por página.

      • totalCandidates

        number opcional

        Chrome 84 y versiones posteriores browser.* desde Chrome 148

        Es la cantidad total de candidatos para la ventana de candidatos.

      • vertical

        booleano opcional

        Es verdadero si la ventana de candidatos se debe renderizar de forma vertical, o falso para que sea horizontal.

      • visible

        booleano opcional

        Es verdadero para mostrar la ventana de candidatos y falso para ocultarla.

      • windowPosition

        WindowPosition opcional

        Dónde mostrar la ventana de candidatos.

Muestra

  • Promise<boolean>

    Chrome 111 y versiones posteriores browser.* desde Chrome 148

    Se resuelve cuando se completa la operación.

setComposition()

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

Establece la composición actual. Si esta extensión no es propietaria del IME activo, se produce un error.

Parámetros

  • Parámetros

    objeto

    • contextID

      número

      Es el ID del contexto en el que se establecerá el texto de composición.

    • cursor

      número

      Es la posición del cursor en el texto.

    • segmentos similares

      object[] opcional

      Es la lista de segmentos y sus tipos asociados.

      • end

        número

        Es el índice del carácter después del cual finaliza este segmento.

      • start

        número

        Índice del carácter en el que se inicia este segmento

      • Es el tipo de subrayado para modificar este segmento.

    • selectionEnd

      number opcional

      Es la posición en el texto en la que finaliza la selección.

    • selectionStart

      number opcional

      Es la posición en el texto en la que comienza la selección.

    • texto

      string

      Texto que se establecerá

Muestra

  • Promise<boolean>

    Chrome 111 y versiones posteriores browser.* desde Chrome 148

    Se resuelve cuando se completa la operación con un valor booleano que indica si se aceptó el texto o no. Si se produce un error, se rechazará la promesa.

setCursorPosition()

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

Establece la posición del cursor en la ventana de candidatos. Esta es una operación no-op si esta extensión no posee el IME activo.

Parámetros

  • Parámetros

    objeto

    • candidateID

      número

      Es el ID del candidato que se seleccionará.

    • contextID

      número

      Es el ID del contexto al que pertenece la ventana de candidatos.

Muestra

  • Promise<boolean>

    Chrome 111 y versiones posteriores browser.* desde Chrome 148

    Se resuelve cuando se completa la operación

setMenuItems()

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

Agrega los elementos de menú proporcionados al menú de idioma cuando este IME está activo.

Parámetros

Muestra

  • Promise<void>

    Chrome 111 y versiones posteriores browser.* desde Chrome 148

updateMenuItems()

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

Actualiza el estado de los MenuItems especificados.

Parámetros

Muestra

  • Promise<void>

    Chrome 111 y versiones posteriores browser.* desde Chrome 148

    Se resuelve cuando se completa la operación

Eventos

onActivate

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

Este evento se envía cuando se activa un IME. Indica que el IME recibirá eventos onKeyPress.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

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

onAssistiveWindowButtonClicked

Chrome 85 y versiones posteriores browser.* desde Chrome 148 
browser.input.ime.onAssistiveWindowButtonClicked.addListener(
  callback: function,
)

Este evento se envía cuando se hace clic en un botón de una ventana de asistencia.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (details: object) => void

onBlur

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

Este evento se envía cuando el enfoque sale de un cuadro de texto. Se envía a todas las extensiones que escuchan este evento y que el usuario habilitó.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (contextID: number) => void

    • contextID

      número

onCandidateClicked

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

Este evento se envía si esta extensión es propietaria del IME activo.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

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

    • engineID

      string

    • candidateID

      número

    • botón

      MouseButton

onDeactivated

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

Este evento se envía cuando se desactiva un IME. Indica que el IME ya no recibirá eventos onKeyPress.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (engineID: string) => void

    • engineID

      string

onFocus

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

Este evento se envía cuando el enfoque ingresa a un cuadro de texto. Se envía a todas las extensiones que escuchan este evento y que el usuario habilitó.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (context: InputContext) => void

onInputContextUpdate

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

Este evento se envía cuando cambian las propiedades del InputContext actual, como el tipo. Se envía a todas las extensiones que escuchan este evento y que el usuario habilitó.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (context: InputContext) => void

onKeyEvent

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

Se activa cuando se envía un evento de tecla desde el sistema operativo. El evento se enviará a la extensión si esta es propietaria del IME activo. La función de objeto de escucha debe devolver true si se controló el evento, o false si no se controló. Si el evento se evaluará de forma asíncrona, esta función debe mostrar un valor indefinido y, luego, el IME debe llamar a keyEventHandled() con el resultado.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

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

    • muestra

      boolean | undefined

onMenuItemActivated

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

Se llama cuando el usuario selecciona un elemento de menú.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

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

    • engineID

      string

    • nombre

      string

onReset

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

Este evento se envía cuando Chrome finaliza la sesión de entrada de texto en curso.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (engineID: string) => void

    • engineID

      string

onSurroundingTextChanged

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

Se llama cuando se cambia la cadena editable alrededor del signo de intercalación o cuando se mueve la posición del signo de intercalación. La longitud del texto se limita a 100 caracteres para cada dirección de ida y vuelta.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

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

    • engineID

      string

    • surroundingInfo

      objeto

      • ancla

        número

        Es la posición inicial de la selección. Este valor indica la posición del signo de intercalación si no hay selección.

      • enfoque

        número

        Es la posición final de la selección. Este valor indica la posición del signo de intercalación si no hay selección.

      • offset

        número

        Chrome 46 y versiones posteriores browser.* desde Chrome 148

        Es la posición de desplazamiento de text. Dado que text solo incluye un subconjunto de texto alrededor del cursor, el desplazamiento indica la posición absoluta del primer carácter de text.

      • texto

        string

        Es el texto que rodea al cursor. Este es solo un subconjunto de todo el texto del campo de entrada.