The following table provides details for the config settings available for the widget.
| Property Name |
Description |
Possible Values |
moduleTitle
|
To create content for the Welcome Window widget, a module must be created along with the content topics to be used. moduleTitle is the name of the module the widget will grab its content from.
Note: The default module title used is “Welcome” and supports automatic language switching of English, French, Spanish and Brazilian Portuguese. If the language for a course is set to any of these localizations, the widget will use the translated word “Welcome” to locate the proper module. If moduleTitle is set to a custom string, then what is set in the config file for moduleTitle is used without the support of automatic switching of alternative languages.
moduleTitle does not have to match the name of the module entirely and can use keywords that exist in the module title. For example, you can use “Welcome” or “Welcome to…” in the module’s title and it would still be able to identify which module to use.
|
String, surrounded in quotes, matching the file name. E.g., “Welcome”
Default: “Welcome”
|
buttonText
|
A widget with a launch button is located on the homepage that allows you to open the pop-up window if a user had previously dismissed it and would like to revisit the content. buttonText allows you to change the text displayed in the launch button. |
String, surrounded in quotes, matching the filename. E.g., “Launch the Quick Guide”
Default: "Launch the Quick Guide"
Other examples:
“Begin Orientation”
“Launch Welcome”
|
introText
|
A space is provided above the launch button to provide some introduction or instruction text. |
String, surrounded in quotes, matching the filename.
E.g., “Welcome to the course”
Default: “Welcome to the course!”
|
background
|
This allows you to customize the background image that appears in the header when the pop-up window is showing.
A default image is added in the following folder path in Shared Files. “/custom_widgets/welcome/img”
To change the image across multiple org units, upload your image to the “/custom_widgets/welcome/img” folder in Shared Files and add the URL linking to the image for the background property in the config file.
If you want to change it for an individual course, then when you have copied over the “/custom_widgets/welcome” folder to Manage Files for the course, add the image to an “img” folder and add the URL linking to the image for the background property in the config file.
The image size recommendation is approximately 1152px by 148px
|
Example of Manage Files URL:
“/content/enforced/{course_folder_name}/custom_widgets/welcome/img/image.jpg”
Example of Shared Files URL:
“/shared/custom_widgets/welcome/img/image.jpg”
|
showDefaultContent
|
Setting this property to true will allow the widget to show the pop-up window with the default content if there is no custom content provided in the course. |
Boolean.
Default: true
|
forceDismiss
|
Setting this property to true will remove the close button at the top right of the pop-up. This will ensure that the user must go through all the content to click on the Dismiss button. |
Boolean.
Default: false
|