From 90ca800b72bd1cdb35f28c288b9acadfc6bb0fb4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Robles?= Date: Wed, 20 Sep 2023 03:15:35 -0500 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20Support=20search/filter=20candidate?= =?UTF-8?q?s=20feature=20in=20voting=20booth=20(#132)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Parent issue: https://github.com/sequentech/meta/issues/126 --- .../reference/election-creation-json.md | 25 +++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/docs/general/reference/election-creation-json.md b/docs/general/reference/election-creation-json.md index da1c1a4..947da4e 100644 --- a/docs/general/reference/election-creation-json.md +++ b/docs/general/reference/election-creation-json.md @@ -3367,6 +3367,31 @@ However if `answer_group_columns_size` is set to `6` and the half of the screen, appearing side by side in pairs. And within each category, each answer will use the full width of the category. +### Question Extra: `show_filter_field` + +- **Property name**: `show_filter_field` +- **Type:** `Boolean` +- **Required:** No +- **Default:** `false` +- **Example:** `true` + +If set to `true`, it adds a search/filter field to the left of the question title +in the voting booth's candidates selection screen. By default, if unset, its +value is `false`. + +Voters will be able to filter candidates using the search field. The search string +can contain asterisks `*`. An asterisk will match zero or more characters. The search +will only show options that partially match with the search string, either on the +category, text or details of the option. The search ignores casing and tildes. + +For example searching with the string `john*kennedy` on the text +`Sir John F. Kennedy Jr` will be a partial match, whereas if the search string +was `John Kennedy` the search wouldn't match at all. + +If there's a partial match with the category, all options within the category will +be shown. The results of the search will always be shown in one column, regardless of +the column configuration for the question. + ## WriteInConfig Object The JSON object type describes the Write-In configuration in a question. It used inside the