@react-native-ohos/react-native-custom-keyboard 1.0.4-rc.1

package/harmony/custom_keyboard/src/main/cpp/generated/custom_keyboard/RNOH/generated/BaseReactNativeOhTplReactNativeCustomKeyboardPackage.h

@@ -0,0 +1,75 @@
+/**
+ * This code was generated by "react-native codegen-harmony"
+ * 
+ * Do not edit this file as changes may cause incorrect behavior and will be
+ * lost once the code is regenerated.
+ */
+
+#pragma once
+
+#include "RNOH/Package.h"
+#include "RNOH/ArkTSTurboModule.h"
+#include "RNOH/generated/turbo_modules/CustomKeyboardNativeModule.h"
+
+namespace rnoh {
+
+class BaseReactNativeOhosReactNativeCustomKeyboardPackageTurboModuleFactoryDelegate : public TurboModuleFactoryDelegate {
+  public:
+    SharedTurboModule createTurboModule(Context ctx, const std::string &name) const override {
+        if (name == "CustomKeyboardNativeModule") {
+            return std::make_shared<CustomKeyboardNativeModule>(ctx, name);
+        }
+        return nullptr;
+    };
+};
+
+class BaseReactNativeOhosReactNativeCustomKeyboardPackageEventEmitRequestHandler : public EventEmitRequestHandler {
+  public:
+    void handleEvent(Context const &ctx) override {
+        auto eventEmitter = ctx.shadowViewRegistry->getEventEmitter<facebook::react::EventEmitter>(ctx.tag);
+        auto componentName = ctx.shadowViewRegistry->getComponentName(ctx.tag);
+
+        if (eventEmitter == nullptr) {
+            return;
+        }
+
+        std::vector<std::string> supportedComponentNames = {
+        };
+
+        std::vector<std::string> supportedEventNames = {
+        };
+
+        if (std::find(supportedComponentNames.begin(), supportedComponentNames.end(), componentName) != supportedComponentNames.end() &&
+            std::find(supportedEventNames.begin(), supportedEventNames.end(), ctx.eventName) != supportedEventNames.end()) {
+            eventEmitter->dispatchEvent(ctx.eventName, ArkJS(ctx.env).getDynamic(ctx.payload));
+        }    
+    }
+};
+
+
+class BaseReactNativeOhosReactNativeCustomKeyboardPackage : public Package {
+  public:
+    BaseReactNativeOhosReactNativeCustomKeyboardPackage(Package::Context ctx) : Package(ctx){};
+
+    std::unique_ptr<TurboModuleFactoryDelegate> createTurboModuleFactoryDelegate() override {
+        return std::make_unique<BaseReactNativeOhosReactNativeCustomKeyboardPackageTurboModuleFactoryDelegate>();
+    }
+
+    std::vector<facebook::react::ComponentDescriptorProvider> createComponentDescriptorProviders() override {
+        return {
+        };
+    }
+
+    ComponentJSIBinderByString createComponentJSIBinderByName() override {
+        return {
+        };
+    };
+
+    EventEmitRequestHandlers createEventEmitRequestHandlers() override {
+        return {
+            std::make_shared<BaseReactNativeOhosReactNativeCustomKeyboardPackageEventEmitRequestHandler>(),
+        };
+    }
+};
+
+} // namespace rnoh

package/harmony/custom_keyboard/src/main/cpp/generated/custom_keyboard/RNOH/generated/turbo_modules/CustomKeyboardNativeModule.cpp

@@ -0,0 +1,28 @@
+/**
+ * This code was generated by "react-native codegen-harmony"
+ * 
+ * Do not edit this file as changes may cause incorrect behavior and will be
+ * lost once the code is regenerated.
+ * 
+ * @generatorVersion: 2
+ */
+
+#include "CustomKeyboardNativeModule.h"
+
+namespace rnoh {
+using namespace facebook;
+
+CustomKeyboardNativeModule::CustomKeyboardNativeModule(const ArkTSTurboModule::Context ctx, const std::string name) : ArkTSTurboModule(ctx, name) {
+    methodMap_ = {
+        ARK_METHOD_METADATA(install, 2),
+        ARK_METHOD_METADATA(uninstall, 1),
+        ARK_METHOD_METADATA(insertText, 2),
+        ARK_METHOD_METADATA(backSpace, 1),
+        ARK_METHOD_METADATA(doDelete, 1),
+        ARK_METHOD_METADATA(moveLeft, 1),
+        ARK_METHOD_METADATA(moveRight, 1),
+        ARK_METHOD_METADATA(switchSystemKeyboard, 1),
+    };
+}
+
+} // namespace rnoh

