-
Notifications
You must be signed in to change notification settings - Fork 24
Home
#Graphic
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 page dedicated to Usage and Tips.
##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
-
If Graphic has been uninstalled from the Adapt authoring tool, it may be reinstalled using the Plug-in Manager.
##Settings
The settings listed below are the properties that may be configured within the authoring tool. Listed first is the name of the property as it is presented in the authoring tool. It is followed in parentheses by the property as it is used in the Graphic source code. Finally, an explanation is provided to help the course author better utilize the property.
The relationship between Graphic's properties and the way they are presented in the authoring tool’s interface is governed by properties.schema.
Title (title
): A reference title for the component. Title is distinct from the Display Title which, if present, appears above the component. If Display Title is rather long, Title provides the opportunity to use a
shortened form in tighter spaces, such as in a menu or in the drawer.
Display Title (displayTitle
): Optional text that will display as a title above the component. It can be used as a headline. In the authoring tool, Title and Display Title may be linked for easy input. Click the chain icon to toggle linking.
Body (body
): Optional text that appears above the component. It can be used in a variety of ways,
including as an introduction to the content in the component. HTML is permitted.
Instruction (instruction
): This optional text appears above the component. It is frequently used to
guide the learner’s interaction with the component.
Classes (_classes
): Custom classes predefined in the theme's Less files may be applied to this
component. To do this, enter the name of the CSS class. If using more than one class, separate each with a
space.
Layout (_layout
): This defines the horizontal position of the component in the block that contains it. This property is set when the component is being added to the block. When Add to left
or Add to right
is selected, another component can occupy the space next to it. If Add
is selected, the component spans the width of the containing block.
Graphic (_graphic
): The image that constitutes the component.
Alternative Text (
alt
): This text becomes the image’salt
attribute.
large (
large
): The large sized image for desktop devices. Click the icon to select the graphic asset.
small (
small
): The small sized image for mobile devices. Click the icon to select the graphic asset.
attribution (
attribution
): 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>
##Limitations
No known limitations.
###Getting Started
- Framework in Five Minutes
- Setting up Your Development Environment
- Manual Installation of the Adapt Framework
- Adapt Command Line Interface
- Common Issues
###Course Authoring
- Creating Your First Course
- Styling Your Course
- Core Plugins in the Adapt Learning Framework
- Deploying and Testing Your Adapt Course
###Framework Development
- Contributing to the Adapt Framework
- Git Flow
- Adapt API
- Adapt Command Line Interface
- Core Events
- Core Model Attributes
- Core Modules
- Web Security Audit
- Peer Code Review
###Plugin Development
- Plugins
- Developing Plugins
- Developer's Guide: Components
- Developer's Guide: Theme
- Registering a Plugin
- Semantic Version Numbers
- Core Model Attributes
- Adapt Command Line Interface
- Accessibility
- Adapt Framework Right to Left (RTL) Support
###Resources