Skip to content

Commit

Permalink
feat(core): support index/indexes properties (#2769)
Browse files Browse the repository at this point in the history
  • Loading branch information
@janryWang
janryWang authored Jan 18, 2022
1 parent bff1b29 commit 36143ef
Show file tree
Hide file tree
Showing 8 changed files with 125 additions and 108 deletions.
96 changes: 49 additions & 47 deletions packages/core/docs/api/models/Field.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,53 +10,55 @@ All model attributes are listed below. If the attribute is writable, then we can

## Attributes

| Property | Description | Type | Read-only or not | Default value |
| -------------- | ------------------------------------------------- | -------------------------------------------------- | ---------------- | ------------- |
| initialized | Has the field been initialized | Boolean | No | `false` |
| mounted | Is the field mounted | Boolean | No | `false` |
| unmounted | Is the field unmounted | Boolean | No | `false` |
| address | Field node path | [FormPath](/api/entry/form-path) | Yes | |
| path | Field data path | [FormPath](/api/entry/form-path) | Yes | |
| title | Field Title | [FieldMessage](#fieldmessage) | No | `""` |
| description | Field description | [FieldMessage](#fieldmessage) | No | `""` |
| loading | Field loading status | Boolean | No | `false` |
| validating | Is the field being validated | Boolean | No | `false` |
| modified | Whether the field tree has been manually modified | Boolean | No | `false` |
| selfModified | Whether the field has been manually modified | Boolean | No | `false` |
| active | Is the field active | Boolean | No | `false` |
| visited | Whether the field has been visited | Boolean | No | `false` |
| inputValue | Field input value | Any | No | `null` |
| inputValues | Field input value collection | Array | No | `[]` |
| dataSource | Field data source | Array | No | `[]` |
| validator | Field validator | [FieldValidator](#fieldvalidator) | No | `null` |
| decorator | field decorator | Any[] | No | `null` |
| component | Field component | Any[] | No | `null` |
| feedbacks | Field feedback information | [IFieldFeedback](#ifieldfeedback)[] | No | `[]` |
| parent | Parent field | [GeneralField](#generalfield) | yes | `null` |
| errors | Field all error message(include children) | [IFormFeedback](/api/models/form/#iformfeedback)[] | Yes | `[]` |
| warnings | Field all warning message(include children) | [IFormFeedback](/api/models/form/#iformfeedback)[] | Yes | `[]` |
| successes | Field all success message(include children) | [IFormFeedback](/api/models/form/#iformfeedback)[] | Yes | `[]` |
| valid | Is the all field valid(include children) | Boolean | Yes | `true` |
| invalid | Is the all field illegal(include children) | Boolean | Yes | `false` |
| value | Field value | Any | No | |
| initialValue | Field default value | Any | No | |
| display | Field display status | [FieldDisplayTypes](#fielddisplaytypes) | No | `"visible"` |
| pattern | Field interaction mode | [FieldPatternTypes](#fieldpatterntypes) | No | `"editable"` |
| required | Is the field required | Boolean | No | `false` |
| hidden | Whether the field is hidden | Boolean | No | `false` |
| visible | Whether the field is displayed | Boolean | No | `true` |
| disabled | Whether the field is disabled | Boolean | No | `false` |
| readOnly | Is the field read-only | Boolean | No | `false` |
| readPretty | Whether the field is in the reading state | Boolean | No | `false` |
| editable | Field is editable | Boolean | No | `true` |
| validateStatus | Field validation status | [FieldValidateStatus](#fieldvalidatestatus) | yes | `null` |
| content | Field content, usually as a child node | any | No | `null` |
| data | Field extends properties | Object | No | `null` |
| selfErrors | Field own error message | [FieldMessage](#fieldmessage)[] | No | `[]` |
| selfWarnings | Field own warning message | [FieldMessage](#fieldmessage)[] | No | `[]` |
| selfSuccesses | Success message of the field itself | [FieldMessage](#fieldmessage)[] | No | `[]` |
| selfValid | Is the field valid | Boolean | Yes | `true` |
| selfInvalid | Is the field itself illegal | Boolean | Yes | `false` |
| Property | Description | Type | Read-only or not | Default value |
| -------------- | --------------------------------------------------- | -------------------------------------------------- | ---------------- | ------------- |
| initialized | Has the field been initialized | Boolean | No | `false` |
| mounted | Is the field mounted | Boolean | No | `false` |
| unmounted | Is the field unmounted | Boolean | No | `false` |
| address | Field node path | [FormPath](/api/entry/form-path) | Yes | |
| path | Field data path | [FormPath](/api/entry/form-path) | Yes | |
| title | Field Title | [FieldMessage](#fieldmessage) | No | `""` |
| description | Field description | [FieldMessage](#fieldmessage) | No | `""` |
| loading | Field loading status | Boolean | No | `false` |
| validating | Is the field being validated | Boolean | No | `false` |
| modified | Whether the field tree has been manually modified | Boolean | No | `false` |
| selfModified | Whether the field has been manually modified | Boolean | No | `false` |
| active | Is the field active | Boolean | No | `false` |
| visited | Whether the field has been visited | Boolean | No | `false` |
| inputValue | Field input value | Any | No | `null` |
| inputValues | Field input value collection | Array | No | `[]` |
| dataSource | Field data source | Array | No | `[]` |
| validator | Field validator | [FieldValidator](#fieldvalidator) | No | `null` |
| decorator | field decorator | Any[] | No | `null` |
| component | Field component | Any[] | No | `null` |
| feedbacks | Field feedback information | [IFieldFeedback](#ifieldfeedback)[] | No | `[]` |
| parent | Parent field | [GeneralField](#generalfield) | yes | `null` |
| errors | Field all error message(include children) | [IFormFeedback](/api/models/form/#iformfeedback)[] | Yes | `[]` |
| warnings | Field all warning message(include children) | [IFormFeedback](/api/models/form/#iformfeedback)[] | Yes | `[]` |
| successes | Field all success message(include children) | [IFormFeedback](/api/models/form/#iformfeedback)[] | Yes | `[]` |
| valid | Is the all field valid(include children) | Boolean | Yes | `true` |
| invalid | Is the all field illegal(include children) | Boolean | Yes | `false` |
| value | Field value | Any | No | |
| initialValue | Field default value | Any | No | |
| display | Field display status | [FieldDisplayTypes](#fielddisplaytypes) | No | `"visible"` |
| pattern | Field interaction mode | [FieldPatternTypes](#fieldpatterntypes) | No | `"editable"` |
| required | Is the field required | Boolean | No | `false` |
| hidden | Whether the field is hidden | Boolean | No | `false` |
| visible | Whether the field is displayed | Boolean | No | `true` |
| disabled | Whether the field is disabled | Boolean | No | `false` |
| readOnly | Is the field read-only | Boolean | No | `false` |
| readPretty | Whether the field is in the reading state | Boolean | No | `false` |
| editable | Field is editable | Boolean | No | `true` |
| validateStatus | Field validation status | [FieldValidateStatus](#fieldvalidatestatus) | yes | `null` |
| content | Field content, usually as a child node | any | No | `null` |
| data | Field extends properties | Object | No | `null` |
| selfErrors | Field own error message | [FieldMessage](#fieldmessage)[] | No | `[]` |
| selfWarnings | Field own warning message | [FieldMessage](#fieldmessage)[] | No | `[]` |
| selfSuccesses | Success message of the field itself | [FieldMessage](#fieldmessage)[] | No | `[]` |
| selfValid | Is the field valid | Boolean | Yes | `true` |
| selfInvalid | Is the field itself illegal | Boolean | Yes | `false` |
| indexes | collection of field numeric indexes | Number | yes | `-` |
| index | field numeric index, take the last index of indexes | Number | Yes | `-` |

#### explain in detail

Expand Down
Loading

0 comments on commit 36143ef

Please sign in to comment.