Version 1.3.4

### Changed - Fixed a typo (was srcipt but should be script) - Fixed visible appearance items in print view (#13) - Dependency fixes
Martinomagnifico · Jul 31, 2024 · 87c642f · 87c642f
1 parent cf1f939
commit 87c642f
Show file tree

Hide file tree

Showing 45 changed files with 2,969 additions and 13,477 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,19 @@
 # Changelog
 
 
+## [1.3.4] - 2023-07-31
+### Changed
+- Fixed a typo (was srcipt but should be script)
+- Fixed visible appearance items in print view (#13)
+- Dependency fixes
+
+### Added
+- Added `cssautoload` option to automatically load the CSS file. Can be switched off if you want to load the CSS file yourself with `import` when using bundlers like Webpack or Parcel.
+- Added `baseline` effect for use with words and letters, to make them appear from the baseline of the text.
+
+
+
+
 ## [1.3.3] - 2023-11-18
 ### Added
 - Added embedded example to the demo’s

diff --git a/README.md b/README.md
@@ -77,10 +77,17 @@ If you're using ES modules, you can add it like this:
 ```
 
 ### Styling
-The styling of Appearance is automatically inserted, either loaded through NPM or from the plugin folder. Two files are inserted: The first one is Animate.css by Daniel Eden for the basic animations, we add it through a CDN. The second file adds to the first stylesheet to allow for a non-animated state.
+The styling of Appearance is automatically inserted **when the appearance folder is manually (or automatically) copied** to the Reveal.js plugin folder.
 
-If you want to change the Appearance style, you can simply make your own style and use that stylesheet instead. Linking to your custom styles can be managed through the `csspath` option of Appearance.
+**BUT**: If you are using a bundler like Webpack or Parcel, that uses **import**, you will also need to **import** the CSS file yourself. Depending on your setup this can be something like this:
 
+```
+import 'reveal.js-appearance/plugin/appearance/appearance.css';
+```
+
+In that case, the `cssautoload` option (in the Reveal appearance options) should be set to `false`, to avoid style loading errors. 
+
+> However, if you actually know the correct full path to the CSS file, then you can still use the `csspath` option and keep `cssautoload` set to `true`.
 
 
 ### HTML
@@ -137,10 +144,12 @@ You can change the speed of each animation, using the tempo classes from Animate
 
 For words and letters, the same techniques can be used. 
 
-Note that the data-delay also gets copied to the smaller elements in it, which means that there is no more 'whole sentence' or 'whole word' to delay. By default, the whole element then gets the delay (depending on if it is following other animations) as defined in the `delay` option in the Configuration, but it can be overriden by an optional `data-container-delay`. 
+Note that the data-delay also gets copied to the smaller elements in it, which means that there is no more 'whole sentence' or 'whole word' to delay. By default, the whole element then gets the delay (depending on if it is following other animations) as defined in the `delay` option in the Configuration, but it can be overriden by an optional `data-container-delay`.
+
+Also note the (optional) `baseline` class here, which makes the words appear from the baseline of the text.
 
 ```html
-<h3 class="animate__fadeInDown animate__faster" 
+<h3 class="animate__fadeInUp animate__faster baseline"
 	data-split="words" 
 	data-delay="80"
 	data-container-delay="600">Let words apear and appear</h3>
@@ -150,7 +159,7 @@ Note that the data-delay also gets copied to the smaller elements in it, which m
 ### 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:
+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)
@@ -285,6 +294,7 @@ Reveal.initialize({
     appearevent: 'slidetransitionend',
     autoappear: false,
     autoelements: false,
+    cssautoload: true,
     csspath: '',
     animatecsspath: {
       link : 'https://cdnjs.cloudflare.com/ajax/libs/animate.css/4.1.1/animate.min.css',
@@ -302,6 +312,7 @@ Reveal.initialize({
 * **`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 "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.
+* **`cssautoload`**: Appearance will load the CSS if this is set to `true`. If you import reveal.js-appearance from npm, you will need to import the CSS file yourself. If you use 'import', then csspath should be set to `false`. If you know the path to the CSS file, you can use the `csspath` option and keep cssautoload set to `true`.
 * **`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 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.

diff --git a/demo/assets/css/demo.css b/demo/assets/css/demo.css
@@ -87,7 +87,7 @@ p.code, p code, small code, .small code, li code {
   --r-main-font-size: 36px;
   --r-block-margin: 1.8rem;
   --code-full-bg: #142433;
-  --code-rgba-bg: rgba(50, 65, 80, 0.4);
+  --code-rgba-bg: rgba(91, 102, 112, 0.3);
 }
 
 .reveal .slides ul li, .reveal .slides ol li {
@@ -100,6 +100,12 @@ p.code, p code, small code, .small code, li code {
   --r-link-color-hover: #0373bd;
 }
 
+.demoembed {
+  width: 768px;
+  height: 400px;
+  margin: 64px auto;
+}
+
 .reveal.embedded {
   border: 4px solid transparent;
   border-radius: 8px;
@@ -111,7 +117,6 @@ p.code, p code, small code, .small code, li code {
   border-color: #42affa;
   box-shadow: 0 4px 16px rgba(5, 21, 37, 0.3);
 }
-
 .reveal.embedded .progress {
   background: rgba(66, 175, 250, 0.3);
   font-size: 10px;
@@ -151,7 +156,7 @@ a.github-corner.bottom {
   margin-top: auto;
   top: calc(100% - 70px);
 }
-.reveal.embedded a.github-corner {
+.reveal.embedded a.github-corner, .reveal-viewport.reveal-scroll a.github-corner {
   display: none;
 }
 a.github-corner svg {

diff --git a/demo/demo-markdown.html b/demo/demo-markdown.html
@@ -49,7 +49,6 @@
       	center: true,
       	controlsTutorial: false,
       	appearance: {
-      		debug: false,
       		appearparents: true,
       		hideagain: true,
       		appearevent: 'auto',

diff --git a/demo/demo.html b/demo/demo.html
@@ -161,11 +161,11 @@ <h3>Change the animation speed</h3><small>Use the speed classes from Animate.css
 &lt;img class=&quot;animate__fadeInDown animate__faster&quot; src=&quot;assets/img/5.jpg&quot;&gt;</code></pre>
           </section>
           <section>
-            <h3>Change the settings for words or letters</h3><small>For words and letters, just set the speed and delay as described above. The smaller parts will inherit these settings. Set a <code>data-container-delay="*"</code> for a different delay for the container, compared to the standard <code>delay = 300</code> from the options. </small><br><br>
-            <h3 class="animate__fadeInDown" data-split="words">Split into words</h3>
-            <h3 class="animate__fadeInDown animate__faster" data-split="letters" data-delay="75" data-container-delay="800">Split into letters</h3><br>
-            <pre><code class="hljs html" data-line-numbers>&lt;h3 class=&quot;animate__fadeInDown&quot; data-split=&quot;words&quot;&gt;Split into words&lt;/h3&gt;
-&lt;h3 class=&quot;animate__fadeInDown animate__faster&quot; data-split=&quot;letters&quot; data-delay=&quot;75&quot; data-container-delay=&quot;800&quot;&gt;Split into letters&lt;/h3&gt;</code></pre>
+            <h3>Change the settings for words or letters</h3><small>For words and letters, just set the speed and delay as described above. The smaller parts will inherit these settings. Set a <code>data-container-delay="*"</code> for a different delay for the container, compared to the standard <code>delay = 300</code> from the options. Add a <code>baseline</code> class for a nice baseline effect.</small><br><br>
+            <h3 class="animate__fadeInUp baseline" data-split="words">Split into words</h3>
+            <h3 class="animate__fadeInUp animate__faster" data-split="letters" data-delay="75" data-container-delay="800">Split into letters</h3><br>
+            <pre><code class="hljs html" data-line-numbers>&lt;h3 class=&quot;animate__fadeInUp baseline&quot; data-split=&quot;words&quot;&gt;Split into words&lt;/h3&gt;
+&lt;h3 class=&quot;animate__fadeInUp animate__faster&quot; data-split=&quot;letters&quot; data-delay=&quot;75&quot; data-container-delay=&quot;800&quot;&gt;Split into letters&lt;/h3&gt;</code></pre>
           </section>
           <section data-auto-animate>
             <h3>Change when Appearance starts</h3>
@@ -244,10 +244,10 @@ <h3>Local auto-appear, specified</h3><small>You can also add a JSON object to th
 	&lt;/ul&gt;
 &lt;/section&gt;</code></pre>
           </section>
-          <section data-autoappear="{&quot;h3&quot;: {&quot;animation&quot;:&quot;animate__fadeInDown&quot;, &quot;speed&quot;:&quot;fast&quot;, &quot;delay&quot;:&quot;180&quot;, &quot;split&quot;:&quot;words&quot;, &quot;container-delay&quot;:&quot;200ms&quot;}, &quot;h4&quot;: {&quot;animation&quot;:&quot;animate__fadeInDown&quot;, &quot;split&quot;:&quot;letters&quot;, &quot;delay&quot;:&quot;80&quot;}}">
+          <section data-autoappear="{&quot;h3&quot;: {&quot;animation&quot;:&quot;animate__fadeInDown&quot;, &quot;speed&quot;:&quot;fast&quot;, &quot;delay&quot;:&quot;180&quot;, &quot;split&quot;:&quot;words&quot;, &quot;container-delay&quot;:&quot;200ms&quot;}, &quot;h4&quot;: {&quot;animation&quot;:&quot;animate__fadeInUp baseline&quot;, &quot;split&quot;:&quot;letters&quot;, &quot;delay&quot;:&quot;80&quot;}}">
             <h3>Local auto-appear, specified and split</h3><small>And you can do the same for any animations that you would like to have on lines and words.</small>
             <h4>Appearance</h4>
-            <pre><code class="hljs html" data-line-numbers>&lt;section data-autoappear='{"h3": {"animation":"animate__fadeInDown", "speed":"fast", "delay":"180", "split":"words", "container-delay":"500ms"}, "h4": {"animation":"animate__fadeInDown", "split":"letters", "delay":"80"}}'&gt;
+            <pre><code class="hljs html" data-line-numbers>&lt;section data-autoappear='{"h3": {"animation":"animate__fadeInDown", "speed":"fast", "delay":"180", "split":"words", "container-delay":"500ms"}, "h4": {"animation":"animate__fadeInUp baseline", "split":"letters", "delay":"80"}}'&gt;
 	&lt;h3&gt;Local auto-appear, specified and split&lt;/h3&gt;
 	&lt;h4&gt;Appearance&lt;/h4&gt;
 &lt;/section&gt;</code></pre>
@@ -263,6 +263,7 @@ <h2>Options</h2>
                 <li>appearevent</li>
                 <li>autoappear</li>
                 <li>autoelements</li>
+                <li>cssautoload</li>
                 <li>csspath</li>
                 <li>animatecsspath</li>
                 <li>compatibility</li>
@@ -274,106 +275,118 @@ <h2>Options</h2>
             <h4>Option 1: hideagain</h4>
             <p class="small">The <code>hideagain</code> option will hide elements (that have appeared on the slide) again when moving away from that slide. </p>
             <pre><code class="hljs js" data-line-numbers="4">Reveal.initialize({
-	...
-	appearance: {
-		hideagain: true
-	},
-	plugins: [ Appearance ]
+    ...
+    appearance: {
+        hideagain: true
+    },
+    plugins: [ Appearance ]
 })</code></pre>
           </section>
           <section>
             <h4>Option 2: delay</h4>
             <p class="small">The <code>delay</code> option is the base time in ms between appearances. This value governs any elements that do not have an Animate.css speed class assigned to it, or are not inside a slide which includes delay in a data-autoappear attribute.</p>
             <pre><code class="hljs js" data-line-numbers="4">Reveal.initialize({
-	...
-	appearance: {
-		delay: 300
-	},
-	plugins: [ Appearance ]
+    ...
+    appearance: {
+        delay: 300
+    },
+    plugins: [ Appearance ]
 })</code></pre>
           </section>
           <section>
             <h4>Option 3: appearevent</h4>
             <p class="small">You can change when Appearance starts with any of the following events: <code>slidetransitionend</code> (default, after the transition), <code>slidechanged</code> (with the transition) and <code>auto</code> (with transition, on autoanimate slides). This can be overridden per-slide with data-attributes, like this: <code>data-appearevent="auto"</code>.</p>
             <pre><code class="hljs js" data-line-numbers="4">Reveal.initialize({
-	...
-	appearance: {
-		appearevent: slidetransitionend
-	},
-	plugins: [ Appearance ]
+    ...
+    appearance: {
+        appearevent: slidetransitionend
+    },
+    plugins: [ Appearance ]
 })</code></pre>
           </section>
           <section>
             <h4>Option 4: autoappear</h4>
             <p class="small">The <code>autoappear</code> option works together with the <code>autoelements</code> option. When it is set to <code>true</code>, any elements in the autoelements option will animate with the declared animation when the slide or fragment opens. See <a href="#/autoappear"><code>autoappear</code></a>.</p>
             <pre><code class="hljs js" data-line-numbers="4,5">Reveal.initialize({
-	...
-	appearance: {
-		autoappear: false,
-		autoelements: false
-	},
-	plugins: [ Appearance ]
+    ...
+    appearance: {
+        autoappear: false,
+        autoelements: false
+    },
+    plugins: [ Appearance ]
 })</code></pre>
           </section>
           <section>
             <h4>Option 5: autoelements</h4>
             <p class="small">These are the elements that <code>autoappear</code> 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.</p>
             <pre><code class="hljs js" data-line-numbers="4,5">Reveal.initialize({
-	...
-	appearance: {
-		autoappear: false,
-		autoelements: false
-	},
-	plugins: [ Appearance ]
+    ...
+    appearance: {
+        autoappear: false,
+        autoelements: false
+    },
+    plugins: [ Appearance ]
 })</code></pre>
           </section>
+          <section class="center">
+            <h4>Option 6: cssautoload</h4>
+            <p>Appearance will load the CSS if this is set to <code>true</code>.</p>
+            <pre><code class="hljs js" data-line-numbers="4">Reveal.initialize({
+    ...
+    appearance: {
+        cssautoload: true
+    },
+    plugins: [ Appearance ]
+})</code></pre>
+            <p class="small">If you import reveal.js-appearance from npm, you will need to import the CSS file yourself. If you use 'import', then <code>csspath</code> should be set to <code>false</code>. If you know the path to the CSS file, you can use the <code>csspath</code> option and keep <code>cssautoload</code> set to <code>true</code>.</p>
+          </section>
           <section>
-            <h4>Option 6: csspath</h4>
+            <h4>Option 7: csspath</h4>
             <p class="small">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.</p>
             <pre><code class="hljs js" data-line-numbers="4,5">Reveal.initialize({
-	...
-	appearance: {
-		csspath: ''
-	},
-	plugins: [ Appearance ]
+    ...
+    appearance: {
+        csspath: ''
+    },
+    plugins: [ Appearance ]
 })</code></pre>
           </section>
           <section>
-            <h4>Option 7: animatecsspath</h4>
+            <h4>Option 8: animatecsspath</h4>
             <p class="small">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.</p>
             <pre><code class="hljs js" data-line-numbers="4-7">Reveal.initialize({
-	...
-	appearance: {
-		animatecsspath: {
-			link : 'https://cdnjs.cloudflare.com/ajax/libs/animate.css/4.1.1/animate.min.css',
-			compat : 'https://cdnjs.cloudflare.com/ajax/libs/animate.css/4.1.1/animate.compat.css',
-		}
-	},
-	plugins: [ Appearance ]
+    ...
+    appearance: {
+        animatecsspath: {
+            link : 'https://cdnjs.cloudflare.com/ajax/libs/animate.css/4.1.1/animate.min.css',
+            compat : 'https://cdnjs.cloudflare.com/ajax/libs/animate.css/4.1.1/animate.compat.css',
+        }
+    },
+    plugins: [ Appearance ]
 })</code></pre>
           </section>
           <section>
-            <h4>Option 8: compatibility</h4>
+            <h4>Option 9: compatibility</h4>
             <p class="small">This setting is about the breaking changes in Animate.css (used by Appearance). See the migration guide in the Readme for more info. </p>
             <p class="small">Setting <code>'compatibility: true'</code> can let you use your old markup.</p>
             <pre><code class="hljs js" data-line-numbers="4">Reveal.initialize({
-	...
-	appearance: {
-		compatibility: false
-	},
-	plugins: [ Appearance ]
+    ...
+    appearance: {
+        compatibility: false
+    },
+    plugins: [ Appearance ]
 })</code></pre>
           </section>
           <section>
-            <h4>Option 9: compatibilitybaseclass</h4>
+            <h4>Option 10: compatibilitybaseclass</h4>
             <p class="small">This setting is about the breaking changes in Animate.css (used by Appearance). See the migration guide in the Readme for more info. </p>
             <p class="small">This is the baseclass to use if you don't change your markup.</p>
             <pre><code class="hljs js" data-line-numbers="4">Reveal.initialize({
-	...
-	appearance: {
-		compatibilitybaseclass: 'animated'
-	},
-	plugins: [ Appearance ]
+    ...
+    appearance: {
+        compatibilitybaseclass: 'animated'
+    },
+    plugins: [ Appearance ]
 })</code></pre>
           </section>
         </section>
@@ -411,7 +424,6 @@ <h3>Credits</h3>
       	center: true,
       	controlsTutorial: false,
       	appearance: {
-      		debug: true,
       		appearparents: true,
       		hideagain: true,
       		appearevent: 'auto',

diff --git a/demo/dist/reveal.css b/demo/dist/reveal.css
diff --git a/demo/dist/reveal.esm.js b/demo/dist/reveal.esm.js
diff --git a/demo/dist/reveal.esm.js.map b/demo/dist/reveal.esm.js.map
diff --git a/demo/dist/reveal.js b/demo/dist/reveal.js
diff --git a/demo/dist/reveal.js.map b/demo/dist/reveal.js.map