You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The following snippet shows how to config device restrictions:
15
+
:::note
16
+
`minWidth` and `minHeight` are now configured under `studyRules.display` instead of `uiConfig`.
17
+
18
+
The previous properties `minWidthSize` and `minHeightSize` have been renamed to `minWidth` and `minHeight`. The `minWidthSize` and `minHeightSize` property is now removed and should no longer be used.
19
+
:::
20
+
21
+
The following snippet shows how to configure device restrictions:
16
22
17
23
```json title="public/study-name/config.json"
18
24
"studyRules": {
@@ -51,15 +57,33 @@ The following snippet shows how to config device restrictions:
51
57
When a participant starts the study, reVISit validates the participant environment against `studyRules`.
52
58
If requirements are not met, a blocking screen is shown with the rule that failed.
53
59
60
+
## Setting Display Requirements
61
+
62
+
You can restrict your study to specific screen-size requirements to ensure participants use a supported display.
63
+
64
+
Configure display restrictions in the `studyRules` section. Use `studyRules.display` to define minimum and optional maximum screen dimensions.
65
+
66
+
```json title="public/study-name/config.json"
67
+
"studyRules": {
68
+
"display": {
69
+
"minHeight": 600,
70
+
"minWidth": 1024,
71
+
"maxHeight": 1440,
72
+
"maxWidth": 2560,
73
+
"blockedMessage": "This study requires a screen between 1024x600 and 2560x1440."
74
+
}
75
+
}
76
+
```
77
+
54
78
For display-size checks, participants see a warning screen with a one-minute countdown timer showing current and required dimensions.
55
79
56
80
The participant has one minute to resize their browser window. During this time, reVISit continuously monitors the window size. Once both the width and height meet the requirements, the warning disappears and the study begins.
57
81
58
82
If the timer runs out and the screen is still too small, the participant will see a training failed page and will not be able to continue the study.
59
83
60
-
In the participant table, the participant will be listed as rejected with the reason "Screen resolution too small."
84
+
In the participant table, the participant will be listed as rejected with the reason "Screen resolution requirements not met."
0 commit comments