ohayolibs
Version:
Ohayo is a set of essential modules for ohayojp.
39 lines (30 loc) • 1.73 kB
Markdown
---
title: transfer
subtitle: Transfer
type: Widgets
---
Double column transfer choice box.
## Note
- `default` value `direction: 'right'` indicates right column.
## API
### schema
| Property | Description | Type | Default |
|----------|-------------|------|---------|
| `[enum]` | Data source | `SFSchemaEnumType[]` | - |
### ui
| Property | Description | Type | Default |
|----------|-------------|------|---------|
| `[asyncData]` | Asynchronous data | `() => Observable<SFSchemaEnumType[]>` | - |
| `[titles]` | Title list, the order is from left to right | `string[]` | `['', '']` |
| `[operations]` | Operation list, the order is from top to buttom | `string[]` | `['', '']` |
| `[listStyle]` | A custom CSS style used for rendering the transfer columns. equals to `ngStyle` | `object` | - |
| `[itemUnit]` | single unit | `string` | `item` |
| `[itemsUnit]` | multiple unit | `string` | `items` |
| `[showSearch]` | If included, a search box is shown on each column | `boolean` | `false` |
| `[filterOption]` | Accept `inputValueoption` two parameters, return `true` when `option` matches, otherwise, return `false` | - | - |
| `[searchPlaceholder]` | Placeholder of search box | `string` | - |
| `[notFoundContent]` | Text to display when a column is empty | `string` | - |
| `[canMove]` | Second verification when transfer choice box | `function` | - |
| `[change]` | Callback function when the transfer between columns is complete | `(options: TransferChange) => void` | - |
| `[searchChange]` | Callback function when search field is changed | `(options: TransferSearchChange) => void` | - |
| `[selectChange]` | Callback function when selected items are changed | `(options: TransferSelectChange) => void` | - |