Text Entry is a presentation component for the Adapt framework.
This component displays a text entry box which captures user input text.
The attributes listed below are used in components.json to configure Text Entry, and are properly formatted as JSON in example.json.
core model attributes: These are inherited by every Adapt component. Read more.
_component (string): This value must be: textEntry-audio.
_classes (string): CSS class name to be applied to Text Entry’s containing div. The class must be predefined in one of the Less files. Separate multiple classes with a space.
_layout (string): This defines the horizontal position of the component in the block. Acceptable values are full, left or right.
instruction (string): This optional text appears above the component. It is frequently used to guide the learner’s interaction with the component.
_recordInteraction (boolean) Determines whether or not the learner's answers will be recorded to the LMS via cmi.interactions. Default is true. For further information, see the entry for _shouldRecordInteractions in the README for adapt-contrib-spoor.
_canShowFeedback (boolean): Setting this to false disables feedback, so it is not shown to the user. The default is true.
_showUserAnswer (boolean): Setting this to true will show the user answer in the feedback popup. The default is true.
_setCompletionOn (string): Determines when the component registers as complete. Acceptable values are "submitted" and "inview".
placeholder (string): This text appears in the text entry box before the user interacts with it.
_characterLimit (object): This _characterLimit attributes group stores the properties for the maximum character length. It contains values for _isEnabled, _max, and text.
_isEnabled (boolean): Setting this to
truewill set the maximum character length specified. The default isfalse.
_max (number): This sets the character limit for the text entry box.
text (string): This defines the text to prefix the number of characters remaining.
_buttons (object): This _buttons attributes group stores the properties for the buttons. It contains values for _submit, _reset, _showFeedback, and _closeFeedback.
_submit (object): This
_submitattributes group stores the properties for the Submit button. It contains values for buttonText, and ariaLabel.
buttonText (string): Sets the text to be displayed in the Submit button.
ariaLabel (string): This text becomes the button’s
Aria labelattribute.
_showFeedback (object): This
_showFeedbackattributes group stores the properties for the Feedback button. It contains values for buttonText, and ariaLabel.
buttonText (string): Sets the text to be displayed in the Feedback button.
ariaLabel (string): This text becomes the button’s
Aria labelattribute.
_closeFeedback (object): This
_closeFeedbackattributes group stores the properties for the Close Feedback button. It contains values for buttonText, and ariaLabel.
buttonText (string): Sets the text to be displayed in the Close Feedback button.
ariaLabel (string): This text becomes the button’s
Aria labelattribute.
_feedback (object): This _feedback attributes group stores the properties for the feedback. It contains values for title, answerTitle, userTitle, body and _audio.
title (string): Sets the title for the feedback.
answerTitle (string): Sets the title for the correct answer.
userTitle (string): Sets the title for the user answer.
body (string): Sets the text for the correct answer.
_audio (object): This
_audioattributes group stores the properties for the audio. It contains values for src.
src (string): File name (including path) of the audio for the item. Path should be relative to the src folder.
Several elements of Text Entry have been assigned a label using the aria-label attribute: Text Entry. These labels are not visible elements. They are utilized by assistive technology such as screen readers.
No known limitations.
Version number: 5.2.0
Framework versions supported: 5.8+
Author / maintainer: DeltaNet with contributors
Accessibility support: yes
RTL support: yes
Authoring tool support: Yes