diff --git a/docs/en-US/component/transfer.md b/docs/en-US/component/transfer.md index 873d76e9ff..4e2ea5f451 100644 --- a/docs/en-US/component/transfer.md +++ b/docs/en-US/component/transfer.md @@ -43,9 +43,9 @@ transfer/prop-alias ::: -## API +## Transfer API -### Attributes +### Transfer Attributes | Name | Description | Type | Default | | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | -------- | @@ -64,7 +64,7 @@ transfer/prop-alias | right-default-checked | key array of initially checked data items of the right list | ^[object]`Array` | [] | | validate-event | whether to trigger form validation | ^[boolean] | true | -### Events +### Transfer Events | Name | Description | Type | | ------------------ | ----------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | @@ -72,7 +72,7 @@ transfer/prop-alias | left-check-change | triggers when end user changes the checked state of any data item in the left list | ^[Function]`(value: TransferKey[], movedKeys?: TransferKey[]) => void` | | right-check-change | triggers when end user changes the checked state of any data item in the right list | ^[Function]`(value: TransferKey[], movedKeys?: TransferKey[]) => void` | -### Slots +### Transfer Slots | Name | Description | | ------------ | ------------------------------------------------------------------ | @@ -80,11 +80,21 @@ transfer/prop-alias | left-footer | content of left list footer | | right-footer | content of right list footer | -### Exposes +### Transfer Exposes -| Method | Description | Type | +| Name | Description | Type | | ---------- | ------------------------------------------- | ----------------------------------------------- | | clearQuery | clear the filter keyword of a certain panel | ^[Function]`(which: TransferDirection) => void` | +| leftPanel | left panel ref | ^[object]`Ref` | +| rightPanel | right panel ref | ^[object]`Ref` | + +## Transfer Panel API + +### Transfer Panel Exposes + +| Name | Description | Type | +| ----- | -------------- | --------- | +| query | filter keyword | ^[string] | ## Type Declarations diff --git a/packages/components/transfer/src/transfer.vue b/packages/components/transfer/src/transfer.vue index 95072ded51..325aa2bbf5 100644 --- a/packages/components/transfer/src/transfer.vue +++ b/packages/components/transfer/src/transfer.vue @@ -158,7 +158,7 @@ defineExpose({ clearQuery, /** @description left panel ref */ leftPanel, - /** @description left panel ref */ + /** @description right panel ref */ rightPanel, })