reveal.js-appearance 1.1.3 → 1.2.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [1.2.0] - 2023-05-05
+### Added
+- Added local, specified, auto-appear
+- Added Markdown example
+- Added fix for Quarto list items
+
+### Changed
+- Reordered documentation
+- Fragments can now be Appearance items
+
+
 ## [1.1.3] - 2022-06-26
 ### Changed
 - Fixed a bug if there was no previous slide

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Martijn De Jongh (Martino)
+Copyright (c) 2023 Martijn De Jongh (Martino)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -4,7 +4,7 @@
 
 An animation plugin for [Reveal.js](https://revealjs.com) that animates elements sequentially like in Powerpoint. Perfect for online portfolios or other presentations with images.
 
-[![Screenshot](https://martinomagnifico.github.io/reveal.js-appearance/screenshot.png)](https://martinomagnifico.github.io/reveal.js-appearance/demo.html)
+[<img src="https://martinomagnifico.github.io/reveal.js-appearance/screenshot.png" width="100%">](https://martinomagnifico.github.io/reveal.js-appearance/demo.html)
 
 In Powerpoint you can make slides with items that appear automatically with effects. This plugin for Reveal.js tries to achieve the same result. It's easy to set up. It uses Animate.css by Daniel Eden for the animations, with some changes to allow for a non-animated state. 
 
@@ -17,6 +17,15 @@ Version 1.1.1 adds an `autoappear` mode for use in cases where adding animation
 Appearance v1.1.2 brought some **breaking changes**, please refer to the [migration guide](#migration-guide) before updating from v1.1.1 and under. It also changed the internal delay mechanism to use CSS animation delay in combination to adding the trigger on the parent, not each animated element. This will improve the performance.
 
 
+## Basics
+
+There are really only three steps:
+
+1. Install Appearance
+2. Edit the markup to add animation classes
+2. Enjoy the animations
+
+
 ## Installation
 
 ### Regular installation
@@ -86,7 +95,87 @@ It is easy to set up your HTML structure for Appearance. Each element that you w
     <li class="animate__bounceInLeft">It adds some attention.</li>
 </ul>
 ```
-When you are working with Markdown, this can be a chore so if you do not want to add all these classes, you can set the option `autoappear` to `true` (see Configuration below) and let Appearance do the heavy work. You do not need to add any markup and it will stay like this:
+
+When you are working with Markdown (or in any other case), this can be a chore **so if you do not want to add all these classes**, you can set the option `autoappear` to `true` (see [Autoappear](#autoappear) below) and let Appearance do the heavy work.
+
+
+## Now change it
+
+It is easy to change the effects for Appearance. 
+
+### Changing the delay
+
+Here's how to change the delay per element: 
+
+```html
+<img class="animate__fadeInDown" data-src="1.jpg" data-delay="200">
+<img class="animate__fadeInDown" data-src="2.jpg" data-delay="160">
+<img class="animate__fadeInDown" data-src="3.jpg" data-delay="120">
+```
+
+### Changing the speed
+
+You can change the speed of each animation, using the tempo classes from Animate.css:
+
+```html
+<img class="animate__fadeInDown animate__slower" data-src="1.jpg">
+<img class="animate__fadeInDown animate__slow" data-src="2.jpg">
+<img class="animate__fadeInDown animate__fast" data-src="3.jpg">
+<img class="animate__fadeInDown animate__faster" data-src="4.jpg">
+```
+
+### Changing the 'appearevent'
+When you navigate from slide to slide, you can set transition effects in Reveal. These effects take some time. That's why, by default, Appearance only starts when the slide transition has ended. 
+
+There are cases however, where  there is hardly any transition, for example, when going from an autoanimate slide to another. Reveal then suppresses the user-set transition to a short opacity change. Starting *together with* the transition might then be nicer. You can use any of the following events:
+
+* *slidetransitionend* (default, Appearance will always start animating elements after the transition)
+* *slidechanged* (Appearance will always start together with the transition)
+* *auto* (Appearance will start together with the transition, but only on autoanimate slides, other slides will use *slidetransitionend*)
+
+```html
+<section data-appearevent="auto">
+    <ul>
+        <li class="animate__fadeInLeft">This is list item 1</li>
+        <li class="animate__fadeInLeft">This is list item 2</li>
+        <li class="animate__fadeInLeft">This is list item 1</li>
+    </ul>
+</section>
+```
+
+These same event triggers can be set through the `appearevent` option in the global configuration. 
+
+When using Appearance inside an autoanimate slide, and changing the appearevent to `slidechanged` or `auto`, keep in mind that Reveal transforms opacity for all non-autoanimate items, while Appearance does the same on most of the effects. To avoid strange behaviour, wrap these Appearance items in a parent. For example, a list of animated bullet points works well, because the animated class is on the children, not the parent. Separate headings or other elements do not have that, so should be wrapped.
+
+
+## Autoappear
+
+You can simplify the addition of animation classes.
+
+Sometimes (for example with Markdown), adding classes to elements is a chore. Appearance can automatically add animation classes to specific elements (tags or other selectors) in the presentation (with the option autoappear) or per slide (with data-autoappear).
+
+### Global autoappear mode
+
+With the option `autoappear` set to `true`, ALL elements in the presentation that have a certain selector (and that are not already classed with your base animation class, like 'animated') will subsequently get this class, and thus an animation. These selectors and the animations can be set in the configuration options like this:  
+
+```javascript
+Reveal.initialize({
+	// ...
+	appearance: {
+		// ...
+		autoappear: true,
+		autoelements: {
+			'ul li': 'animate__fadeInLeft',
+			'ol li': 'animate__fadeInRight'
+		}
+	},
+	plugins: [ Appearance ]
+});
+```
+
+You can add any selector and animation class to this object.
+
+Now you do not need to add any classes to the markup and it will stay like this:
 
 ```html
 <ul>
@@ -105,6 +194,50 @@ or like this in Markdown:
 ```
 
 
+
+### Local auto-appear
+
+With the option `autoappear` set to `false`, the above still works, but only on a data-attribute basis. ONLY elements in the presentation that are inside sections or fragments with a data-attribute of `data-autoappear` will be animated automatically, with the selectors and animations as described in the configuration: 
+
+```javascript
+Reveal.initialize({
+	// ...
+	appearance: {
+		// ...
+		autoappear: false,
+		autoelements: {
+			'ul li': 'animate__fadeInLeft',
+			'ol li': 'animate__fadeInRight'
+		}
+	},
+	plugins: [ Appearance ]
+});
+```
+
+```html
+<section data-autoappear="true">
+	<ul>
+		<li>This is list item 1</li>
+		<li>This is list item 2</li>
+	</ul>
+</section>
+```
+
+
+### Local auto-appear, specified
+
+You can also add a JSON object to the slide’s `data-autoappear`, with specific elements, their animations class as a string or an array with animations class, optional speed class and delay. 
+
+```html
+<section data-autoappear='{"ul li":"animate__fadeInRight","h3":["animate__fadeInDown, animate__slow","100ms"]}'>
+	<h3>Local auto-appear, specified</h3>
+	<ul>
+		<li>This is list item 1</li>
+		<li>This is list item 2</li>
+	</ul>
+</section>
+```
+
 ## Configuration
 
 There are a few options that you can change from the Reveal.js options. The values below are default and do not need to be set if they are not changed.
@@ -133,61 +266,15 @@ Reveal.initialize({
 * **`hideagain`**: Change this (true/false) if you want to see the shown elements if you go back.
 * **`delay`**: Base time in ms between appearances.
 * **`appearevent`**: Use a specific event at which Appearance starts.
-* **`autoappear`**: Use this when you do not want to add classes to each item that you want to appear, and just let Appearance add animation classes to (all of) the provided elements in the presentation. See "Using 'autoappear'" mode below.
+* **`autoappear`**: Use this when you do not want to add classes to each item that you want to appear, and just let Appearance add animation classes to (all of) the provided elements in the presentation. See "Autoappear" mode above.
 * **`autoelements`**: These are the elements that `autoappear` will target. Each element has a selector and an animation class. If `autoappear` is off, the elements will still get animation if the section contains a `data-autoappear` attribute.
 * **`csspath`**: Appearance will automatically load the styling of the plugin. If you want to customise the styling, you can link to your own CSS file here.
-* **`animatecsspath`**: Appearance will also automatically load the styling of Animate.css via a CDN. Note that Animeta.css has two links, the first (CDN) one is for version 4, the second (old) one is the version 3 compatibility CDN link.
+* **`animatecsspath`**: Appearance will also automatically load the styling of Animate.css via a CDN. Note that Animate.css has two links, the first (CDN) one is for version 4, the second (old) one is the version 3 compatibility CDN link.
 * **`compatibility`**: This setting can let you use your current markup. However, because this also uses the Animate.css compatibility CSS, and it is likely that they will not support this in the future, please update your markup as shown above.
 * **`compatibilitybaseclass`**: This is the baseclass to use if you don't change your markup. 
 
-### Changing the 'appearevent'
-When you navigate from slide to slide, you can set transition effects in Reveal. These effects take some time. That's why, by default, Appearance only starts when the slide transition has ended. 
-
-There are cases however, where  there is hardly any transition, for example, when going from an autoanimate slide to another. Reveal then suppresses the user-set transition to a short opacity change. Starting *together with* the transition might then be nicer. You can use any of the following events:
-
-* *slidetransitionend* (default, Appearance will start animating elements after the transition)
-* *slidechanged* (Appearance will start together with the transition)
-* *auto* (Appearance will start together with the transition, but only on autoanimate slides, other slides will use *slidetransitionend*)
-
-These same event triggers can be set through the data-attribute `data-appearevent`. 
-
-When using Appearance inside an autoanimate slide, and changing the appearevent to `slidechanged` or `auto`, keep in mind that Reveal transforms opacity for all non-autoanimate items, while Appearance does the same on most of the effects. To avoid strange behaviour, wrap these Appearance items in a parent. For example, a list of animated bullet points works well, because the animated class is on the children, not the parent. Separate headings or other elements do not have that, so should be wrapped.
 
 
-### Using 'autoappear' mode
-Sometimes (for example with Markdown), adding classes to elements is a chore. Appearance can automatically add animation classes to specific elements, or tags, in the presentation.
-
-With the option `autoappear` set to `true`, ALL elements in the presentation that have a certain selector (and that are not already classed with your base animation class, like 'animated') will subsequently get this class, and thus an animation. These selectors and the animations can be set in the configuration options like this:  
-
-```javascript
-autoelements: {
-	'ul li': 'animate__fadeInLeft',
-	'ol li': 'animate__fadeInRight'
-}
-```
-You can add any selector and animation class to this object.
-
-With the option `autoappear` set to `false`, the above still works, but only on a data-attribute basis. ONLY elements in the presentation that are inside sections or fragments with a data-attribute of `data-autoappear` will be animated automatically. 
-
-
-
-## Now change it
-
-It is easy to change the effects for Appearance. Here's how to change the delay per-element: 
-
-```html
-<img class="animate__fadeInDown" data-src="1.jpg" data-delay="200">
-<img class="animate__fadeInDown" data-src="2.jpg" data-delay="160">
-<img class="animate__fadeInDown" data-src="3.jpg" data-delay="120">
-```
-or the speed of each animation, using the tempo classes from Animate.css:
-
-```html
-<img class="animate__fadeInDown slower" data-src="1.jpg">
-<img class="animate__fadeInDown slow" data-src="2.jpg">
-<img class="animate__fadeInDown fast" data-src="3.jpg">
-<img class="animate__fadeInDown faster" data-src="4.jpg">
-```
 
 ## Migration guide
 Appearance v1.1.2 is an update to stay current with the latest version of Animate.css, which itself brought breaking changes in version 4. Animate.css v4 added a prefix for all of the Animate.css classes, defaulting to `animate__` . Appearance will now automatically add the Animate.css base class (`animate__animated`) to any element with a Animate.css animation class.
@@ -209,6 +296,7 @@ you should now use this:
 ```
 which is the only change in the markup. 
 
+
 ### Turn on compatibility mode
 
 If you turn in compatibility mode in Appearance, you can keep using your current markup. However, because this also uses the Animate.css compatibility CSS, this might break your presentations in the future, so it is not recommended. See the options above for compatibility mode and the compatibility base class.
@@ -224,4 +312,4 @@ And if you want to show off what you made with it, please do :-)
 ## License
 MIT licensed
 
-Copyright (C) 2022 Martijn De Jongh (Martino)
+Copyright (C) 2023 Martijn De Jongh (Martino)

package/css/demo.css

@@ -1,3 +1,9 @@
+:root {
+  --r-heading-text-transform: none ;
+  --r-background-color: #1a1626;
+  --r-main-font-size: 40px;
+}
+
 .slides {
   opacity: 0;
   -webkit-transition: opacity 0.5s ease;
@@ -56,12 +62,17 @@
           perspective: 1000px;
 }
 
-small {
-  margin: 1.5rem 0 2rem 0;
+p.small {
+  font-size: 75%;
+}
+
+p {
+  margin: var(--r-block-margin) 0;
 }
 
-.small {
-  font-size: 75%;
+.reveal .slides ul li, .reveal .slides ol li {
+  margin-top: 0.4em;
+  margin-bottom: 0.2em;
 }
 
 small code {
@@ -72,6 +83,24 @@ small code {
   border-radius: 0.5rem;
 }
 
+p a code {
+  background: none;
+  padding: 0;
+  text-decoration: underline;
+}
+
+p a[href*=html] {
+  text-decoration: underline;
+}
+
+.reveal pre {
+  font-size: 0.5em;
+}
+
+.reveal table.imagetable thead {
+  display: none;
+}
+
 a.github-corner {
   position: absolute;
   z-index: 1;
@@ -82,4 +111,77 @@ a.github-corner {
 
 a.github-corner:hover {
   color: white;
+}
+
+.reveal pre {
+  width: 100%;
+  -webkit-box-shadow: none;
+          box-shadow: none;
+  font-size: 0.5em;
+}
+
+p code, p kbd, ul code {
+  background: rgba(180, 180, 180, 0.2);
+  font-size: 0.8em;
+  padding: 5px 10px;
+  border-radius: 4px;
+}
+
+p kbd, ul kbd {
+  font-family: monospace;
+}
+
+.reveal .code-wrapper, pre, pre code {
+  white-space: pre-wrap !important;
+}
+
+em[class*=animate] {
+  display: inline-block;
+}
+
+.reveal img.demoimg {
+  width: 140px;
+  height: 140px;
+  max-width: 100%;
+  max-height: 100%;
+  margin: 0.2em;
+}
+
+.centerblock {
+  height: 100%;
+  min-height: 100%;
+  display: -webkit-box;
+  display: -ms-flexbox;
+  display: flex;
+  -webkit-box-orient: vertical;
+  -webkit-box-direction: normal;
+      -ms-flex-direction: column;
+          flex-direction: column;
+  margin: auto;
+}
+
+ol.twocol {
+  padding: 0;
+  margin: 0 auto;
+  list-style: none;
+  counter-reset: item;
+  width: 80%;
+  -webkit-column-count: 2;
+     -moz-column-count: 2;
+          column-count: 2;
+  -webkit-column-gap: 20px;
+     -moz-column-gap: 20px;
+          column-gap: 20px;
+}
+ol.twocol li {
+  counter-increment: item;
+  padding-left: 1.7em;
+}
+ol.twocol li:before {
+  content: counter(item) ".";
+  margin-left: -1.7em;
+  margin-right: 0.5em;
+  display: inline-block;
+  width: 1.2em;
+  text-align: right;
 }

package/demo-markdown.html

@@ -0,0 +1,62 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+    <meta charset="utf-8">
+    <title>Appearance for Reveal.js</title>
+    <meta name="description" content="">
+    <meta name="author" content="Martinomagnifico">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+    <link rel="stylesheet" href="../dist/reset.css">
+    <link rel="stylesheet" href="../dist/reveal.css">
+    <link rel="stylesheet" href="../dist/theme/black.css">
+    <link rel="stylesheet" href="../plugin/highlight/monokai.css">
+    <link rel="stylesheet" href="css/demo.css">
+</head>
+
+<body>
+    <div class="reveal"><a class="github-corner" href="https://github.com/Martinomagnifico/reveal.js-appearance" target="blank" title="View source on GitHub">
+            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 55 55">
+                <path fill="currentColor" d="M27.5 11.2a16.3 16.3 0 0 0-5.1 31.7c.8.2 1.1-.3 1.1-.7v-2.8c-4.5 1-5.5-2.2-5.5-2.2-.7-1.9-1.8-2.4-1.8-2.4-1.5-1 .1-1 .1-1 1.6.1 2.5 1.7 2.5 1.7 1.5 2.5 3.8 1.8 4.7 1.4.2-1 .6-1.8 1-2.2-3.5-.4-7.3-1.8-7.3-8 0-1.8.6-3.3 1.6-4.4-.1-.5-.7-2.1.2-4.4 0 0 1.4-.4 4.5 1.7a15.6 15.6 0 0 1 8.1 0c3.1-2 4.5-1.7 4.5-1.7.9 2.3.3 4 .2 4.4 1 1 1.6 2.6 1.6 4.3 0 6.3-3.8 7.7-7.4 8 .6.6 1.1 1.6 1.1 3v4.6c0 .4.3.9 1.1.7a16.3 16.3 0 0 0-5.2-31.7"></path>
+            </svg></a>
+        <div class="slides">
+            <section data-markdown="markdown.md" data-separator="^
+?
+---
+?
+" data-separator-vertical="^
+?
+----
+?
+" data-charset="utf-8"></section>
+        </div>
+    </div>
+    <script src="../dist/reveal.js"></script>
+    <script src="plugin/appearance/appearance.js"></script>
+    <script src="../plugin/highlight/highlight.js"></script>
+    <script src="../plugin/markdown/markdown.js"></script>
+    <script>
+        Reveal.initialize({
+            transition: "slide",
+            history: true,
+            appearance: {
+                hideagain: true,
+                appearevent: "auto",
+                autoappear: true,
+                autoelements: {
+                    "ul li": "animate__fadeInLeft",
+                    "ol li": "animate__fadeInLeftRight"
+                },
+                compatibility: false
+            },
+            plugins: [
+                RevealMarkdown,
+                Appearance,
+                RevealHighlight
+            ]
+        });
+    </script>
+</body>
+
+</html>