From bbdac4afa491311503385e3542590f7c8c0ba01f Mon Sep 17 00:00:00 2001 From: Becky Gilbert Date: Fri, 1 Nov 2024 15:19:17 -0700 Subject: [PATCH] Add `locale` to `survey` docs (#102) --- .changeset/purple-phones-count.md | 6 ++++++ packages/record/README.md | 4 ++-- packages/surveys/README.md | 22 ++++++++++++++++++++++ 3 files changed, 30 insertions(+), 2 deletions(-) create mode 100644 .changeset/purple-phones-count.md diff --git a/.changeset/purple-phones-count.md b/.changeset/purple-phones-count.md new file mode 100644 index 0000000..e9cbd7c --- /dev/null +++ b/.changeset/purple-phones-count.md @@ -0,0 +1,6 @@ +--- +"@lookit/surveys": patch +"@lookit/record": patch +--- + +Documentation update: add/modify locale parameter documentation. diff --git a/packages/record/README.md b/packages/record/README.md index a5468a4..290b127 100644 --- a/packages/record/README.md +++ b/packages/record/README.md @@ -9,8 +9,8 @@ either a single trial or multiple trials. Optional parameter to set a two-letter language code for translation. In some cases, a regional code will have to be provided as well. For example, we -currently support english only from the US region. Therefore, to get the US -english translation you would put "en-US" for the locale. We support the +currently support English only from the US region. Therefore, to get the US +English translation you would put "en-US" for the locale. We support the following language codes: | Language | Region | Code | diff --git a/packages/surveys/README.md b/packages/surveys/README.md index 9ccb86c..5d51bcc 100644 --- a/packages/surveys/README.md +++ b/packages/surveys/README.md @@ -4,6 +4,28 @@ This package contains the custom surveys provided by CHS for jsPsych studies. These surveys are built off of the very nice [jsPsych Survey plugin]({{ jsPsych }}plugins/survey/). +## Parameters available in all plugins + +**`locale` [String | "en-us"]** + +Optional parameter to set a two-letter language code for translation. In some +cases, a regional code will have to be provided as well. For example, we +currently support English only from the US region. Therefore, to get the US +English translation you would put "en-US" for the locale. We support the +following language codes: + +| Language | Region | Code | +| -------------- | ------ | ----- | +| Basque | | eu | +| Dutch, Flemish | | nl | +| English | U.S.A. | en-US | +| French | | fr | +| Hungarian | | hu | +| Italian | | it | +| Japanese | | ja | +| Portuguese | Brazil | pt-BR | +| Portuguese | | pt | + ## Consent Survey The Consent Survey will will give you two things out of the box: