-
Notifications
You must be signed in to change notification settings - Fork 0
graphic RDME
❗ Do not edit here. Edit the README in the repo. ❗
Graphic is a presentation component bundled with the Adapt framework.
Graphic displays graphic content that has been optimized for various devices. The component swaps out images based upon the device's screen size. These device widths are specified in less/generic.less of the Vanilla theme.
Visit the Graphic wiki for more information about its functionality and for explanations of key properties.
##Installation
As one of Adapt's core components, Graphic is included with the installation of the Adapt framework and the installation of the Adapt authoring tool.
-
If Graphic 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-graphic
Alternatively, this component can also be installed by adding the following line of code to the adapt.json file:
"adapt-contrib-graphic": "*"
Then running the command:
adapt install
(This second method will reinstall all plug-ins listed in adapt.json.) -
If Graphic has been uninstalled from the Adapt authoring tool, it may be reinstalled using the Plug-in Manager.
The attributes listed below are used in components.json to configure Graphic, and are properly formatted as JSON in example.json. Visit the Graphic wiki for more information about how they appear in the authoring tool.
core model attributes: These are inherited by every Adapt component. Read more.
_component (string): This value must be: graphic
.
_classes (string): CSS class name to be applied to Graphic’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.
_graphic (object): The image that constitutes the component. It contains values for alt, large, and small.
alt (string): This text becomes the image’s
alt
attribute.
large (string): File name (including path) of the image used with large device width. Path should be relative to the src folder (e.g., course/en/images/origami-menu-two.jpg).
small (string): File name (including path) of the image used with small device width. Path should be relative to the src folder (e.g., course/en/images/origami-menu-two.jpg).
attribution (string): Optional text to be displayed as an attribution. By default it is displayed below the image. Adjust positioning by modifying CSS. Text can contain HTML tags, e.g.,
Copyright © 2015 by <b>Lukasz 'Severiaan' Grela</b>
No known limitations.
Version number: 2.0 <a href="https://community.adaptlearning.org/ target="_blank">
Framework versions: 2.0
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), IE 11, IE10, IE9, IE8, IE Mobile 11, Safari for iPhone (iOS 7+8), Safari for iPad (iOS 7+8), Safari 8, Opera
- Framework in Five Minutes
- Setting up Your Development Environment
- Manual Installation of the Adapt Framework
- Adapt Command Line Interface
- Common Issues
- Adapt API
- Adapt Command Line Interface
- Core Events
- Core Model Attributes
- Core Modules
- Peer Code Review