Skip to content

Commit

Permalink
Readme and example improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
swashbuck committed Aug 11, 2023
1 parent 599b482 commit d4ab530
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 16 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Uses v5.7.6 of Lottie.

## Adapt Authoring Tool
Change the file ending of your json from `.json` to `.svgz` for use in the AAT image picker.
To use in the AAT image picker, change the file ending of your JSON file from `.json` to `.svgz`.

## Settings Overview

Expand All @@ -17,7 +17,7 @@ The attributes listed below are used in *course.json* to configure **Adapt Graph

>**\_isEnabled** (String): Defaults to `true`.
>**\_fileExtension** (String): The image file extension of the json file. Acceptable values are `svgz` and `bmp`. Defaults to `svgz`.
>**\_fileExtension** (String): The file extension of the JSON file that is exported from Adobe After Effects. Acceptable values are `svgz` and `json`. Defaults to `svgz`.
>**\_loops** (Number): Controls how many times the animation should loop when inview. To set an infinite loop, use a value of `-1`. Defaults to `0` (don't loop).
Expand Down
44 changes: 30 additions & 14 deletions example.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,31 @@
// course.json
{
"_graphicLottie": {
"_isEnabled": true,
"_fileExtension": "svgz",
"_loops": -1,
"_autoPlay": true,
"_onScreenPercentInviewVertical": 1,
"_playFirstViewOnly": true,
"_offScreenPause": true,
"_offScreenRewind": true,
"_showPauseControl": false,
"_onPauseRewind": false
}
// course.json
"_graphicLottie": {
"_isEnabled": true,
"_fileExtension": "svgz",
"_loops": -1,
"_autoPlay": true,
"_onScreenPercentInviewVertical": 1,
"_playFirstViewOnly": true,
"_offScreenPause": true,
"_offScreenRewind": true,
"_showPauseControl": false,
"_onPauseRewind": false
}

// components.json - Example using a Lottie animation in a Graphic component
{
"_id": "c-05",
"_parentId": "b-05",
"_type": "component",
"_component": "graphic",
"_classes": "",
"_layout": "left",
"title": "Graphic component",
"displayTitle": "",
"body": "",
"instruction": "",
"_graphic": {
"large": "course/en/images/graphic.svgz",
"small": "course/en/images/graphic.svgz"
}
}

0 comments on commit d4ab530

Please sign in to comment.