Skip to content

Commit

Permalink
Add the "Create a Transfer List" end-user guide
Browse files Browse the repository at this point in the history
  • Loading branch information
RomanTsukanov committed Feb 28, 2024
1 parent 0b4a1ad commit c69e695
Show file tree
Hide file tree
Showing 7 changed files with 58 additions and 0 deletions.
54 changes: 54 additions & 0 deletions docs/end-user-guide-how-to-create-transfer-list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: Transfer List - SurveyJS
description: Follow the steps below to transfer a list of selected items from one question and use them as rankable choice options in another question. | SurveyJS End-User Documentation
---

# How to Create a Transfer List and Rank Selected Items

## About Transfer List

A transfer list is a form component that allows users to transfer items or options between two question areas or columns. Typically, users can move list items by selecting or dragging them. SurveyJS Form Builder allows you to implement a transfer list that sources values from any multi-select question and copies them as choice options to another question. This guide shows how to transfer items from a Tag Box question to a Ranking question.

## How to Configure the Source Question

To create a transfer list, you can use any question that supports multiple choice selection, such as Checkboxes, Dropdown, Tag Box, etc. The example below uses a Tag Box question that has an ID `"technologies"` and asks respondents to select familiar technologies from a drop-down list. The "Minimum choices to select" field ensures that users select a required number of options. "Enable the 'Select All' option" allows respondents to select all options simultaneously with a single click.

<img src="../images/eud-transfer-list-tagbox.png" alt="Tag Box question configuration" width="1299" height="724">

## How to Transfer Choices

To source selected values from one question and use them as another question's choices, follow these steps:

1. Select the question you want to populate with selected choices.
1. Under **Choice Options**, locate the **Copy choices from the following question** drop-down menu.
1. In the drop-down menu, select the ID of the source question.
1. Locate the **Which choice options to copy** property and set it to **Selected**.

In the example below, we transfer selected values from a question with an ID `"technologies"` to a Ranking question.

<img src="../images/eud-transfer-list-copy-choices.png" alt='Copy choices from a question' width="1307" height="625">

## How to Rank Selected Choices

Once you define a value source and populate a new question with selected items, you can ask your respondents to rank them. By default, the Ranking question requires users to rank all available items. If you want to allow respondents to choose items for further ranking so that they can rank all or only part of the peviously selected choices, enable selective ranking. With this setting, the Ranking question displays two areas: one for ranked and one for unranked items. To order items, respondents should first drag them from the unranked to the ranked area, as shown below.

<img src="../images/eud-transfer-list-ranking-results.png" alt='Transfer selected items to rank some of them' width="495" height="406">

To enable selective ranking, follow these steps:

1. Select a Ranking question.
1. Under its **General** settings, locate the **Allow selective ranking** checkbox and select it.
1. Optionally, you can change the position of the ranking area using the **Ranking area alignment** drop-down menu.

<img src="../images/eud-transfer-list-selective-ranking.png" alt='Selective ranking' width="342" height="442">

## Limitations

Please note that the following settings are unavailable for a question that contains transferred choices:

- "Choices"
- "Choices order"
- "Make the option visible if"
- "Make the option selectable if"

<img src="../images/eud-transfer-list-limitations.png" alt='Choice options settings' width="326" height="567">
Binary file added docs/images/eud-transfer-list-copy-choices.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/eud-transfer-list-limitations.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/eud-transfer-list-ranking-results.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/eud-transfer-list-tagbox.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions docs/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,10 @@
{
"Name": "end-user-guide-prevent-duplicate-forms-submissions",
"Title": "Prevent Duplicate Form Submissions"
},
{
"Name": "end-user-guide-how-to-create-transfer-list",
"Title": "Create a Transfer List"
}
]
},
Expand Down

0 comments on commit c69e695

Please sign in to comment.