-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
11 changed files
with
414 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
"@jspsych-contrib/plugin-survey-number": major | ||
--- | ||
|
||
New plugin for displaying a survey question and getting a numeric response |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# survey-number | ||
|
||
## Overview | ||
|
||
Collects a number response in a text box | ||
|
||
## Loading | ||
|
||
### In browser | ||
|
||
```js | ||
<script src="https://unpkg.com/@jspsych-contrib/[email protected]"> | ||
``` | ||
|
||
### Via NPM | ||
|
||
``` | ||
npm install @jspsych-contrib/plugin-survey-number | ||
``` | ||
|
||
```js | ||
import jsPsychSurveyNumber from '@jspsych-contrib/plugin-survey-number'; | ||
``` | ||
|
||
## Compatibility | ||
|
||
jsPsych 7.0.0 | ||
|
||
## Documentation | ||
|
||
See [documentation](https://github.com/jspsych/jspsych-contrib/blob/main/packages/plugin-survey-number/docs/jspsych-survey-number.md) | ||
|
||
## Author / Citation | ||
|
||
Josh de Leeuw |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# survey-number | ||
|
||
Collects a number response in a text box | ||
|
||
## Parameters | ||
|
||
In addition to the [parameters available in all plugins](https://jspsych.org/latest/overview/plugins.md#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of undefined must be specified. Other parameters can be left unspecified if the default value is acceptable. | ||
|
||
| Parameter | Type | Default Value | Description | | ||
| ------------------- | ---------------- | ------------------ | ---------------------------------------- | | ||
| | | | | | ||
|
||
## Data Generated | ||
|
||
In addition to the [default data collected by all plugins](https://jspsych.org/latest/overview/plugins.md#data-collected-by-all-plugins), this plugin collects the following data for each trial. | ||
|
||
| Name | Type | Value | | ||
| --------- | ------- | ---------------------------------------- | | ||
| | | | | ||
|
||
## Install | ||
|
||
Using the CDN-hosted JavaScript file: | ||
|
||
```js | ||
<script src="https://unpkg.com/@jspsych-contrib/plugin-survey-number"></script> | ||
``` | ||
|
||
Using the JavaScript file downloaded from a GitHub release dist archive: | ||
|
||
```js | ||
<script src="jspsych/plugin-survey-number.js"></script> | ||
``` | ||
|
||
Using NPM: | ||
|
||
``` | ||
npm install @jspsych-contrib/plugin-survey-number | ||
``` | ||
|
||
```js | ||
import SurveyNumber from '@jspsych-contrib/plugin-survey-number'; | ||
``` | ||
|
||
## Examples | ||
|
||
### Title of Example | ||
|
||
```javascript | ||
var trial = { | ||
type: jsPsychSurveyNumber | ||
} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
<!DOCTYPE html> | ||
<html> | ||
<head> | ||
<script src="https://unpkg.com/jspsych"></script> | ||
<script src="../dist/index.browser.js"></script> | ||
<link href="https://unpkg.com/jspsych/css/jspsych.css" rel="stylesheet" type="text/css"> | ||
</head> | ||
<body></body> | ||
<script> | ||
const jsPsych = initJsPsych(); | ||
|
||
const trial = { | ||
type: jsPsychSurveyNumber, | ||
questions: [{ | ||
prompt: 'How old are you?', | ||
name: 'age', | ||
required: true, | ||
}] | ||
} | ||
|
||
jsPsych.run([trial]); | ||
</script> | ||
</html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
module.exports = require("@jspsych/config/jest").makePackageConfig(__dirname); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
{ | ||
"name": "@jspsych-contrib/plugin-survey-number", | ||
"version": "0.0.1", | ||
"description": "Collects a number response in a text box", | ||
"type": "module", | ||
"main": "dist/index.cjs", | ||
"exports": { | ||
"import": "./dist/index.js", | ||
"require": "./dist/index.cjs" | ||
}, | ||
"typings": "dist/index.d.ts", | ||
"unpkg": "dist/index.browser.min.js", | ||
"files": [ | ||
"src", | ||
"dist" | ||
], | ||
"source": "src/index.ts", | ||
"scripts": { | ||
"test": "jest", | ||
"test:watch": "npm test -- --watch", | ||
"tsc": "tsc", | ||
"build": "rollup --config", | ||
"build:watch": "npm run build -- --watch" | ||
}, | ||
"repository": { | ||
"type": "git", | ||
"url": "git+https://github.com/jspsych/jspsych-contrib.git", | ||
"directory": "packages/plugin-survey-number" | ||
}, | ||
"author": "Josh de Leeuw", | ||
"license": "MIT", | ||
"bugs": { | ||
"url": "https://github.com/jspsych/jspsych-contrib/issues" | ||
}, | ||
"homepage": "https://github.com/jspsych/jspsych-contrib/tree/main/packages/plugin-survey-number", | ||
"peerDependencies": { | ||
"jspsych": ">=7.0.0" | ||
}, | ||
"devDependencies": { | ||
"@jspsych/config": "^2.0.0", | ||
"@jspsych/test-utils": "^1.0.0", | ||
"jspsych": "^7.0.0" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
import { makeRollupConfig } from "@jspsych/config/rollup"; | ||
|
||
export default makeRollupConfig("jsPsychSurveyNumber"); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
import { startTimeline } from "@jspsych/test-utils"; | ||
|
||
import jsPsychSurveyNumber from "."; | ||
|
||
jest.useFakeTimers(); | ||
|
||
describe("my plugin", () => { | ||
it("should load", async () => { | ||
const { expectFinished, getHTML, getData, displayElement, jsPsych } = await startTimeline([ | ||
{ | ||
type: jsPsychSurveyNumber, | ||
parameter_name: 1, | ||
parameter_name2: "img.png", | ||
}, | ||
]); | ||
|
||
await expectFinished(); | ||
}); | ||
}); |
Oops, something went wrong.