# samples

**Repository Path**: arkui-x/samples

## Basic Information

- **Project Name**: samples
- **Description**: Cross-platform use cases of ArkUI-X | ArkUI-X跨平台应用示例
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 85
- **Forks**: 22
- **Created**: 2023-08-06
- **Last Updated**: 2025-10-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ArkUI-X App Samples

## Welcome
Thank you for following the ArkUI-X project. Your contribution to this project will be highly appreciated. If you want to submit code samples or demos, go to the [Samples](https://gitee.com/arkui-x/samples) repository. Thank you again for your support.

### Introduction
This repository provides a series of app samples to help you quickly learn the APIs and development process of the ArkUI-X project. Each app sample is an independent cross-platform application project. By using the code editor or [CLI](https://gitee.com/arkui-x/cli) development tool to browse code, build projects, and install and run app samples, you'll be able to familiarize yourself with the ArkUI cross-platform application development process.

### App Samples

- Basic apps
  - ['HelloWorld'：HelloWorld（API12）](HelloWorld)
  - ['Library'：Library（API12）](Library)
  - ['Native'：Native（API12）](Native)
  - ['MultiAbility'：MultiAbility（API12）](MultiAbility)
  
- Featured apps
  - ['Animation'：Animation（API12）](Animation)
  - ['Files'：Files（API12）](Files)
  - ['FauxNativeAlbum'：FauxNativeAlbum（API12）](FauxNativeAlbum)
  - ['InfiniteList'：InfiniteList（API12）](InfiniteList)
  - ['JsonExample'：JsonExample（API12）](JsonExample)
  - ['PlatformBridge'：PlatformBridge（API12）](PlatformBridge)
  - ['Router'：Router（API12）](Router)
  - ['WebExample'：WebExample（API12）](WebExample)
  - ['MediaVideo'：MediaVideo（API12）](MediaVideo)
  - ['PlatformNAPI'：PlatformNAPI（API12）](PlatformNAPI)
  - ['XcomponentNative'：XcomponentNative（API12）](XcomponentNative)
  
- Premium apps
  - ['Shopping'：Shoppint（API12）](Shopping)
  - ['HealthyDiet'：HealthyDiet（API12）](HealthyDiet)
  - ['News'：News（API12）](News)

## Directory Structure

```
samples
|---HelloWorld          # Basic apps：HelloWorld
|---Library             # Basic apps：Library
|---Native              # Basic apps：Native
|---MultiAbility        # Basic apps：MultiAbility
|---Animation           # Featured apps：Animation
|---Files               # Featured apps：Files
|---FauxNativeAlbum     # Featured apps：FauxNativeAlbum
|---InfiniteList        # Featured apps：InfiniteList
|---JsonExample         # Featured apps：JsonExample
|---PlatformBridge      # Featured apps：PlatformBridge
|---Router              # Featured apps：Router
|---WebExample          # Featured apps：Web
|---MediaVideo          # Featured apps：MediaVideo
|---PlatformNAPI        # Featured apps：PlatformNAPI
|---XcomponentNative    # Featured apps：XcomponentNative
|---Shopping            # Premium apps：Shopping
|---HealthyDiet         # Premium apps：HealthyDiet
|---News                # Premium apps：News
```

## Constraints

When contributing an app sample, make sure that it meets the project structure requirements of ArkUI-X Command Line Tools, as well as the application project build and packaging requirements, such as package signing, of the OS platform.

## How to Use

1.  Run [Repo](https://gitee.com/arkui-x/manifest/blob/master/README-EN.md) commands to download all repositories of the ArkUI-X project or download the desired app samples.
2.  Go to the directory that houses the desired sample, and run the [CLI](https://gitee.com/arkui-x/cli) commands or use DevEco Studio to build a cross-platform application.
3.  Install and run the application. In this way, you can view the effect on devices running different OS platforms.


## Relative Notes

1、These samples support running on Android \ iOS \ HarmonyOS NEXT platforms.
2、These samples require  DevEco Studio 5.0.0 Release and above or the Ace Tools command-line tool of ArkUI-X SDK 5.0.0 Release and above to compile and run.

## Repositories Involved

1. [Samples](https://gitee.com/arkui-x/samples) 
2. [CLI](https://gitee.com/arkui-x/cli)