Skip to content

jamesrea83/adapt-d3

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

adapt-contrib-text

Text is a presentation component bundled with the Adapt framework.

sample text component

Text's simple purpose is to present text. The text may include HTML.

Visit the Text wiki for more information about its functionality and for explanations of key properties.

Installation

As one of Adapt's core components, Text is included with the installation of the Adapt framework and the installation of the Adapt authoring tool.

  • If Text has been uninstalled from the Adapt framework, it may be reinstalled. With the Adapt CLI installed, run the following from the command line:
    adapt install adapt-contrib-text

    Alternatively, this component can also be installed by adding the following line of code to the adapt.json file:
    "adapt-contrib-text": "*"
    Then running the command:
    adapt install
    (This second method will reinstall all plug-ins listed in adapt.json.)

  • If Text has been uninstalled from the Adapt authoring tool, it may be reinstalled using the Plug-in Manager.

Settings Overview

The attributes listed below are used in components.json to configure Text, and are properly formatted as JSON in example.json. Visit the Text wiki for more information about how they appear in the authoring tool.

Attributes

core model attributes: These are inherited by every Adapt component. Read more.

_component (string): This value must be: text.

_classes (string): CSS class name to be applied to Text’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.

title (string): A reference title for the component. title is distinct from the displayTitle which, if present, appears above the component. title provides the opportunity to use a shortened form in tighter spaces, such as in menus or in the drawer.

displayTitle (string): Optional text that will display as a title or header above the component. It can be used as a headline.

instruction (string): This optional text appears above the component. It is frequently used to guide the learner’s interaction with the component.

body (string): Although optional, this text constitutes what is thought of as the primary text of the Text component. HTML is permitted.

Limitations

No known limitations.


Version number: 2.0.3 adapt learning logo Framework versions: 2+
Author / maintainer: Adapt Core Team with contributors
Accessibility support: WAI AA
RTL support: yes
Cross-platform coverage: Chrome, Chrome for Android, Firefox (ESR + latest version), Edge 12, IE 11, IE10, IE9, IE8, IE Mobile 11, Safari iOS 9+10, Safari OS X 9+10, Opera

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published