arkui-api-design

Design ArkUI component APIs following OpenHarmony API design standards.

14|8|Updated Oct 29, 2024
One-click install
npx skills add https://github.com/openharmony/arkui_ace_engine --skill arkui-api-design
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: arkui-api-design
Source: https://github.com/openharmony/arkui_ace_engine/tree/main/.claude/skills/arkui-api-design
Command: npx skills add https://github.com/openharmony/arkui_ace_engine --skill arkui-api-design

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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.

Frequently Asked Questions about arkui-api-design

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I design ArkUI component APIs consistently for OpenHarmony?

To design ArkUI component APIs consistently, follow OpenHarmony standards for interface definitions, modifier synchronization, resource typing, and JSDoc documentation to ensure adherence to coding guidelines.

What is the standard way to handle deprecations when renaming ArkUI methods?

Handling deprecations when renaming ArkUI methods requires providing explicit migration paths and JSDoc documentation to guide developers, ensuring consistent API reviews and transitions across OpenHarmony scenarios.

Does OpenHarmony API design require supporting Resource types for ArkUI properties?

Yes, OpenHarmony API design requires supporting Resource types for ArkUI properties to ensure consistent resource typing across components, alongside documenting undefined or null behavior explicitly.

How should I document unit constraints and undefined behavior in ArkUI APIs?

Document unit constraints and undefined or null behavior in ArkUI APIs by providing explicit JSDoc documentation, ensuring interface definitions meet OpenHarmony API design standards for clarity and consistency.

Can I use this approach to audit existing ArkUI APIs for consistency?

Yes, you can use this approach to audit existing ArkUI APIs for consistency by acting as a reference to review interface definitions, modifiers, and JSDoc documentation against OpenHarmony coding guidelines.