Skip to content

Commit

Permalink
docs: improve English docs for ProFormFields, ProFormList and ProField
Browse files Browse the repository at this point in the history
Signed-off-by: 谢栋祥 <[email protected]>
  • Loading branch information
谢栋祥 committed Jan 16, 2025
1 parent 66490ba commit 2e9af25
Show file tree
Hide file tree
Showing 4 changed files with 425 additions and 180 deletions.
42 changes: 42 additions & 0 deletions packages/field/src/components/field.en-US.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: ProField
---

# ProField

> This component is an internal component, please do not use it directly.
It is an atomic information component that standardizes field definitions across components such as ProForm, ProTable, ProList, and Filter.

## DEMO

<code src="../demos/base.tsx" ></code>

<code src="../demos/base_test.tsx" debug></code>

<code src="../demos/search-value.tsx" debug></code>

<code src="../demos/search-value-autoClearSearchValue.tsx" debug></code>

<code src="../demos/tree-select-search-value.tsx" debug></code>

<code src="../demos/select-request.tsx" debug></code>

## API

```typescript | pure
import Field from '@ant-design/pro-field';

return <Field text="100" valueType="money" mode={state} />;
```

### Properties

| Parameters | Description | Type | Default Value |
| --- | --- | --- | --- |
| text | The value to be formatted | any | - |
| valueType | The type of formatting | ValueType | - |
| mode | The mode of the component | - | - |
| plain | Simplified mode | - | - |
| renderFormItem | Custom DOM rendering when `mode=update \| edit`, typically used for rendering input boxes | - | - |
| render | Custom DOM rendering when `mode=read`, purely for display purposes | - | - |
Loading

0 comments on commit 2e9af25

Please sign in to comment.