ArkUI

• ArkTS API
  • UI
    • @ohos.animator (Animator)
    • @ohos.arkui.componentSnapshot (Component Snapshot)
    • @ohos.arkui.componentUtils (componentUtils)
    • @ohos.arkui.dragController (DragController)
    • @ohos.arkui.drawableDescriptor (DrawableDescriptor)
    • @ohos.arkui.inspector (Layout Callback)
    • @ohos.arkui.node (Custom Node)
    • @ohos.arkui.observer (Observer)
    • @ohos.arkui.prefetcher (Prefetching)
    • @ohos.arkui.shape(Shape)
    • @ohos.arkui.theme (Theme)
    • @ohos.arkui.UIContext (UIContext)
      • Module Description
      • Class (ComponentSnapshot)
      • Class (ComponentUtils)
      • Class (ContextMenuController)
      • Class (CursorController)
      • Class (DragController)
      • Class (DynamicSyncScene)
      • Class (FocusController)
      • Class (Font)
      • Class (FrameCallback)
      • Class (Magnifier)
      • Class (MarqueeDynamicSyncScene)
      • Class (MeasureUtils)
      • Class (MediaQuery)
      • Class (OverlayManager)
      • Class (PromptAction)
      • Class (Router)
      • Class (SwiperDynamicSyncScene)
      • Class (TextMenuController)
      • Class (UIContext)
      • Class (ResolvedUIContext)
      • Class (UIInspector)
      • Class (UIObserver)
      • Interface (AtomicServiceBar)
      • Interfaces (Others)
      • Enums
      • Types
    • @ohos.arkui.uiExtension (uiExtension)
    • @ohos.arkui.StateManagement (State Management)
    • @ohos.curves (Interpolation Calculation)
    • @ohos.font (Custom Font Registration)
    • @ohos.matrix4 (Matrix Transformation)
    • @ohos.measure (Text Measurement)
    • @ohos.mediaquery (Media Query)
    • @ohos.pluginComponent (PluginComponentManager)
    • @ohos.promptAction (Prompt)
    • @ohos.router (Page Routing) (Not Recommended)
    • @ohos.uiAppearance (UI Appearance)
    • getContext
    • postCardAction
    • @ohos.arkui.drawableDescriptor (DrawableDescriptor) (System API)
    • @ohos.arkui.performanceMonitor (Performance Monitoring) (System API)
    • @ohos.arkui.uiExtension (uiExtension) (System API)
    • @ohos.deviceStatus.dragInteraction (Drag Interaction) (System API)
    • @ohos.pluginComponent (PluginComponentManager) (System API)
    • @ohos.uiAppearance (UI Appearance) (System API)
    • @ohos.uiExtensionHost (System API)
    • @ohos.arkui.UIContext (UIContext) (System API)
    • @ohos.promptAction (Prompt) (System API)
    • @ohos.arkui.uiMaterial (System Material) (System API)
    • ArkUI
      • BuilderNode
      • ComponentContent
      • FrameNode
      • Graphics
      • NodeController
      • RenderNode
      • AttributeUpdater
      • Content
      • NodeContent
      • Resource
  • Window Manager
    • @ohos.PiPWindow (PiP Window)
    • @ohos.window.floatingBall (Floating Ball Window)
    • @ohos.window (Window)
      • Module Description
      • Functions
      • Interface (Window)
      • Interface (WindowStage)
      • Interfaces (Others)
      • Enums
      • Types
    • @ohos.animation.windowAnimationManager (Window Animation Management) (System API)
    • @ohos.window (Window) (System API)
  • Display Management
    • @ohos.display (Display)
    • @ohos.screenshot (Screenshot)
    • @ohos.display (Display) (System API)
    • @ohos.screen (Screen) (System API)
    • @ohos.screenshot (Screenshot) (System API)
  • APIs No Longer Maintained
    • @ohos.prompt (Prompt)
    • @system.app (Application Context)
    • @system.configuration (Application Configuration)
    • @system.mediaquery (Media Query)
    • @system.prompt (Prompt)
    • @system.router (Page Routing)
    • XComponentNode
    • @ohos.application.WindowExtensionAbility (WindowExtensionAbility) (System API)
    • WindowExtensionContext (System API)
