Input Method Subtype Development

The input method subtype allows the input method to switch to a specific mode or language, for example, the Chinese or English keyboard.

Configuring and Implementing an Input Method Subtype

1. Implement an InputMethodExtensionAbility instance for an input method, which will be shared by all subtypes of the input method. Add metadata to the module.json5 file, setting it name to ohos_extension.input_method and resource to the resource file applicable to all subtypes of the input method.

   {
     "module": {
       // ...
       "extensionAbilities": [
         {
           "description": "InputMethodExtDemo",
           "icon": "$media:icon",
           "name": "InputMethodExtAbility",
           "srcEntry": "./ets/InputMethodExtensionAbility/InputMethodService.ts",
           "type": "inputMethod",
           "exported": true,
           "metadata": [
             {
               "name": "ohos.extension.input_method",
               "resource": "$profile:input_method_config"
             }
           ]
         }
       ]
     }
   }
   

2. Configure the subtype fields. For details about the fields, see inputmethodsubtype. Make sure your configuration is in strict compliance with the configuration file and fields specifications. For details about how to configure the locale field, see Language Tags (BCP 47).

   {
     "subtypes": [
       {
         "icon": "$media:icon",
         "id": "InputMethodExtAbility",
         "label": "$string:english",
         "locale": "en-US",
         "mode": "lower"
       },
       {
         "icon": "$media:icon",
         "id": "InputMethodExtAbility1",
         "label": "$string:chinese",
         "locale": "zh-CN",
         "mode": "lower"
       }
     ]
   }
   

3. Register a listener in the input method application for subtype changes, so as to load a subtype-specific soft keyboard UI. You can also use a state variable to change the soft keyboard layout.

   import { InputMethodSubtype, inputMethodEngine } from '@kit.IMEKit';
   
   let inputMethodAbility: inputMethodEngine.InputMethodAbility = inputMethodEngine.getInputMethodAbility();
   inputMethodAbility.on('setSubtype', (inputMethodSubtype: InputMethodSubtype) => {
     this.subType = inputMethodSubtype; // Save the current input method subtype. You can also change the state variable value here, based on which different layouts are displayed.
     if (inputMethodSubtype.id == 'InputMethodExtAbility') {// Different soft keyboard UIs are loaded according to the subtype.
       this.panel.setUiContent('pages/Index'); 
     }
     if (inputMethodSubtype.id == 'InputMethodExtAbility1') { // Different soft keyboard UIs are loaded according to the subtype.
       this.panel.setUiContent('pages/Index1');
     }
   });
   

Obtaining Information About Input Method Subtypes

1. To obtain the current subtype of the current input method, call getCurrentInputMethodSubtype.

2. To obtain all subtypes of the current input method, call listCurrentInputMethodSubtype.

3. To obtain all subtypes of a specified input method, call listInputMethodSubtype.

Switching Between Input Method Subtypes

1. To switch to another subtype of the current input method, call switchCurrentInputMethodSubtype.

2. To switch to a specified subtype of a specified input method, call switchCurrentInputMethodAndSubtype.