Skip to content

Main properties

Aldo edited this page Mar 14, 2018 · 2 revisions

When using the RESCORM boilerplate to create an educational application, several properties are available to the React components. This page describes such properties.

The Quiz application provided as an example in the boilerplate has a Quiz component which is created as follows in the /components/App.jsx file:

<Quiz dispatch={this.props.dispatch} user_profile={this.props.user_profile} tracking={this.props.tracking} config={GLOBAL_CONFIG} I18n={I18n} quiz={SAMPLES.quiz_example}/>

Next, each of the properties provided to this component is described:

Property Name Description
dispatch The dispatcher is passed as a property in order to allow the components to dispatch actions on their own.
user_profile The profile of the user obtained through the SCORM API. See this table for further details.
tracking Tracking of the user. See this table for further details.
config The global config of the React application. See this section for further details.
I18n A module that provides internationalization (i18n) support.

Field Name Description
id Identifier of the user.
name A string with the name of the user.
learner_preference A hash with the preferences of the user.
learner_preference[difficulty] The difficulty preferred by the user. This parameter, if exists, should be a value from 0 to 10.

Field Name Description
progress_measure A measure of the progress the learner has made towards completing the application. Further details are available here.
score The learner score or grade for the application. Further details are available here.
objectives A hash with the objectives registered in the application. See this for further details.
finished A boolean value that indicates whether the application has been finished.