• ArkTS Components
  • Universal Events
    • Basic Input Events
      • Touch Event
      • Mouse Event
      • Axis Event
      • Key Event
      • Crown Event
      • Focus Axis Event
    • Interaction Response Events
      • Click Event
      • Drag/Drop Event
      • Drag Event (System API)
      • Focus Event
      • Hover Event
      • Component Keyboard Shortcut Event
      • Keyboard Determination Event
    • Event Dispatch Control
      • Custom Event Interception
      • Custom Event Dispatch
    • Accessibility Related
      • Accessibility Control Actions
      • Accessibility Hover Event
    • Component Change Events
      • Show/Hide Event
      • Component Area Change Event
      • Component Size Change Event
      • Visible Area Change Event
  • Universal Attributes
    • Basic Attributes
      • Component ID
      • Distributed Migration Identifier
      • Visibility Control
      • Background
      • Overlay Control
      • Z-order Control
      • Obscuring
      • Color Inversion
    • Layout and Borders
      • Sizing
      • Location
      • Layout Constraints
      • Flex Layout
      • Safe Area
      • Component-Level Pixel Rounding
      • Page-Level Pixel Rounding
      • Border Styling
      • Border Image
    • Visual Effects
      • Opacity Control
      • Transformation
      • Image Effect
      • Shape Clipping
      • Color Gradient
      • Foreground Color
      • Foreground Effect
      • Outline Styling
      • Visual Effect
      • Foreground Blur
      • Motion Blur
      • Click Feedback Effect
      • Special Effect Drawing Combination
      • Render Fit
      • Point Light Style (System API)
      • Image Effect (System API)
      • Union Effect (System API)
    • Interaction Properties
      • Enable/Disable
      • Focus Control
      • Drag and Drop Control
      • Drag-and-Drop Sorting
      • Hover Effect
      • Click Sound Effect
      • Touch Interactions
        • Touch Target
        • Hit Test Control
        • Event Monopolization
      • Cursor Control
    • Polymorphic Style
    • Dialog Box Control
      • Popup Control
      • Tooltip Control
      • Menu Control
      • Menu Control (System API)
    • Accessibility
    • Transition
      • Modal Transition
      • Sheet Transition
      • Sheet Transition (System API)
    • Modifiers and Custom Property
      • Attribute Modifier
      • Gesture Modifier
      • Drawing Modifier
      • Content Modifier
      • Custom Property
      • Symbol Glyph Modifier
    • Other
      • Reuse ID
      • Reuse Options
      • Toolbar Configuration
  • Gesture Handling
    • Gesture Binding
      • Gesture Binding Methods
      • Bound Gesture Configuration
      • Gesture Handler
    • Basic Gestures
      • TapGesture
      • LongPressGesture
      • PanGesture
      • PinchGesture
      • RotationGesture
      • SwipeGesture
    • Combined Gestures
    • Gesture Control
      • Custom Gesture Judgment
      • Gesture Blocking Enhancement
    • Gesture Common APIs
  • Rows, Columns, and Stacking
    • Flex
    • Column
    • Row
    • Stack
    • RelativeContainer
    • Flex (System API)
    • Column (System API)
    • Row (System API)
    • Stack (System API)
  • Grid and Column Layout
    • GridRow
    • GridCol
    • ColumnSplit
    • RowSplit
    • SideBarContainer
  • Scroll and Swipe
    • List
    • ListItem
    • ListItemGroup
    • ArcList
    • ArcListItem
    • Grid
    • GridItem
    • Scroll
    • Swiper
    • ArcSwiper
    • WaterFlow
    • FlowItem
    • LazyVGridLayout
    • ScrollBar
    • Refresh
    • ArcScrollBar
    • Scrollable Component Common APIs
    • Grid (System API)
    • List (System API)
  • Navigation and Switching
    • Indicator
    • Navigation
    • NavDestination
    • MultiNavigation
    • Tabs
    • TabContent
    • ToolBarItem
  • Buttons and Selections
    • Button
    • Toggle
    • Checkbox
    • CheckboxGroup
    • UIPickerComponent
    • CalendarPicker
    • DatePicker
    • TextPicker
    • TimePicker
    • Radio
    • Rating
    • Select
    • Select (System API)
    • Slider
    • ArcButton
    • ArcSlider
    • Picker Common APIs
  • Text and Input
    • Text
    • TextArea
    • TextInput
    • RichEditor
    • Search
    • Span
    • ImageSpan
    • ContainerSpan
    • SymbolSpan
    • SymbolGlyph
    • Hyperlink
    • RichText
    • Styled String
    • Text Box Component Common APIs
    • Text Component Common APIs
    • Text Component Common APIs (System API)
    • TextInput (System API)
    • TextArea (System API)
    • Styled String (System API)
    • RichEditor (System API)
  • Images and Videos
    • Image
    • ImageAnimator
    • Video
    • Image Analysis Types
    • SVG Tags
    • Enhanced SVG Parsing Capabilities
    • Image (System API)
    • MediaCachedImage (System API)
    • Video (System API)
  • Information Display
    • AlphabetIndexer
    • ArcAlphabetIndexer
    • Badge
    • Counter
    • DataPanel
    • Gauge
    • LoadingProgress
    • Marquee
    • PatternLock
    • Progress
    • QRCode
    • TextClock
    • TextTimer
    • Information Display APIs
  • Blank and Divider
    • Blank
    • Divider
  • Canvas Drawing
    • Canvas
    • CanvasGradient
    • CanvasPattern
    • CanvasRenderingContext2D
    • DrawingRenderingContext
    • ImageBitmap
    • ImageData
    • Matrix2D
    • OffscreenCanvas
    • OffscreenCanvasRenderingContext2D
    • Path2D
  • Graphic Drawing
    • Circle
    • Ellipse
    • Line
    • Polyline
    • Polygon
    • Path
    • Rect
    • Shape
  • Rendering Drawing
    • XComponent
    • Component3D
    • EmbeddedComponent
    • XComponent (System API)
  • Menus
    • Menu
    • MenuItem
    • MenuItemGroup
    • ContextMenu
  • Animation
    • Property Animation (animation)
    • Explicit Animation (animateTo)
    • Keyframe Animation (keyframeAnimateTo)
    • Page Transition (pageTransition)
    • Component Transition (transition)
    • Shared Element Transition (sharedTransition)
    • Implicit Shared Element Transition (geometryTransition)
    • Motion Path Animation (motionPath)
    • Particle Animation (Particle)
    • Immediate Delivery of Explicit Animation (animateToImmediately)
    • Implicit Shared Element Transition (geometryTransition) (System API)
  • Dialog Boxes
    • Alert Dialog Box (AlertDialog)
    • Action Sheet (ActionSheet)
    • Custom Dialog Box (CustomDialog)
    • Calendar Picker Dialog Box (CalendarPickerDialog)
    • Date Picker Dialog Box (DatePickerDialog)
    • Time Picker Dialog Box (TimePickerDialog)
    • Text Picker Dialog Box (TextPickerDialog)
    • Dialog Box (Dialog)
  • Service Widgets
    • FormLink
    • FormComponent (System API)
  • Security
    • Security Component Universal Attributes
    • PasteButton
    • SaveButton
    • SaveButton (System API)
    • Security Component Universal Attributes (System API)
  • Themes
    • WithTheme
  • AtomicService
    • AtomicServiceNavigation
    • AtomicServiceSearch
    • AtomicServiceTabs
    • AtomicServiceWeb
    • InterstitialDialogAction
    • HalfScreenLaunchComponent
    • AtomicServiceMenuBar (System API)
    • InnerFullScreenLaunchComponent (System API)
    • NavPushPathHelper
  • Custom Placeholder Components
    • NodeContainer
    • ContentSlot
  • Custom Components
    • Custom Component Lifecycle
    • Lifecycle of a Custom Component (Recommended)
    • Custom Component Layout
    • Custom Component Built-in APIs
    • Custom Component Parameters
    • Component Extension Decorators
      • @AnimatableExtend: Animatable Property Definition
      • @Entry: Page Entry Declaration
      • wrapBuilder: Global @Builder Encapsulation
      • mutableBuilder: Dynamic Update of Global @Builder
  • Component Preview
    • Component Preview
  • System Preset UI Component Library
    • Chip
    • ChipGroup
    • ComposeListItem
    • ComposeTitleBar
    • DownloadFileButton
    • DialogV2
    • EditableTitleBar
    • ExceptionPrompt
    • Filter
    • FolderStack
    • FoldSplitContainer
    • FormMenu
    • FullScreenLaunchComponent
    • GridObjectSortComponent
    • Popup
    • ProgressButton
    • ProgressButtonV2
    • SegmentButton
    • SegmentButtonV2
    • SelectTitleBar
    • SelectionMenu
    • SplitLayout
    • SubHeader
    • SubHeaderV2
    • SwipeRefresher
    • TabTitleBar
    • ToolBar
    • ToolBarV2
    • TreeView
    • advanced.Counter
    • SegmentButton (System API)
    • SegmentButtonV2 (System API)
  • State Management and Rendering Control
    • State Management with Application-level Variables
    • State Management V1 Decorator Parameters
    • State Variable Change Listening
    • Built-in Environment Variables
    • ForEach
    • LazyForEach
    • Repeat
    • State Management with Application-level Variables (System API)
  • Responsive Environment Variable
    • @Env: Environment Variable
  • Common Definitions
    • Basic Types
    • Pixel Units
    • Enums
    • Common Event Callback
    • Enums (System API)
  • Other
    • EffectComponent (System API)
    • IsolatedComponent (System API)
    • RemoteWindow (System API)
    • PluginComponent (System API)
    • UIExtensionComponent (System API)
    • UnionEffectContainer (System API)
  • Components and APIs No Longer Maintained
    • AbilityComponent
    • GridContainer
    • Panel
    • NavRouter
    • Navigator
    • Click Control
    • Grid
    • Stepper
    • StepperItem