package/harmony/custom_keyboard/src/main/cpp/generated/custom_keyboard/RNOH/generated/turbo_modules/CustomKeyboardNativeModule.h

@@ -0,0 +1,21 @@
+/**
+ * This code was generated by "react-native codegen-harmony"
+ * 
+ * Do not edit this file as changes may cause incorrect behavior and will be
+ * lost once the code is regenerated.
+ * 
+ * @generatorVersion: 2
+ */
+
+#pragma once
+
+#include "RNOH/ArkTSTurboModule.h"
+
+namespace rnoh {
+
+class JSI_EXPORT CustomKeyboardNativeModule : public ArkTSTurboModule {
+  public:
+    CustomKeyboardNativeModule(const ArkTSTurboModule::Context ctx, const std::string name);
+};
+
+} // namespace rnoh

package/harmony/custom_keyboard/src/main/cpp/generated/custom_keyboard/react/renderer/components/custom_keyboard/ComponentDescriptors.h

@@ -0,0 +1,24 @@
+
+/**
+ * This code was generated by [react-native-codegen](https://www.npmjs.com/package/react-native-codegen).
+ *
+ * Do not edit this file as changes may cause incorrect behavior and will be lost
+ * once the code is regenerated.
+ *
+ * @generated by codegen project: GenerateComponentDescriptorH.js
+ */
+
+#pragma once
+
+#include "ShadowNodes.h"
+#include <react/renderer/core/ConcreteComponentDescriptor.h>
+#include <react/renderer/componentregistry/ComponentDescriptorProviderRegistry.h>
+
+namespace facebook::react {
+
+
+
+void _react_native_ohos_react_native_custom_keyboard_registerComponentDescriptorsFromCodegen(
+  std::shared_ptr<const ComponentDescriptorProviderRegistry> registry);
+
+} // namespace facebook::react

package/harmony/custom_keyboard/src/main/cpp/generated/custom_keyboard/react/renderer/components/custom_keyboard/EventEmitters.cpp

@@ -0,0 +1,16 @@
+
+/**
+ * This code was generated by [react-native-codegen](https://www.npmjs.com/package/react-native-codegen).
+ *
+ * Do not edit this file as changes may cause incorrect behavior and will be lost
+ * once the code is regenerated.
+ *
+ * @generated by codegen project: GenerateEventEmitterCpp.js
+ */
+
+#include "EventEmitters.h"
+
+
+namespace facebook::react {
+
+} // namespace facebook::react

package/harmony/custom_keyboard/src/main/cpp/generated/custom_keyboard/react/renderer/components/custom_keyboard/EventEmitters.h

@@ -0,0 +1,17 @@
+
+/**
+ * This code was generated by [react-native-codegen](https://www.npmjs.com/package/react-native-codegen).
+ *
+ * Do not edit this file as changes may cause incorrect behavior and will be lost
+ * once the code is regenerated.
+ *
+ * @generated by codegen project: GenerateEventEmitterH.js
+ */
+#pragma once
+
+#include <react/renderer/components/view/ViewEventEmitter.h>
+
+
+namespace facebook::react {
+
+} // namespace facebook::react

package/harmony/custom_keyboard/src/main/cpp/generated/custom_keyboard/react/renderer/components/custom_keyboard/Props.cpp

@@ -0,0 +1,19 @@
+
+/**
+ * This code was generated by [react-native-codegen](https://www.npmjs.com/package/react-native-codegen).
+ *
+ * Do not edit this file as changes may cause incorrect behavior and will be lost
+ * once the code is regenerated.
+ *
+ * @generated by codegen project: GeneratePropsCpp.js
+ */
+
+#include "Props.h"
+#include <react/renderer/core/PropsParserContext.h>
+#include <react/renderer/core/propsConversions.h>
+
+namespace facebook::react {
+
+
+
+} // namespace facebook::react

package/harmony/custom_keyboard/src/main/cpp/generated/custom_keyboard/react/renderer/components/custom_keyboard/Props.h

