arkui-api-design

To design an ArkUI component API, you add component properties, create Modifier methods, deprecate APIs with migration guidance, enforce correct JSDoc tag structure, ensure consistent Resource handling rules, and verify changes through SDK compilation output.

To deprecate an ArkUI API with migration guidance, you apply OpenHarmony TypeScript coding standards to mark the API deprecated, update the JSDoc tags with clear undefined/null behavior, and synchronize the changes across static and dynamic API files.

Yes, you can verify new component properties in the SDK build by following a build-and-verify workflow using SDK compilation output paths, which ensures the generated outputs export the new or updated ArkUI APIs successfully.

To deprecate an ArkUI API with proper migration guidance, you apply OpenHarmony TypeScript coding standards to mark the API deprecated, update the JSDoc tags with clear undefined/null behavior, and synchronize the changes across static and dynamic API files.

When should I use Resource versus ResourceStr types in OpenHarmony ArkUI API design? You must enforce correct typing rules for Resource versus ResourceStr during OpenHarmony API design to ensure strict type signatures, handling component properties consistently and matching the expected OpenHarmony coding standards.