arkui-api-design

Official

Guides ArkUI API design with OpenHarmony standards

Authoropenharmony
Version1.0.0
Installs0

System Documentation

What problem does it solve?

ArkUI API design consistency across components, by providing structured guidance for interface definitions, modifiers, and JSDoc documentation, ensuring adherence to OpenHarmony coding guidelines.

Core Features & Use Cases

  • Standardizes interface definitions, modifier synchronization, resource typing, and documentation for ArkUI components.
  • Supports API reviews, deprecation patterns, and migration guidance with concrete examples.
  • Acts as a reference when designing new components or auditing existing ArkUI APIs for consistency.

Quick Start

Design ArkUI component APIs following OpenHarmony guidelines to create or review a component API (e.g., Button) with properties, modifiers, resources, and JSDoc.

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: arkui-api-design
Download link: https://github.com/openharmony/arkui_ace_engine/archive/main.zip#arkui-api-design

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.