@@ -0,0 +1,18 @@
+
+/**
+ * This code was generated by [react-native-codegen](https://www.npmjs.com/package/react-native-codegen).
+ *
+ * Do not edit this file as changes may cause incorrect behavior and will be lost
+ * once the code is regenerated.
+ *
+ * @generated by codegen project: GeneratePropsH.js
+ */
+#pragma once
+
+
+
+namespace facebook::react {
+
+
+
+} // namespace facebook::react

package/harmony/custom_keyboard/src/main/cpp/generated/custom_keyboard/react/renderer/components/custom_keyboard/ShadowNodes.cpp

@@ -0,0 +1,17 @@
+
+/**
+ * This code was generated by [react-native-codegen](https://www.npmjs.com/package/react-native-codegen).
+ *
+ * Do not edit this file as changes may cause incorrect behavior and will be lost
+ * once the code is regenerated.
+ *
+ * @generated by codegen project: GenerateShadowNodeCpp.js
+ */
+
+#include "ShadowNodes.h"
+
+namespace facebook::react {
+
+
+
+} // namespace facebook::react

package/harmony/custom_keyboard/src/main/cpp/generated/custom_keyboard/react/renderer/components/custom_keyboard/ShadowNodes.h

@@ -0,0 +1,23 @@
+
+/**
+ * This code was generated by [react-native-codegen](https://www.npmjs.com/package/react-native-codegen).
+ *
+ * Do not edit this file as changes may cause incorrect behavior and will be lost
+ * once the code is regenerated.
+ *
+ * @generated by codegen project: GenerateShadowNodeH.js
+ */
+
+#pragma once
+
+#include "EventEmitters.h"
+#include "Props.h"
+#include "States.h"
+#include <react/renderer/components/view/ConcreteViewShadowNode.h>
+#include <jsi/jsi.h>
+
+namespace facebook::react {
+
+
+
+} // namespace facebook::react

package/harmony/custom_keyboard/src/main/cpp/generated/custom_keyboard/react/renderer/components/custom_keyboard/States.cpp

@@ -0,0 +1,16 @@
+
+/**
+ * This code was generated by [react-native-codegen](https://www.npmjs.com/package/react-native-codegen).
+ *
+ * Do not edit this file as changes may cause incorrect behavior and will be lost
+ * once the code is regenerated.
+ *
+ * @generated by codegen project: GenerateStateCpp.js
+ */
+#include "States.h"
+
+namespace facebook::react {
+
+
+
+} // namespace facebook::react

package/harmony/custom_keyboard/src/main/cpp/generated/custom_keyboard/react/renderer/components/custom_keyboard/States.h

@@ -0,0 +1,19 @@
+/**
+ * This code was generated by [react-native-codegen](https://www.npmjs.com/package/react-native-codegen).
+ *
+ * Do not edit this file as changes may cause incorrect behavior and will be lost
+ * once the code is regenerated.
+ *
+ * @generated by codegen project: GenerateStateH.js
+ */
+#pragma once
+
+#ifdef ANDROID
+#include <folly/dynamic.h>
+#endif
+
+namespace facebook::react {
+
+
+
+} // namespace facebook::react

package/harmony/custom_keyboard/src/main/ets/Logger.ts

@@ -0,0 +1,64 @@
+/**
+ * MIT License
+ *
+ * Copyright (C) 2024 Huawei Device Co., Ltd.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import hilog from '@ohos.hilog';
+
+class Logger {
+  private domain: number;
+  private prefix: string;
+  private format: string = '%{public}s, %{public}s';
+  private isDebug: boolean;
+
+  /**
+   * constructor.
+   *
+   * @param Prefix Identifies the log tag.
+   * @param domain Domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFFF.
+   */
+  constructor(prefix: string = 'RNCustomKeyboardTurboModule', domain: number = 0xFF00, isDebug = true) {
+    this.prefix = prefix;
+    this.domain = domain;
+    this.isDebug = isDebug;
+  }
+
+  debug(...args: string[]): void {
+    if (this.isDebug) {
+      hilog.debug(this.domain, this.prefix, this.format, args);
+    }
+  }
+
+  info(...args: string[]): void {
+    hilog.info(this.domain, this.prefix, this.format, args);
+  }
+
+  warn(...args: string[]): void {
+    hilog.warn(this.domain, this.prefix, this.format, args);
+  }
+
+  error(...args: string[]): void {
+    hilog.error(this.domain, this.prefix, this.format, args);
+  }
+}
+
+export default new Logger('RNCustomKeyboardTurboModule', 0xFF00, true)

