目录

ArkUI_NativeModule

Overview

Provides the APIs for accessing and managing page interaction of ArkUI on the native side. It is applicable to scenarios where the NDK is used to build UIs, process input events, bind gestures, execute animations, and manage node trees.

Provides the basic input event APIs of ArkUI on the native side. For details, see Binding Basic Input Events.

Provides drag and drop APIs of ArkUI on the native side. For details, see Drag Event.

Provides the general key event APIs of ArkUI on the native side. For details, see Binding Basic Input Events.

Provides ArkUI APIs for registering gesture callbacks on the native side. For details, see Binding Gesture Events.

Provides ArkUI animation callbacks for native-side implementations. For details, see Animation Overview.

Provides the UI APIs of ArkUI on the native side, such as UI component creation and destruction, tree node operations, attribute setting, and event listening. For details, see Integrating with ArkTS Pages.

The preceding APIs are applicable to scenarios where ArkTS pages are integrated on the native side and input events, drag operations, gestures, animations, and UI nodes are processed and managed. They help you implement ArkUI page interaction and component tree management in native modules.

Since: 12

Files

Name Description
common_attributes.h Defines the types of common attributes and events of NativeModule.
embedded_component.h Defines the structs and APIs of the EmbeddedComponent component.
image.h Defines Image node types for NativeNode APIs.
image_animator.h Defines ImageAnimator node types for NativeNode APIs.
layout.h Defines layout-related enumerations and APIs.
custom_attributes.h Defines measurement, layout, and drawing event types for custom components in NativeNode APIs. These types are used to register and handle measurement, layout, and drawing events for the content layer, foreground layer, and floating layer.
grid.h Defines the enumerations and APIs related to the Grid component.
list.h Defines the enumerations and APIs related to the List component.
navigation_router.h Defines the enumerations and APIs related to the Navigation or Router component.
scroll.h Defines the enumerations related to the Scroll component.
swiper.h Defines the enumerations and APIs related to the Swiper component.
water_flow.h Defines the enumerations and APIs related to the WaterFlow component.
drag_and_drop.h Declares the APIs of NativeDrag.
drawable_descriptor.h Declares the APIs of NativeDrawableDescriptor.
native_animate.h Declares a set of animation APIs of ArkUI on the native side.
native_dialog.h Declares a set of custom dialog box APIs of ArkUI on the native side.
native_gesture.h Declares the APIs of NativeGesture.
native_interface.h Declares a unified entry for the NativeModule APIs.
native_interface_focus.h Declares the APIs for focus management, mainly used for actively transferring focus, controlling the default focus transfer behavior, and controlling the focus activation state.
native_key_event.h Declares the APIs of NativeKeyEvent.
native_material.h Provides immersive material types and API declarations for ArkUI on the native side.
native_node.h Declares the APIs of NativeNode.
native_node_napi.h Declares the APIs used to convert FrameNodes on the ArkTS side into ArkUI_NodeHandle.
native_type.h Defines the common types for NativeModule.
native_type_visual.h Defines the visual types for NativeModule.
text.h Defines the enumerations and APIs related to text, which are used to configure text styles, control the marquee effect, implement text entity recognition, and manage text controllers. It is applicable to scenarios where you need to customize the text display effect, implement dynamic text interaction, recognize special entities (such as addresses and phone numbers) in text, and precisely control the font weight of text. Through these configuration APIs, you can flexibly control the display effect and interaction behavior of text components, improving user experience.
text_common.h Defines common enumerations and APIs for text components, covering capabilities such as text alignment, decoration line styling, copy and paste, overflow handling, line break policy configuration, and menu customization. It is applicable to scenarios such as text input boxes and text display, helping you flexibly control text styles and interaction behaviors and simplifying development.
text_input.h Defines the enumerations related to TextInput. It supports multiple input types (including the text, number, password, email address, and phone number), custom styles for the clear button, settings for autofilling content types, and selection of input box styles. It is suitable for scenarios that require user interaction, such as login and registration, form filling, and search input. It helps you quickly implement single-line text input features that meet service requirements.
text_area.h Defines the enumerations related to TextArea. The TextArea component is used to receive multi-line text input. The enumerated values are used to specify different input types, which affect the validation rules of the input content. For example, the input types can be basic input, digits only, phone number, email address, and verification code. You can select an appropriate enumerated value based on the form type. The system will automatically provide the corresponding content validation, optimizing user input experience and ensuring the correctness of the data format.
image_span.h Defines the enumerations related to ImageSpan, which is used to embed images in rich text and control the alignment mode between images and text. It supports multiple alignment modes and is applicable to mixed arrangement of images and text. This allows for precise alignment between images and text, enhancing the display effect of rich text.
progress.h Defines the enumerations and APIs related to Progress. It supports multiple types of progress bars, such as linear, ring, circular, and capsule. It also allows for customization of linear progress bar styles (smooth animation, scan effect, width, and corner radius). This is applicable to scenarios where task progress and loading status need to be displayed, helping you quickly implement diverse progress display and interactive feedback.
rich_editor.h Defines enumerations and APIs related to RichEditor.
custom_span.h Defines the structs and APIs related to CustomSpan to implement precise size measurement, layout, and drawing effect of custom spans. It allows you to implement features such as mixed arrangement of images and texts, emoticon embedding, and custom tags in scenarios such as rich text editors, chat applications, and document applications. It provides flexible custom span drawing capabilities, helping you improve development efficiency and achieve richer text layout effects.
picker.h Defines Picker node types for NativeNode APIs.
button.h Defines Button node types for NativeNode APIs.
checkbox.h Defines Checkbox node types for NativeNode APIs.
slider.h Defines Slider node types for NativeNode APIs.
styled_string.h Declares styled string APIs of ArkUI on the native side.
xcomponent.h Defines the enumerations of the XComponent component.
error_code.h Enumerates error codes of ArkUI native APIs.