1
0
mirror of https://github.com/psychopy/psychojs.git synced 2025-05-10 10:40:54 +00:00
psychojs/src/visual/survey/SelectBox.js
2022-11-22 10:37:20 +01:00

120 lines
4.8 KiB
JavaScript

/**
* @desc SelectBox widget for surveyJS.
* @type: SurveyJS widget.
*/
export default function init (Survey) {
var widget = {
//the widget name. It should be unique and written in lowcase.
name: "selectbox",
//the widget title. It is how it will appear on the toolbox of the SurveyJS Editor/Builder
title: "My custom widg",
//the name of the icon on the toolbox. We will leave it empty to use the standard one
iconName: "",
//If the widgets depends on third-party library(s) then here you may check if this library(s) is loaded
widgetIsLoaded: function () {
//return typeof $ == "function" && !!$.fn.select2; //return true if jQuery and select2 widget are loaded on the page
return true; //we do not require anything so we just return true.
},
//SurveyJS library calls this function for every question to check, if it should use this widget instead of default rendering/behavior
isFit: function (question) {
//we return true if the type of question is selectbox
return question.getType() === 'selectbox';
//the following code will activate the widget for a text question with inputType equals to date
//return question.getType() === 'text' && question.inputType === "date";
},
//Use this function to create a new class or add new properties or remove unneeded properties from your widget
//activatedBy tells how your widget has been activated by: property, type or customType
//property - it means that it will activated if a property of the existing question type is set to particular value, for example inputType = "date"
//type - you are changing the behaviour of entire question type. For example render radiogroup question differently, have a fancy radio buttons
//customType - you are creating a new type, like in our example "selectbox"
activatedByChanged: function (activatedBy) {
//we do not need to check acticatedBy parameter, since we will use our widget for customType only
//We are creating a new class and derived it from text question type. It means that text model (properties and fuctions) will be available to us
Survey.JsonObject.metaData.addClass("selectbox", [], null, "text");
//signaturepad is derived from "empty" class - basic question class
//Survey.JsonObject.metaData.addClass("signaturepad", [], null, "empty");
//Add new property(s)
//For more information go to https://surveyjs.io/Examples/Builder/?id=addproperties#content-docs
Survey.JsonObject.metaData.addProperties("selectbox", [
{
name: "choices",
default: []
}
]);
},
//If you want to use the default question rendering then set this property to true. We do not need any default rendering, we will use our our htmlTemplate
isDefaultRender: false,
//You should use it if your set the isDefaultRender to false
htmlTemplate: `<div><select class="srv-select-multiple" multiple></select></div>`,
//The main function, rendering and two-way binding
afterRender: function (question, el) {
let optionsHTML = "";
let i;
for (i = 0; i < question.choices.length; i++)
{
optionsHTML += `<option value="${question.choices[i].value}">${question.choices[i].text}</option>`;
}
let selectDOM = el.querySelector("select");
selectDOM.innerHTML = optionsHTML;
selectDOM.addEventListener('input', (e) => {
let i;
let opts = new Array(e.currentTarget.selectedOptions.length);
for (i = 0; i < e.currentTarget.selectedOptions.length; i++)
{
opts[i] = e.currentTarget.selectedOptions[i].value;
}
question.value = opts;
});
// var onValueChangedCallback = function () {
// text.value = question.value ? question.value : "";
// }
// var onReadOnlyChangedCallback = function() {
// if (question.isReadOnly) {
// text.setAttribute('disabled', 'disabled');
// button.setAttribute('disabled', 'disabled');
// } else {
// text.removeAttribute("disabled");
// button.removeAttribute("disabled");
// }
// };
//if question becomes readonly/enabled add/remove disabled attribute
// question.readOnlyChangedCallback = onReadOnlyChangedCallback;
//if the question value changed in the code, for example you have changed it in JavaScript
// question.valueChangedCallback = onValueChangedCallback;
//set initial value
// onValueChangedCallback();
//make elements disabled if needed
// onReadOnlyChangedCallback();
},
//Use it to destroy the widget. It is typically needed by jQuery widgets
willUnmount: function (question, el) {
//We do not need to clear anything in our simple example
//Here is the example to destroy the image picker
//var $el = $(el).find("select");
//$el.data('picker').destroy();
}
}
//Register our widget in singleton custom widget collection
Survey.CustomWidgetCollection.Instance.addCustomWidget(widget, "customtype");
}