Skip to content

Latest commit

 

History

History
68 lines (40 loc) · 4.61 KB

README.md

File metadata and controls

68 lines (40 loc) · 4.61 KB
Raw

adapt-contrib-vanilla

Vanilla is a theme bundled with the Adapt framework.

sample colors from the vanilla theme

It provides specific values to styles, including colors, padding, margins, and assets such as fonts and background images. Visit the Vanilla wiki for more information about its functionality and for explanations of key properties.

Installation

As Adapt's core theme, Vanilla is included with the installation of the Adapt framework and the installation of the Adapt authoring tool.

  • If Vanilla 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-vanilla

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

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

Uninstallation

The Adapt framework does not allow the installation of more than one theme at a time. In order to replace Vanilla it must be uninstalled. With the root of your framework installation as your current working directory, run the following command: adapt uninstall adapt-contrib-vanilla

Settings overview

Unlike most Adapt plug-ins, the Vanilla theme has no attributes that are required to be configured in the course JSON files. There is, however, additional functionality available to apply background images and supporting styles for pages, articles and blocks as desired. These attributes are properly formatted as JSON in example.json and available as configurable attributes in the Adapt authoring tool.

Alongside these settings, there's a collection of custom classes that the Vanilla theme supports as standard. These classes are mostly designed to provide additional visual options to increase flexibility.

The Vanilla theme also exposes color variables in the Adapt Authoring Tool for theme-by-config editing. This feature allows you to apply and save color presets.

JSON Config and Authoring Tool Options

An explanation on what properties are available as part of the theme can be found here

onScreen Animation

Further information regarding the onScreen properties can be found on the wiki

Custom Classes

All supported custom classes defined in the Vanilla theme are detailed here

Structure

To view a breakdown of the themes structure please visit the wiki

Icons

The wiki features a detailed overview of the icons available within the themes custom font set

Limitations

No known limitations.

adapt learning logo
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, IE11, Safari 14 for macOS/iOS/iPadOS, Opera