Skip to content

Commit 2bdc6b8

Browse files
committed
switch to major update and add details about new features and breaking changes
1 parent 718557e commit 2bdc6b8

File tree

1 file changed

+28
-8
lines changed

1 file changed

+28
-8
lines changed

.changeset/plenty-news-whisper.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,32 @@
11
---
2-
"@jspsych/plugin-survey": minor
2+
"@jspsych/plugin-survey": major
33
---
44

5-
- Updates the SurveyJS version from 1.9.138 to 2.2.0. See the SurveyJS [release notes](https://surveyjs.io/stay-updated/release-notes) and list of [breaking changes](https://surveyjs.io/stay-updated/breaking-changes).
6-
- Adds a minified version of the plugin's CSS file, survey.min.css, and loads it in the plugin example files.
7-
- In the docs and example files, updates the `button_html` parameter value from a string to a function (for `*-button-response` v2 migration).
8-
- Developer-facing changes:
9-
- Changes the SurveyJS UI package from survey-knockout-ui (removed in survey-core v2) to survey-js-ui.
10-
- Makes SurveyJS v1 -> v2 code migration changes.
5+
This release updates the SurveyJS version from 1.9.138 to 2.2.0. See the SurveyJS [release notes](https://surveyjs.io/stay-updated/release-notes) and list of [breaking changes](https://surveyjs.io/stay-updated/breaking-changes) for complete information. This update includes some bug fixes and improvements to SurveyJS that, while mostly minor, could change the appearance and functionality of existing jsPsych `survey` trials in unexpected ways. It also includes major (breaking) changes to the SurveyJS form library API that could affect users. Please test your experiments carefully when updating this plugin, and consult the SurveyJS release notes and other documentation for specifics.
6+
7+
- **New SurveyJS features**:
8+
- New slider and range slider question types.
9+
- Support for recursive question numbering.
10+
- In dynamic panels, the new `templateQuestionTitleWidth` property allows you to align question titles and input fields.
11+
- In dropdown and tag box questions, you can now allow user-defined choice options.
12+
- New loop and merge feature allows you to repeat a group of questions and combine the responses into one data object. It can be used to present a fixed set of questions, or dynamically repeat questions in response to the participant's responses.
13+
- New `round()` and `trunc()` functions that can be used for calculations in expressions.
14+
- The `dateDiff()` function now includes hours and minutes.
15+
- In checkbox questions, you can create a custom exclusive option that clears all other selected choices in the same question when selected.
16+
- **Breaking changes** that affect plugin users:
17+
- Survey element titles no longer use HTML heading tags (`<h1>`-`<h6>`). You may need to make changes if you use these tags as selectors for custom code/CSS.
18+
- Question numbering is disabled by default. If you use question numbering, you may need to add `showQuestionNumbers: true` to your top-level survey JSON, or `survey.showQuestionNumbers = true;` to your survey function.
19+
- The default logo sizes in the survey header have changed from 200 px H x 300 px W, to 40 px H x "auto" W (preserving original aspect ratio).
20+
- When multiple choice and checkbox items are presented in multiple columns, they are now laid out column-by-column instead of row-by-row.
21+
- In image picker questions, the images were previously capped in size but now fill the available space. You can set an upper limit on the image height/width with the `maxImageWidth` and `maxImageHeight` parameters.
22+
- There have been a number of form library API members (properties, methods, events) that have been [deprecated](https://surveyjs.io/stay-updated/release-notes/v2.0.0#obsolete-form-library-api) or [removed](https://surveyjs.io/stay-updated/release-notes/v2.0.0#removed-form-library-api).
23+
- **Developer-facing changes**:
24+
- SurveyJS UI package changed from survey-knockout-ui (removed in survey-core v2) to survey-js-ui (i.e. the Vanilla JS option).
25+
- SurveyJS v1 -> v2 code migration changes.
1126
- Hides a rollup build warning due to the use of top-level 'this' by SurveyJS.
12-
- Adds a `resizeObserver` mock to fix broken tests caused by SurveyJS's dependence on `resizeObserver`.
27+
- Adds a `resizeObserver` mock to fix broken tests caused by SurveyJS's dependence on `resizeObserver`.
28+
- Creates a new survey container div on the display element to render into, to fix a rendering bug introduced by the SurveyJS update.
29+
- **Other plugin changes**:
30+
- Adds a **minified version of the plugin's CSS file**, `survey.min.css`, and loads it in the plugin example files.
31+
- In the docs and example files, (1) updates the `button_html` parameter value from a string to a function (for `*-button-response` v2 migration), (2) removes `showQuestionNumbers: false`, as that is now the default.
32+
- Adds a new "slider_scale.html" example to the plugin's examples folder. Thanks @Max-Lovell!

0 commit comments

Comments
 (0)