Skip to content

Commit 185762c

Browse files
committed
Update migration guide
1 parent 3e99b45 commit 185762c

4 files changed

Lines changed: 1431 additions & 1359 deletions

File tree

docs/CSS28-migration_guide.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -266,4 +266,20 @@ As of version `2.0.0-beta.23`, ReadiumCSS provides flags as a way to opt-in to a
266266
- `--RS__experimentalHeaderFiltering: readium-experimentalHeaderFiltering-on`: attempts to filter out paragraphs that are implicitly headings or part of headers
267267
- `--RS__experimentalZoom: readium-experimentalZoom-on`: attemps to filter out elements that are sized using viewport units and should not be scaled directly
268268

269-
These flags are expected to be found on `:root`.
269+
These flags are expected to be found on `:root`.
270+
271+
## Fonts are no longer distributed in the package
272+
273+
As of version `2.0.0` (stable), ReadiumCSS no longer distributes fonts and their `font-face` rules. You will need to load them yourself.
274+
275+
**This is a breaking change.**
276+
277+
This means AccessibleDfa, iA Writer Duospace, and the Android FXL fonts patch are no longer included, nor are their `font-face` rules.
278+
279+
## PageGutter no longer applies in scroll view
280+
281+
As of version `2.0.0` (stable), the `--RS__pageGutter` property no longer applies in scroll view.
282+
283+
**This is a breaking change.**
284+
285+
If you need to apply padding to the scroll view, you can use the `--RS__scrollPadding` properties instead. This can be useful to get around safe area insets, or to add whitespace so that contents are not hidden behind UI elements.

docs/ReadiumCSS_docs/OEBPS/Text/Section-028.xhtml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -320,6 +320,26 @@ const backgroundColor = defaultColors.RS__backgroundColor;</code></pre>
320320
<li><code>--RS__experimentalZoom: readium-experimentalZoom-on</code>: attemps to filter out elements that are sized using viewport units and should not be scaled directly</li>
321321
</ul>
322322
</section>
323+
324+
<section id="fonts-removed-from-package" class="level2">
325+
<h2 id="sigil_toc_id_223">Fonts are no longer distributed in the package</h2>
326+
327+
<p>As of version <code>2.0.0</code> (stable), ReadiumCSS no longer distributes fonts and their <code>font-face</code> rules. You will need to load them yourself.</p>
328+
329+
<p><strong>This is a breaking change.</strong></p>
330+
331+
<p>This means AccessibleDfa, iA Writer Duospace, and the Android FXL fonts patch are no longer included, nor are their <code>font-face</code> rules.</p>
332+
</section>
333+
334+
<section id="pagegutter-removed-from-scroll-view" class="level2">
335+
<h2 id="sigil_toc_id_224">PageGutter no longer applies in scroll view</h2>
336+
337+
<p>As of version <code>2.0.0</code> (stable), the <code>--RS__pageGutter</code> property no longer applies in scroll view.</p>
338+
339+
<p><strong>This is a breaking change.</strong></p>
340+
341+
<p>If you need to apply padding to the scroll view, you can use the <code>--RS__scrollPadding</code> properties instead. This can be useful to get around safe area insets, or to add whitespace so that contents are not hidden behind UI elements.</p>
342+
</section>
323343
</section>
324344
</body>
325345
</html>

docs/ReadiumCSS_docs/OEBPS/Text/nav.xhtml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -762,6 +762,12 @@
762762
<li>
763763
<a href="../Text/Section-028.xhtml#sigil_toc_id_219">Experimental Features Flags</a>
764764
</li>
765+
<li>
766+
<a href="../Text/Section-028.xhtml#sigil_toc_id_223">Fonts are no longer distributed in the package</a>
767+
</li>
768+
<li>
769+
<a href="../Text/Section-028.xhtml#sigil_toc_id_224">PageGutter no longer applies in scroll view</a>
770+
</li>
765771
</ol>
766772
</li>
767773
</ol>

0 commit comments

Comments
 (0)