• JavaScript Components
  • JavaScript-compatible Web-like Development Paradigm (ArkUI.Full)
  • JavaScript-compatible Web-like Development Paradigm (ArkUI.Lite)
  • JavaScript Service Widget UI Components
• C API
  • Modules
    • ArkUI_NativeModule
    • ArkUI_Accessibility
    • OH_NativeXComponent Native XComponent
    • ArkUI_EventModule
    • WindowManager
    • OH_DisplayManager
    • ArkUI_RenderNodeUtils
  • Header Files
    • drag_and_drop.h
    • drawable_descriptor.h
    • native_animate.h
    • native_dialog.h
    • native_gesture.h
    • native_interface.h
    • native_interface_accessibility.h
    • native_interface_focus.h
    • native_interface_xcomponent.h
    • native_key_event.h
    • native_node.h
    • native_node_napi.h
    • native_render.h
    • native_type.h
    • native_xcomponent_key_event.h
    • styled_string.h
    • ui_input_event.h
    • oh_window.h
    • oh_window_comm.h
    • oh_window_event_filter.h
    • oh_window_pip.h
    • oh_display_capture.h
    • oh_display_info.h
    • oh_display_manager.h
  • Structs
    • ArkUI_NodeEvent
    • ArkUI_Context
    • ArkUI_Context*
    • ArkUI_DragEvent
    • ArkUI_DragPreviewOption
    • ArkUI_DragAction
    • ArkUI_DragAndDropInfo
    • ArkUI_DrawableDescriptor
    • ArkUI_DrawableDescriptor_AnimationController
    • OH_PixelmapNative*
    • ArkUI_ExpectedFrameRateRange
    • ArkUI_AnimateCompleteCallback
    • ArkUI_NativeAnimateAPI_1
    • ArkUI_AnimateOption
    • ArkUI_Curve
    • ArkUI_Curve*
    • ArkUI_KeyframeAnimateOption
    • ArkUI_AnimatorOption
    • ArkUI_Animator*
    • ArkUI_AnimatorEvent
    • ArkUI_AnimatorOnFrameEvent
    • ArkUI_TransitionEffect
    • ArkUI_NativeDialogAPI_1
    • ArkUI_NativeDialogAPI_2
    • ArkUI_NativeDialogAPI_3
    • ArkUI_DialogDismissEvent
    • ArkUI_CustomDialogOptions
    • ArkUI_NativeGestureAPI_1
    • ArkUI_NativeGestureAPI_2
    • ArkUI_GestureRecognizer
    • ArkUI_GestureInterruptInfo
    • ArkUI_GestureEvent
    • ArkUI_GestureEventTargetInfo
    • ArkUI_ParallelInnerGestureEvent
    • ArkUI_TouchRecognizer
    • ArkUI_TouchRecognizerHandle*
    • ArkUI_GestureRecognizerHandle*
    • ArkUI_AccessibleAction
    • ArkUI_AccessibleRect
    • ArkUI_AccessibleRangeInfo
    • ArkUI_AccessibleGridInfo
    • ArkUI_AccessibleGridItemInfo
    • ArkUI_AccessibilityProviderCallbacks
    • ArkUI_AccessibilityProviderCallbacksWithInstance
    • ArkUI_AccessibilityElementInfo
    • ArkUI_AccessibilityEventInfo
    • ArkUI_AccessibilityProvider
    • ArkUI_AccessibilityActionArguments
    • ArkUI_AccessibilityElementInfoList
    • OH_NativeXComponent_HistoricalPoint
    • OH_NativeXComponent_TouchPoint
    • OH_NativeXComponent_TouchEvent
    • OH_NativeXComponent_MouseEvent
    • OH_NativeXComponent_Callback
    • OH_NativeXComponent_MouseEvent_Callback
    • OH_NativeXComponent_ExpectedRateRange
    • OH_NativeXComponent
    • OH_NativeXComponent_KeyEvent
    • OH_NativeXComponent_ExtraMouseEventInfo
    • OH_ArkUI_SurfaceHolder
    • OH_ArkUI_SurfaceCallback
    • NativeWindow
    • ArkUI_XComponentSurfaceConfig
    • ArkUI_AttributeItem
    • ArkUI_NodeComponentEvent
    • ArkUI_StringAsyncEvent
    • ArkUI_TextChangeEvent
    • ArkUI_NativeNodeAPI_1
    • ArkUI_NodeCustomEvent
    • ArkUI_NodeAdapter*
    • ArkUI_NodeAdapterEvent
    • ArkUI_NodeContentEvent
    • ArkUI_ContextCallback
    • ArkUI_NumberValue
    • ARKUI_TextPickerRangeContent
    • ARKUI_TextPickerCascadeRangeContent
    • ArkUI_ColorStop
    • ArkUI_Rect
    • ArkUI_IntSize
    • ArkUI_IntOffset
    • ArkUI_Margin
    • ArkUI_TranslationOptions
    • ArkUI_ScaleOptions
    • ArkUI_RotationOptions
    • ArkUI_LayoutConstraint
    • ArkUI_DrawContext
    • ArkUI_Node
    • ArkUI_Node*
    • ArkUI_NativeDialog*
    • ArkUI_WaterFlowSectionOption
    • ArkUI_ListItemSwipeActionItem
    • ArkUI_ListItemSwipeActionOption
    • ArkUI_NodeContent*
    • ArkUI_AlignmentRuleOption
    • ArkUI_GuidelineOption
    • ArkUI_BarrierOption
    • ArkUI_ImageAnimatorFrameInfo
    • ArkUI_ListChildrenMainSize
    • ArkUI_ProgressLinearStyleOption
    • ArkUI_CustomProperty
    • ArkUI_HostWindowInfo
    • ArkUI_ActiveChildrenInfo
    • ArkUI_CrossLanguageOption
    • AbilityBase_Want
    • ArkUI_EmbeddedComponentOption
    • ArkUI_AccessibilityState
    • ArkUI_AccessibilityValue
    • ArkUI_SystemFontStyleEvent
    • ArkUI_CustomSpanMeasureInfo
    • ArkUI_CustomSpanMetrics
    • ArkUI_CustomSpanDrawInfo
    • ArkUI_SwiperIndicator
    • ArkUI_SwiperDigitIndicator
    • ArkUI_SwiperArrowStyle
    • ArkUI_StyledString_Descriptor
    • ArkUI_SnapshotOptions
    • ArkUI_TextPickerRangeContentArray
    • ArkUI_TextCascadePickerRangeContentArray
    • ArkUI_SelectionOptions
    • ArkUI_VisibleAreaEventOptions
    • ArkUI_PositionEdges
    • ArkUI_PixelRoundPolicy
    • ArkUI_MotionPathOptions
    • ArkUI_StyledString
    • ArkUI_TextLayoutManager
    • ArkUI_TextMarqueeOption
    • ArkUI_UIInputEvent
    • ArkUI_ShowCounterConfig
    • ArkUI_TextContentBaseController
    • PictureInPicture_PipConfig
    • WindowManager_Rect
    • OH_PixelmapNative
    • WindowManager_WindowProperties
    • WindowManager_AvoidArea
    • WindowManager_MainWindowInfo
    • WindowManager_WindowSnapshotConfig
    • NativeDisplayManager_Rect
    • NativeDisplayManager_WaterfallDisplayAreaRects
    • NativeDisplayManager_CutoutInfo
    • NativeDisplayManager_DisplayHdrFormat
    • NativeDisplayManager_DisplayColorSpace
    • NativeDisplayManager_DisplayInfo
    • NativeDisplayManager_DisplaysInfo
    • ArkUI_CircleShapeOption
    • ArkUI_ColorAnimatablePropertyHandle
    • ArkUI_ColorPropertyHandle
    • ArkUI_CommandPathOption
    • ArkUI_FloatAnimatablePropertyHandle
    • ArkUI_FloatPropertyHandle
    • ArkUI_NodeBorderColorOption
    • ArkUI_NodeBorderRadiusOption
    • ArkUI_NodeBorderStyleOption
    • ArkUI_NodeBorderWidthOption
    • ArkUI_RectShapeOption
    • ArkUI_RenderContentModifierHandle
    • ArkUI_RenderNodeClipOption
    • ArkUI_RenderNodeHandle
    • ArkUI_RenderNodeMaskOption
    • ArkUI_RoundRectShapeOption
    • ArkUI_Vector2AnimatablePropertyHandle
    • ArkUI_Vector2PropertyHandle
    • ArkUI_ContentTransitionEffect
    • ArkUI_CoastingAxisEvent
    • ArkUI_GridItemRect
    • ArkUI_GridItemSize
    • ArkUI_GridLayoutOptions
    • ArkUI_TouchTestInfo
    • ArkUI_TouchTestInfoItem
    • ArkUI_TouchTestInfoItem*
    • ArkUI_TouchTestInfoItemHandle*
    • ArkUI_TextMenuItem
    • ArkUI_TextMenuItemArray
    • ArkUI_TextEditMenuOptions
    • ArkUI_TextSelectionMenuOptions
    • ArkUI_SelectedDragPreviewStyle
    • ArkUI_PickerIndicatorBackground
    • ArkUI_PickerIndicatorDivider
    • ArkUI_PickerIndicatorStyle
• Error Codes
  • UI
    • API Call Error Codes
    • promptAction Error Codes
    • Router Error Codes
    • Drag Event Error Codes
    • AI Image Analyzer Error Codes
    • Focus Error Codes
    • System Resource Error Codes
    • Auxiliary Node Error Codes
    • Sheet Error Codes
    • Scrollable Component Error Codes
    • Snapshot Error Codes
    • Styled String Error Codes
    • UI Context Error Codes
    • Render State Listening Error Codes
    • Interaction Event Error Codes
    • Canvas Error Codes
    • Custom Node Error Codes
    • UIExtension Error Codes
    • UI Appearance Error Codes
    • NodeAdapter Error Codes
    • XComponent Error Codes
    • Video Component Error Codes
    • State Management Error Codes
    • Render Node Error Codes
    • DrawableDescriptor Error Codes
    • Environment Variable Error Codes
    • Color Inversion Error Codes
  • Graphics
    • Display Error Codes
    • Window Error Codes
  • UI Compilation
    • Compilation Error Codes