Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
RobertPeek authored Jul 19, 2017
1 parent 25229bd commit 8c0dcb4
Showing 1 changed file with 43 additions and 2 deletions.
45 changes: 43 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,47 @@
#adapt-textEntry-audio
# adapt-textEntry-audio

A very simple text entry component.
**Text Entry** is a *presentation component* for the [Adapt framework](https://github.com/adaptlearning/adapt_framework).

This component displays a simple text entry box with no tracking or data saving.

## Settings Overview

The attributes listed below are used in *components.json* to configure **Text Entry**, and are properly formatted as JSON in [*example.json*](https://github.com/deltanet/adapt-textEntry-audio/blob/master/example.json).

### Attributes

[**core model attributes**](https://github.com/adaptlearning/adapt_framework/wiki/Core-model-attributes): These are inherited by every Adapt component. [Read more](https://github.com/adaptlearning/adapt_framework/wiki/Core-model-attributes).

**_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.

**placeholder** (string): This text appears in the text entry box before the user interacts with it.

**_buttons** (object): This `_buttons` attributes group stores the properties for the buttons. It contains values for **_submit**, and **_showFeedback**.

>**_submit** (object): This `_submit` attributes 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 label` attribute.
>**_showFeedback** (object): This `_showFeedback` attributes 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 label` attribute.
## Accessibility
Several elements of **Toolbox** have been assigned a label using the [aria-label](https://github.com/adaptlearning/adapt_framework/wiki/Aria-Labels) attribute: **Toolbox**. These labels are not visible elements. They are utilized by assistive technology such as screen readers.

## Limitations

No known limitations.

----------------------------
**Version number:** 3.0.6
Expand Down

0 comments on commit 8c0dcb4

Please sign in to comment.