### Icon Component Examples
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/Icon/index.md
Examples demonstrating how to use the Icon component.
```APIDOC
### Basic Usage
```xml
```
### Custom Size and Color
```xml
```
```
--------------------------------
### Install antd-mini for Alipay Applet
Source: https://github.com/ant-design/ant-design-mini/blob/master/docs/guide/using-uni-app.en.md
Commands to create a directory, initialize npm, and install antd-mini for use in Alipay applets.
```shell
mkdir mycomponents
cd mycomponents
# 安装依赖
npm init -y
npm i antd-mini --save
```
--------------------------------
### Install Project Dependencies
Source: https://github.com/ant-design/ant-design-mini/blob/master/docs/guide/contribute.en.md
Run this command in the project root to install all necessary npm dependencies.
```bash
npm i
```
--------------------------------
### Install antd-mini for WeChat Applet
Source: https://github.com/ant-design/ant-design-mini/blob/master/docs/guide/using-uni-app.en.md
Commands to create a directory, initialize npm, and install antd-mini for use in WeChat applets.
```shell
mkdir wxcomponents
cd wxcomponents
# 安装依赖
npm init -y
npm i antd-mini --save
```
--------------------------------
### Install Ant Design Mini
Source: https://github.com/ant-design/ant-design-mini/blob/master/README.md
Install Ant Design Mini using npm, yarn, pnpm, or bun.
```bash
$ npm install antd-mini
# or
$ yarn add antd-mini
# or
$ pnpm add antd-mini
# or
$ bun add antd-mini
```
--------------------------------
### Install WeChat Applet Dependencies
Source: https://github.com/ant-design/ant-design-mini/blob/master/docs/guide/contribute.en.md
Navigate to the WeChat applet directory and install its specific dependencies.
```bash
cd compiled/wechat
npm i
```
--------------------------------
### Basic Use
Source: https://github.com/ant-design/ant-design-mini/blob/master/copilot/Welcome/index.en.md
Example of how to use the Welcome component with basic properties.
```APIDOC
## Basic Use
### Description
Example of how to use the Welcome component with basic properties.
### Request Example
```
--------------------------------
### Basic Image Uploader Setup
Source: https://context7.com/ant-design/ant-design-mini/llms.txt
A basic ImageUpload component setup using default file list and common event handlers.
```xml
```
--------------------------------
### Install Ant Design Mini
Source: https://github.com/ant-design/ant-design-mini/blob/master/docs/guide/quick-start.en.md
Use npm to install the Ant Design Mini library. This is the initial step for integrating the components.
```shell
$ npm i antd-mini --save
```
--------------------------------
### Start Project Compilation
Source: https://github.com/ant-design/ant-design-mini/blob/master/docs/guide/contribute.en.md
Execute this command to compile the source code into the 'compiled' directory.
```bash
npm run dev
```
--------------------------------
### NumberKeyboard Demo Example
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/NumberKeyboard/index.md
A comprehensive demo showcasing various features and configurations of the Ant Design Mini NumberKeyboard component. This example serves as a reference for different use cases.
```javascript
import React from 'react';
import { View, Text, Button } from '@tarojs/components';
import AntNumberKeyboard from '@ant-design/ant-design-mini/es/NumberKeyboard';
const NumberKeyboardDemoPage = () => {
const [visible1, setVisible1] = React.useState(false);
const [visible2, setVisible2] = React.useState(false);
const [visible3, setVisible3] = React.useState(false);
const [value1, setValue1] = React.useState('');
const [value2, setValue2] = React.useState('');
const handleInput1 = (val) => {
setValue1(value1 + val);
};
const handleDelete1 = () => {
setValue1(value1.slice(0, -1));
};
const handleConfirm1 = () => {
console.log('Confirm value 1:', value1);
setVisible1(false);
};
const handleInput2 = (val) => {
setValue2(value2 + val);
};
const handleDelete2 = () => {
setValue2(value2.slice(0, -1));
};
const handleConfirm2 = () => {
console.log('Confirm value 2:', value2);
setVisible2(false);
};
return (
Default Keyboard: setVisible1(false)}
onConfirm={handleConfirm1}
onInput={handleInput1}
onDelete={handleDelete1}
value={value1}
/>
Keyboard without Decimal: setVisible2(false)}
onConfirm={handleConfirm2}
onInput={handleInput2}
onDelete={handleDelete2}
value={value2}
point={false}
/>
Keyboard with Custom Confirm Button: setVisible3(false)}
confirmText="Done"
>
Custom Confirm
);
};
export default NumberKeyboardDemoPage;
```
--------------------------------
### Empty Component Usage Examples
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/Empty/index.md
Examples demonstrating how to use the Ant Design Mini Empty component with different configurations.
```APIDOC
## Empty Component Usage Examples
### Basic Usage
```xml
```
### Custom Image
```xml
```
### With Action Button
```xml
```
```js
const BUTTON_LIST = [
{
type: 'primary',
text: 'refresh',
},
{
type: 'default',
text: 'checkout internet',
},
];
Page({
data: {
// Horizontal button layout
horizontalButtonInfo: {
layout: 'horizontal',
list: BUTTON_LIST,
},
// Vertical button layout
verticalButtonInfo: {
layout: 'vertical',
list: BUTTON_LIST,
},
},
});
```
### Using Slots
```xml
Custom Action Button
```
```
--------------------------------
### Basic Postscript Usage
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/Postscript/index.md
This example demonstrates the basic integration and usage of the Postscript component. Ensure the component is imported correctly.
```javascript
Page({
// ...
onPostscriptChange(value) {
console.log('Postscript value changed:', value);
}
});
```
--------------------------------
### Basic Usage
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/NumberKeyboard/index.md
Examples demonstrating the basic usage of the NumberKeyboard component.
```APIDOC
## Basic Usage
### Default Keyboard
```xml
```
### Keyboard without Decimal Point
```xml
```
### Keyboard with Confirm Button
```xml
```
### Keyboard with Close Arrow
```xml
```
### Random Order Keyboard
```xml
```
### Custom Buttons
#### Custom Header
```xml
Custom Title
```
#### Custom Confirm Button
```xml
```
```
--------------------------------
### Install Ant Design Mini for Alipay Mini Programs
Source: https://github.com/ant-design/ant-design-mini/blob/master/docs/guide/using-uni-app.md
Create a 'mycomponents' directory and install antd-mini using npm. This is required for using antd-mini components in Alipay mini-programs.
```shell
mkdir mycomponents
cd mycomponents
# Install dependencies
npm init -y
npm i antd-mini --save
```
--------------------------------
### Landscape Mode Examples
Source: https://github.com/ant-design/ant-design-mini/blob/master/copilot/Prompts/index.en.md
Provides examples of configuring the Prompts component for landscape mode, including horizontal scrolling and line wrapping.
```APIDOC
## Landscape Mode
### Description
These examples showcase how to configure the Prompts component to display items in a landscape orientation, suitable for wider screens or specific layout requirements. Options include horizontal scrolling and automatic line wrapping.
### Horizontal Scrolling
```xml
```
### Horizontal with Line Wrap
```xml
```
### Custom Landscape Item
```xml
Custom:{{ props.item.label}}
```
```
--------------------------------
### Basic Use Example
Source: https://github.com/ant-design/ant-design-mini/blob/master/copilot/Prompts/index.en.md
Demonstrates the fundamental usage of the Prompts component with a list of items and a title.
```APIDOC
## Basic Use
### Description
This example shows how to integrate the Prompts component into your page, providing a list of suggested actions or questions for the user.
### Component Usage
```xml
```
### JavaScript Data
```js
Page({
data: {
promptsTitle: '我可以帮您:',
baseList: [
{
title: 'Ant Design X 全新升级了什么?',
},
{
title: 'Ant Design X 组件资产内容',
},
{
title: '快速实现安装和Introduction组件',
},
],
},
onItemTap(item) {
let item = i;
#if ALIPAY
my.alert({
content: `点击了 ${item.title || ''} ${item.content || ''}`,
});
#endif
#if WECHAT
item = i.detail;
wx.showToast({ title: `点击了 ${item.title || ''} ${item.content || ''}` });
#endif
},
});
```
```
--------------------------------
### Tip with Arrow Example
Source: https://github.com/ant-design/ant-design-mini/blob/master/copilot/Prompts/index.en.md
Illustrates how to configure prompts with an arrow indicator and associated images and content.
```APIDOC
## Tip with Arrow
### Description
This example demonstrates how to use the `showArrow` property to add visual cues to prompt items, making them more interactive and informative.
### Component Usage
```xml
```
### JavaScript Data
```js
Page({
data: {
promptsTitle: '我可以帮您:',
arrowList: [
{
showArrow: true,
title: '热门话题:',
image:
'https://mdn.alipayobjects.com/huamei_upibrs/afts/img/A*wJ5aRpr2q1wAAAAAAAAAAAAADkx8AQ/original',
content: 'Ant Design X 全新升级',
},
{
showArrow: true,
title: '组件查询:',
image:
'https://mdn.alipayobjects.com/huamei_upibrs/afts/img/A*R9L1RLo4x58AAAAAAAAAAAAADkx8AQ/original',
content: '欢迎组件',
},
{
showArrow: true,
title: '新手帮助:',
image:
'https://mdn.alipayobjects.com/huamei_upibrs/afts/img/A*7eRqQ4JpdccAAAAAAAAAAAAADkx8AQ/original',
content: '如何实现快速安装和Introduction',
},
],
},
});
```
```
--------------------------------
### Basic Usage Example
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/SwipeAction/index.md
Demonstrates the basic implementation of the SwipeAction component with right-aligned buttons.
```APIDOC
## Basic Usage Example
### Description
Demonstrates the basic implementation of the SwipeAction component with right-aligned buttons.
### Method
N/A (Component Usage)
### Endpoint
N/A (Component Usage)
### Request Body Example
```xml
Right side - three buttons
```
### Response Example
N/A (Component Usage)
```
--------------------------------
### NumberKeyboard Number Input Example
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/NumberKeyboard/index.md
Demonstrates integrating the NumberKeyboard with a number input field. This example likely handles input value updates and keyboard visibility.
```javascript
import React from 'react';
import { View, Text, Input, Button } from '@tarojs/components';
import AntNumberKeyboard from '@ant-design/ant-design-mini/es/NumberKeyboard';
const NumberKeyboardNumberPage = () => {
const [visible, setVisible] = React.useState(false);
const [value, setValue] = React.useState('');
const handleInput = (val) => {
setValue(value + val);
};
const handleDelete = () => {
setValue(value.slice(0, -1));
};
const handleConfirm = () => {
console.log('Confirm value:', value);
setVisible(false);
};
return (
setVisible(true)}
placeholder="Enter number"
/>
setVisible(false)}
onConfirm={handleConfirm}
onInput={handleInput}
onDelete={handleDelete}
/>
);
};
export default NumberKeyboardNumberPage;
```
--------------------------------
### Form Layout Example
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/Form/index.md
Illustrates different layout options for the Form component.
```javascript
import { Form } from 'antd-mini/es/Form/form';
Page({
onInit() {
this.form = new Form();
},
handleRef(ref) {
this.form.addItem(ref);
},
});
```
--------------------------------
### Install Ant Design Mini for WeChat Mini Programs
Source: https://github.com/ant-design/ant-design-mini/blob/master/docs/guide/using-uni-app.md
Create a 'wxcomponents' directory and install antd-mini using npm. This is the initial step for using antd-mini components in WeChat mini-programs.
```shell
mkdir wxcomponents
cd wxcomponents
# Install dependencies
npm init -y
npm i antd-mini --save
```
--------------------------------
### NumberKeyboard Code Input Example
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/NumberKeyboard/index.md
Illustrates using the NumberKeyboard for a code input scenario, likely for verification codes. This example manages input and display for a fixed number of digits.
```javascript
import React from 'react';
import { View, Text, Input, Button } from '@tarojs/components';
import AntNumberKeyboard from '@ant-design/ant-design-mini/es/NumberKeyboard';
const NumberKeyboardCodePage = () => {
const [visible, setVisible] = React.useState(false);
const [code, setCode] = React.useState('');
const codeLength = 6;
const handleInput = (val) => {
if (code.length < codeLength) {
setCode(code + val);
}
};
const handleDelete = () => {
setCode(code.slice(0, -1));
};
const handleConfirm = () => {
console.log('Confirm code:', code);
setVisible(false);
};
return (
Please enter the verification code:
setVisible(true)}
disabled
placeholder="- - - - - -"
/>
setVisible(false)}
onConfirm={handleConfirm}
onInput={handleInput}
onDelete={handleDelete}
point={false} // Typically no decimal for verification codes
/>
);
};
export default NumberKeyboardCodePage;
```
--------------------------------
### Basic Usage Example
Source: https://github.com/ant-design/ant-design-mini/blob/master/copilot/ThoughtChain/index.md
Demonstrates the basic rendering of multiple nodes in the ThoughtChain component.
```APIDOC
## Basic Usage Example
### Description
This example renders multiple nodes.
### XML
```xml
```
### JavaScript
```javascript
Page({
data: {
basicList: [
{
title: '理解问题',
content: '3A游戏',
icon: 'CheckCircleOutline'
},
{
title: '没有在本地找到结果',
content: '当前主流显卡',
icon: 'CheckCircleOutline'
},
{
title: '在互联网上搜索问题',
content: '黑神话悟空所需显卡',
icon: 'MoreOutline',
},
],
},
onContentTap(e) {
const { content } = e.currentTarget.dataset || {};
my.alert({
content: `点击了内容「${content}」`,
});
},
});
```
```
--------------------------------
### Voucher Component Setup
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/Voucher/index.md
Instructions on how to import and use the Voucher component in your project's JSON configuration.
```APIDOC
## Importing the Voucher Component
In your `index.json` file, introduce the component using the following configuration:
```json
"usingComponents": {
#if ALIPAY
"ant-voucher": "antd-mini/es/Voucher/index"
#endif
#if WECHAT
"ant-voucher": "antd-mini/Voucher/index"
#endif
}
```
```
--------------------------------
### Space Component Usage Examples
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/Space/index.md
Illustrates various ways to use the Space component with different configurations.
```APIDOC
## Space Component Usage Examples
### Basic Usage
```xml
按钮1按钮2按钮3
```
### Vertical Spacing
```xml
按钮1按钮2按钮3
```
### Spacing Size
```xml
按钮1按钮2按钮3
```
### Alignment
```xml
按钮1高度不同的内容按钮3
```
### Automatic Wrapping
```xml
按钮1按钮2按钮3按钮4按钮5
```
```
--------------------------------
### Basic Checkbox Example
Source: https://context7.com/ant-design/ant-design-mini/llms.txt
Implement a basic checkbox for user agreement, with an `onChange` handler to track its state.
```xml
Accept terms and conditions
```
--------------------------------
### Basic Use Example
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/PageContainer/index.en.md
Demonstrates the basic usage of the PageContainer component with common properties.
```APIDOC
## Basic Use
### Description
Demonstrates the basic usage of the PageContainer component with common properties.
### Method
None (Component Usage)
### Endpoint
None (Component Usage)
### Request Example
```xml
minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
```
### Response
None (Component Usage)
### JavaScript Example
```javascript
Page({
data: {
loading: true,
status: 'failed',
safeArea: 'both',
},
onLoad() {
setTimeout(() => {
this.setData({
loading: false,
});
}, 1000);
},
handleRefresh() {
my.reLaunch({
url: 'index',
fail(e) {
console.log(e);
},
});
},
handleSwitchToDisconnected() {
this.setData({
status: 'disconnected',
title: undefined,
message: undefined,
image: '',
});
},
});
```
```
--------------------------------
### Form Layout Example
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/Form/index.en.md
Illustrates different layout options for the Form component, including label positioning and alignment.
```javascript
import React from 'react';
import {
Form,
FormItem,
Input,
Radio,
Checkbox,
Button,
Toast,
} from '@alifd/next';
const FormLayout = () => {
const [form] = Form.useForm();
const handleSubmit = () => {
form.submit((values) => {
Toast.toast({
content: 'Submit Success',
});
console.log('Submit values:', values);
});
};
return (
);
};
export default FormLayout;
```
--------------------------------
### Basic Container Usage
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/Container/index.en.md
A basic example of using the ant-container component with a simple title.
```xml
```
--------------------------------
### Multiple Forms Example
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/Form/index.md
Demonstrates how to manage multiple forms within a single page.
```javascript
import { Form } from 'antd-mini/es/Form/form';
Page({
onInit() {
this.form1 = new Form();
this.form2 = new Form();
},
handleRef1(ref) {
this.form1.addItem(ref);
},
handleRef2(ref) {
this.form2.addItem(ref);
},
});
```
--------------------------------
### Custom Prompt Item Example
Source: https://github.com/ant-design/ant-design-mini/blob/master/copilot/Prompts/index.en.md
Illustrates how to customize the rendering of individual prompt items using a slot.
```APIDOC
## Custom Prompt Item
### Description
This example demonstrates how to customize the appearance and content of each prompt item by utilizing the `prompts-item` slot and accessing item data via `slot-scope`.
### Component Usage
```xml
Custom prompt items :{{ props.item.title}}
```
```
--------------------------------
### Custom Content Example (Alipay Only)
Source: https://github.com/ant-design/ant-design-mini/blob/master/copilot/ThoughtChain/index.md
Shows how to customize the content of each node using the 'content' slot. This feature is only supported on Alipay.
```APIDOC
## Custom Content Example (Alipay Only)
### Description
`content` slot supports custom node content. Only supported on Alipay, not on WeChat.
### XML
```xml
{{module.content}}
```
```
--------------------------------
### Preview Documentation
Source: https://github.com/ant-design/ant-design-mini/blob/master/docs/guide/contribute.en.md
Run this command to compile and preview the project's documentation.
```bash
npm run dev:doc
```
--------------------------------
### Space Alignment Example
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/Space/index.md
Aligns items to the 'start' of the cross-axis within the Space component, useful when items have different heights.
```xml
按钮1高度不同的内容按钮3
```
--------------------------------
### NumberKeyboard with Verification Code Input Box
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/NumberKeyboard/index.en.md
Demonstrates using NumberKeyboard for verification code input. See the demo file for the complete example.
```unknown
```
--------------------------------
### Popover Placement Example
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/Popover/index.en.md
Shows how to set the placement of the Popover to 'top-right'. Includes a small Ant Design button and a view in the content slot.
```xml
Point me
```
--------------------------------
### Basic Usage
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/GuideTour/index.md
Demonstrates the basic integration and usage of the GuideTour component with default configurations.
```APIDOC
## Basic Usage
### Description
Demonstrates the basic integration and usage of the GuideTour component with default configurations.
### Component Import
In `index.json`, import the component:
```json
"usingComponents": {
#if ALIPAY
"ant-guide-tour": "antd-mini/es/GuideTour/index"
#endif
#if WECHAT
"ant-guide-tour": "antd-mini/GuideTour/index"
#endif
}
```
### XML Example
```xml
```
### JavaScript Example
```js
Page({
data: {
visible: true,
items: [
{ left: 20, top: 80, imageUrl: 'https://gw.alipayobjects.com/zos/antfincdn/IV3MGP1qL/bianzu%25252013.png', imageMode: 'widthFix' },
{ left: 20, top: 160, imageUrl: 'https://gw.alipayobjects.com/zos/antfincdn/%26B6d3lBJn/bianzu%25252020.png' },
{ left: 20, top: 220, imageUrl: 'https://gw.alipayobjects.com/zos/antfincdn/lwVOkCcwb/bianzu%25252021.png' },
],
},
onChange(index) {
#if ALIPAY
console.log('index', index);
#endif
},
closeTour() {
this.setData({
visible: false,
});
},
});
```
```
--------------------------------
### Component Introduction
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/NumberKeyboard/index.md
Instructions on how to introduce the NumberKeyboard component into your project.
```APIDOC
## Introduction
Introduce the component in `index.json`:
```json
"usingComponents": {
#if ALIPAY
"ant-number-keyboard": "antd-mini/es/NumberKeyboard/index"
#endif
#if WECHAT
"ant-number-keyboard": "antd-mini/NumberKeyboard/index"
#endif
}
```
```
--------------------------------
### Introduction and Usage
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/SelectContact/index.md
Instructions on how to introduce and use the SelectContact component in your project.
```APIDOC
## Introduction
To use the SelectContact component, you need to import it in your `index.json` file.
### Installation
```json
{
"usingComponents": {
"ant-select-contact": "antd-mini/es/SelectContact/index"
}
}
```
## Basic Usage Example
This example demonstrates the basic implementation of the SelectContact component.
### Template
```xml
```
### Script
```js
Page({
handleChange(value) {
console.log(value);
},
});
```
```
--------------------------------
### Component Introduction
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/Space/index.md
Instructions on how to introduce the Space component into your project.
```APIDOC
## Component Introduction
In `index.json` to introduce the component:
```json
"usingComponents": {
#if ALIPAY
"ant-space": "antd-mini/es/Space/index"
#endif
#if WECHAT
"ant-space": "antd-mini/Space/index"
#endif
}
```
```
--------------------------------
### Basic GuideTour Usage
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/GuideTour/index.en.md
Demonstrates basic usage of the GuideTour component with items and visibility control. Includes cancel and change event handlers.
```xml
```
--------------------------------
### Space Component Usage Examples
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/Space/index.en.md
Examples demonstrating various ways to use the Ant Design Mini Space component, including basic usage, vertical spacing, size control, alignment, and auto-wrapping.
```APIDOC
## Space Component Usage Examples
### Description
Examples demonstrating various ways to use the Ant Design Mini Space component, including basic usage, vertical spacing, size control, alignment, and auto-wrapping.
### Basic Use
```xml
Button 1Button 2Button 3
```
### Vertical Space
```xml
Button 1Button 2Button 3
```
### Space Size
```xml
Button 1Button 2Button 3
```
### Alignment
```xml
Button 1Content with different heightButton 3
```
### Auto Wrap
```xml
Button 1Button 2Button 3Button 4Button 5
```
```
--------------------------------
### Install Ant Design Mini v0 with npm alias
Source: https://github.com/ant-design/ant-design-mini/blob/master/docs/guide/faq.en.md
Use npm alias to install older versions of Ant Design Mini alongside newer ones. This is useful for migrating from 0.x to 3.x.
```json
{
"dependencies": {
"antd-mini": "^3.0.0",
"antd-mini-v0": "npm:antd-mini@^0.0.26"
}
}
```
```bash
$ npm install
```
--------------------------------
### NoticeBar Basic Usage
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/NoticeBar/index.en.md
Demonstrates the basic implementation of the NoticeBar component with different types.
```APIDOC
## Basic Use
```xml
defaultinfoerror
```
```
--------------------------------
### SelectContact Basic Usage
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/SelectContact/index.en.md
Example of how to use the SelectContact component in an application.
```APIDOC
## SelectContact Basic Usage
### Introduction
To use the SelectContact component, introduce it in your `index.json` file:
```json
"usingComponents": {
#if ALIPAY
"ant-select-contact": "antd-mini/es/SelectContact/index"
#endif
#if WECHAT
"ant-select-contact": "antd-mini/SelectContact/index"
#endif
}
```
### Code Sample
```xml
```
### Event Handling
Handle the `onChange` (Alipay) or `bindchange` (WeChat) event to process selected values:
```js
Page({
handleChange(value) {
console.log(value);
},
});
```
```
--------------------------------
### Basic Use
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/Steps/index.en.md
Demonstrates the basic usage of the Steps component with data-driven rendering.
```APIDOC
## Basic Use
### Description
Data-driven step bar rendering. `current` specifies the current step, `status` specifies the status of the current step (optional `finish` or `error`).
### XML
```xml
```
### JavaScript
```js
Page({
data: {
items: [
{
title: 'Step1',
description: 'description',
},
{
title: 'Step2',
description: 'description',
},
{
title: 'Step3',
description: 'description',
},
],
},
});
```
```
--------------------------------
### Form with Field Watching
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/Form/index.md
Example of how to watch for changes in form fields.
```javascript
import { Form } from 'antd-mini/es/Form/form';
Page({
onInit() {
this.form = new Form({
watch: {
username: (value) => {
console.log('Username changed:', value);
},
},
});
},
handleRef(ref) {
this.form.addItem(ref);
},
});
```
--------------------------------
### Basic GuideTour Usage
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/GuideTour/index.md
Demonstrates the basic implementation of the GuideTour component using XML for the template and JavaScript for page logic. Includes event handlers for cancel and change events.
```xml
```
```js
Page({
data: {
visible: true,
items: [
{ left: 20, top: 80, imageUrl: 'https://gw.alipayobjects.com/zos/antfincdn/IV3MGP1qL/bianzu%25252013.png', imageMode: 'widthFix' },
{ left: 20, top: 160, imageUrl: 'https://gw.alipayobjects.com/zos/antfincdn/%26B6d3lBJn/bianzu%25252020.png' },
{ left: 20, top: 220, imageUrl: 'https://gw.alipayobjects.com/zos/antfincdn/lwVOkCcwb/bianzu%25252021.png' },
],
},
onChange(index) {
#if ALIPAY
console.log('index', index);
#endif
},
closeTour() {
this.setData({
visible: false,
});
},
});
```
--------------------------------
### Avatar Component Usage
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/Avatar/index.md
Examples of how to use the Avatar component in your project.
```APIDOC
## Avatar Component Usage
### Introduction
To use the Avatar component, include it in your `index.json` file:
```json
{
"usingComponents": {
#if ALIPAY
"ant-avatar": "antd-mini/es/Avatar/index"
#endif
#if WECHAT
"ant-avatar": "antd-mini/Avatar/index"
#endif
}
}
```
### Basic Usage
```xml
```
### Demo Code
For a complete demo, refer to the code at `../../demo/pages/Avatar/index`.
```
--------------------------------
### Sender Component Usage
Source: https://github.com/ant-design/ant-design-mini/blob/master/copilot/Sender/index.en.md
Example of how to use the Sender component in your application.
```APIDOC
## Sender Component Usage
### Description
This section provides a basic usage example for the Sender component.
### Code Sample
```jsx
```
### When to use
Used when user input is required and a message is sent. Support adaptive height, send status, custom slot and other functions.
```
--------------------------------
### Welcome Component API
Source: https://github.com/ant-design/ant-design-mini/blob/master/copilot/Welcome/index.md
Detailed API documentation for the Welcome component, including its properties and events.
```APIDOC
## Welcome Component API
### Properties
The following table describes the API properties for the Welcome component:
| Property | Description | Type | Default Value |
| -------- | ----------- | ---- | ------------- |
| className | Class name | string | - |
| styles | Custom styles | string | - |
| title | Title | string | - |
| description | Description | string | - |
### Events
| Event Name | Description | Type |
| ---------- | ----------- | ---- |
| onTap | Triggered when the description is tapped | (e) => void |
```
--------------------------------
### Image Upload Validation
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/Form/index.md
Example of validating image uploads within a form.
```javascript
import { Form } from 'antd-mini/es/Form/form';
Page({
onInit() {
this.form = new Form({
rules: {
image: [
{ required: true, message: '请上传图片' },
// Add custom image validation rules here if needed
],
},
});
},
handleRef(ref) {
this.form.addItem(ref);
},
});
```
--------------------------------
### Welcome Component Introduction and Usage
Source: https://github.com/ant-design/ant-design-mini/blob/master/copilot/Welcome/index.md
This snippet shows how to introduce and use the Welcome component in your Ant Design Mini project.
```APIDOC
## Introduction
This is a welcome prompt component based on the Ant Design system, used to display product identity and core value propositions to users.
## Installation
Import the component in `index.json`:
```json
"usingComponents": {
#if ALIPAY
"ant-welcome": "antd-mini/es/Welcome/index"
#endif
#if WECHAT
"ant-welcome": "antd-mini/Welcome/index"
#endif
}
```
## Basic Usage Example
```xml
```
```
--------------------------------
### Bottom Popup Example
Source: https://context7.com/ant-design/ant-design-mini/llms.txt
Display a popup that slides up from the bottom, suitable for selection lists.
```xml
Option 1Option 2Option 3
```
--------------------------------
### Basic NoticeBar Usage
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/NoticeBar/index.en.md
Demonstrates the basic usage of the NoticeBar component with different predefined types.
```xml
defaultinfoerror
```
--------------------------------
### Basic Usage
Source: https://github.com/ant-design/ant-design-mini/blob/master/src/Steps/index.md
Demonstrates the basic rendering of the Steps component using the `items` and `current` properties.
```APIDOC
## Basic Usage
### Description
Demonstrates the basic rendering of the Steps component using the `items` and `current` properties. The `items` array drives the rendering, and `current` specifies the active step. `status` can be set to `finish` or `error` for the current step.
### Endpoint
N/A (Component Usage)
### Parameters
#### Request Body (Implicit via `items` data)
- **items** (Array