package/harmony/custom_keyboard/src/main/ets/RNCustomKeyboardPackage.ts

@@ -0,0 +1,47 @@
+/**
+ * MIT License
+ *
+ * Copyright (C) 2024 Huawei Device Co., Ltd.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import { RNPackage, TurboModulesFactory } from '@rnoh/react-native-openharmony/ts';
+import type { TurboModule, TurboModuleContext } from '@rnoh/react-native-openharmony/ts';
+import { TM } from './generated/ts'
+import { RNCustomKeyboardTurboModule } from './RNCustomKeyboardTurboModule';
+
+class RNCustomKeyboardTurboModuleFactory extends TurboModulesFactory {
+  createTurboModule(name: string): TurboModule | null {
+    if (this.hasTurboModule(name)) {
+      return new RNCustomKeyboardTurboModule(this.ctx);
+    }
+    return null;
+  }
+
+  hasTurboModule(name: string): boolean {
+    return name === TM.CustomKeyboardNativeModule.NAME;
+  }
+}
+
+export class RNCustomKeyboardPackage extends RNPackage {
+  createTurboModulesFactory(ctx: TurboModuleContext): TurboModulesFactory {
+    return new RNCustomKeyboardTurboModuleFactory(ctx);
+  }
+}

package/harmony/custom_keyboard/src/main/ets/RNCustomKeyboardTurboModule.ts

@@ -0,0 +1,64 @@
+/**
+ * MIT License
+ *
+ * Copyright (C) 2024 Huawei Device Co., Ltd.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import { TurboModule } from '@rnoh/react-native-openharmony/ts';
+import { TM } from './generated/ts';
+
+export class RNCustomKeyboardTurboModule extends TurboModule implements TM.CustomKeyboardNativeModule.Spec {
+  constructor(ctx) {
+    super(ctx);
+  }
+  install(tag: number, type: string)
+  {
+  console.log("install");
+  }
+  uninstall(tag: number)
+  {
+  console.log("uninstall");
+  }
+  insertText(tag: number, text: string | number)
+  {
+  console.log("insertText");
+  }
+  backSpace(tag: number)
+  {
+  console.log("backSpace");
+  }
+  doDelete(tag: number)
+  {
+  console.log("doDelete");
+  }
+  moveLeft(tag: number)
+  {
+  console.log("moveLeft");
+  }
+  moveRight(tag: number)
+  {
+  console.log("moveRight");
+  }
+  switchSystemKeyboard(tag: number)
+  {
+  console.log("switchSystemKeyboard");
+  }
+}

package/harmony/custom_keyboard/src/main/ets/generated/components/ts.ts

@@ -0,0 +1,5 @@
+
+/**
+ */
+
+export {}

package/harmony/custom_keyboard/src/main/ets/generated/index.ets

@@ -0,0 +1,8 @@
+/**
+ * This code was generated by "react-native codegen-harmony"
+ * 
+ * Do not edit this file as changes may cause incorrect behavior and will be
+ * lost once the code is regenerated.
+ */
+
+export * from "./ts"

package/harmony/custom_keyboard/src/main/ets/generated/ts.ts

@@ -0,0 +1,9 @@
+/**
+ * This code was generated by "react-native codegen-harmony"
+ * 
+ * Do not edit this file as changes may cause incorrect behavior and will be
+ * lost once the code is regenerated.
+ */
+
+export * as RNC from "./components/ts"
+export * as TM from "./turboModules/ts"

package/harmony/custom_keyboard/src/main/ets/generated/turboModules/CustomKeyboardNativeModule.ts

