Skills
.Work. You
Rest

arkui-api-design

Official

Guides ArkUI API design and maintenance.

Authoreclipse-oniro-mirrors
Version1.0.0
Installs0

System Documentation

What problem does it solve?

ArkUI API design guidance helps teams build consistent, well-documented ArkUI component interfaces that align with OpenHarmony coding standards.

Core Features & Use Cases

  • Guidelines for API design: naming conventions, type safety, code style, and documentation requirements per OpenHarmony guidance.
  • Modifier synchronization & deprecation planning: ensure properties and modifiers stay in sync; provide migration paths and deprecated API handling.
  • Resource typing and theming support: guidance for Resource types and theming considerations across components.
  • Practical use cases: designing new APIs, auditing existing ones, and generating JSDoc with proper @since and @deprecated annotations.

Quick Start

Start by requesting ArkUI API design guidance for a specific component, for example: design a Button API with width, height, and backgroundColor modifiers that follow OpenHarmony guidelines.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 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/eclipse-oniro-mirrors/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 223,000+ vetted skills library on demand.