@@ -0,0 +1,32 @@
+/**
+ * This code was generated by "react-native codegen-harmony"
+ * 
+ * Do not edit this file as changes may cause incorrect behavior and will be
+ * lost once the code is regenerated.
+ * 
+ * @generatorVersion: 2
+ */
+
+
+export namespace CustomKeyboardNativeModule {
+  export const NAME = 'CustomKeyboardNativeModule' as const
+
+  export interface Spec {
+    install(tag: number, type: string): void;
+  
+    uninstall(tag: number): void;
+  
+    insertText(tag: number, text: string): void;
+  
+    backSpace(tag: number): void;
+  
+    doDelete(tag: number): void;
+  
+    moveLeft(tag: number): void;
+  
+    moveRight(tag: number): void;
+  
+    switchSystemKeyboard(tag: number): void;
+  
+  }
+}

package/harmony/custom_keyboard/src/main/ets/generated/turboModules/ts.ts

@@ -0,0 +1,8 @@
+/**
+ * This code was generated by "react-native codegen-harmony"
+ * 
+ * Do not edit this file as changes may cause incorrect behavior and will be
+ * lost once the code is regenerated.
+ */
+
+export * from "./CustomKeyboardNativeModule"

package/harmony/custom_keyboard/src/main/module.json5

@@ -0,0 +1,11 @@
+{
+  "module": {
+    "name": "custom_keyboard",
+    "type": "har",
+    "deviceTypes": [
+      "phone",
+      "tablet",
+      "2in1"
+    ],
+  }
+}

package/harmony/custom_keyboard/ts.ts

@@ -0,0 +1,8 @@
+/*
+ * Copyright (c) 2025 Huawei Device Co., Ltd. All rights reserved
+ * Use of this source code is governed by a MIT license that can be
+ * found in the LICENSE file.
+ */
+
+export * from './src/main/ets/RNCustomKeyboardPackage';
+export * from "./src/main/ets/RNCustomKeyboardTurboModule";

package/index.d.ts

@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) 2025 Huawei Device Co., Ltd. All rights reserved
+ * Use of this source code is governed by a MIT license that can be
+ * found in the LICENSE file.
+ */
+
+declare namespace RNCustomKeyboard {
+    function install: (tag: number, type: string) => void;
+    function uninstall: (tag: number) => void;
+    function insertText: (tag: number, text: string) => void;
+    function backSpace: (tag: number) => void;
+    function doDelete: (tag: number) => void;
+    function moveLeft: (tag: number) => void;
+    function moveRight: (tag: number) => void;
+    function switchSystemKeyboard: (tag: number) => void;
+}
+export = RNCustomKeyboard;

package/index.js

@@ -0,0 +1,66 @@
+
+'use strict'
+import React, { Component } from 'react';
+import { PropTypes } from 'prop-types';
+import CustomKeyboardManager from './src/specs/v2/NativeCustomKeyboard';
+import {
+    TextInput,
+    findNodeHandle,
+    AppRegistry, } from 'react-native';
+
+const {
+    install, uninstall,
+    insertText, backSpace, doDelete,
+    moveLeft, moveRight,
+    switchSystemKeyboard,
+} = CustomKeyboardManager;
+
+export {
+    install, uninstall,
+    insertText, backSpace, doDelete,
+    moveLeft, moveRight,
+    switchSystemKeyboard,
+};
+
+const keyboardTypeRegistry = {};
+
+export function register(type, factory) {
+    keyboardTypeRegistry[type] = factory;
+}
+
+class CustomKeyboardContainer extends Component {
+    render() {
+        const { tag, type } = this.props;
+        const factory = keyboardTypeRegistry[type];
+        if (!factory) {
+            console.warn(`Custom keyboard type ${type} not registered.`);
+            return null;
+        }
+        const Comp = factory();
+        return <Comp tag={tag} />;
+    }
+}
+
+AppRegistry.registerComponent("CustomKeyboard", () => CustomKeyboardContainer);
+
+export class CustomTextInput extends Component {
+    static propTypes = {
+        ...TextInput.propTypes,
+        customKeyboardType: PropTypes.string,
+    };
+    handleLayout = () => {
+        install(findNodeHandle(this.input), this.props.customKeyboardType);
+    };
+    componentDidUpdate(newProps) {
+        if (newProps.customKeyboardType !== this.props.customKeyboardType) {
+            install(findNodeHandle(this.input), newProps.customKeyboardType);
+        }
+    }
+    onRef = ref => {
+        this.input = ref;
+    };
+    render() {
+        const { customKeyboardType, ...others } = this.props;
+        return <TextInput {...others} ref={this.onRef} onLayout={this.handleLayout}/>;
+    }
+}