ipyslides 7.3.2__tar.gz → 7.3.4__tar.gz

{ipyslides-7.3.2 → ipyslides-7.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ipyslides
-Version: 7.3.2
+Version: 7.3.4
 Summary: Live rich content slides in jupyter notebook
 Home-page: https://github.com/asaboor-gh/ipyslides
 Author: Abdul Saboor

ipyslides-7.3.4/ipyslides/__version__.py

@@ -0,0 +1,2 @@
+
+__version__ = "7.3.4"

{ipyslides-7.3.2 → ipyslides-7.3.4}/ipyslides/_base/_layout.py

@@ -48,7 +48,9 @@ def layout_css(accent_color, aspect):
                     },
                 },
                 ".static-widget": {
-                    "position": "static !important", # let objects flow out
+                    "^, > *, .widget-html-content": {
+                        "position": "static !important", # let objects flow out
+                    },
                 },
                 ".Warn::after": {
                     "display": "block",
@@ -131,6 +133,11 @@ def layout_css(accent_color, aspect):
                     "position": "absolute !important",
                     "^, .widget-html-content": {"line-height": "0 !important"},
                     "@media print": {"position": "fixed !important",},
+                    "@media screen": { # avoid messing up print layout
+                        "transform": "scale(min(var(--contentScale), 1)) !important", # scale footer to match content, but not more than 1
+                        "transform-origin": "left bottom !important",
+                        "transition": "transform 0.4s ease-in-out",
+                    },
                 }, # other properties are set internally
                 "> .Build-Btn": {"visibility": "hidden !important",}, # hide build button by default
                 "^:has(.SlideArea.Stale) > .Build-Btn": {
@@ -328,7 +335,6 @@ def layout_css(accent_color, aspect):
                     "line-height": "1.5 !important",
                 },
                 "^, .widget-html-content": {
-                    "--text-size": "14px !important",
                     "position": "static !important", # footer content should escape
                 },
             },

{ipyslides-7.3.2 → ipyslides-7.3.4}/ipyslides/_base/_widgets.py

@@ -23,7 +23,7 @@ class InteractionWidget(anywidget.AnyWidget):
     _colors = traitlets.Dict(jupyter_colors).tag(sync=True) # for export
     _parts = traitlets.Dict().tag(sync=True) # parts data for each slide, for js side use
     _main_end = traitlets.Int(default_value=0).tag(sync=True) # last main slide index
-    _fpad = traitlets.Int(16).tag(sync=True) # padding for footer, used in export
+    _page_css = traitlets.Unicode('').tag(sync=True) # page size and margin for print/export
     
     msg_topy = traitlets.Unicode('').tag(sync=True)
     msg_tojs = traitlets.Unicode('').tag(sync=True)

{ipyslides-7.3.2 → ipyslides-7.3.4}/ipyslides/_base/export_html.py

@@ -28,7 +28,6 @@ _script = '''<script>
         let scale = scaleH > scaleW ? scaleW : scaleH;
         if (scale) { // Only add if not null or somethings
             document.documentElement.style.setProperty('--contentScale',scale);
-            document.documentElement.style.setProperty('--paddingBottom',Number(__PADBTM__/scale) + "px");
         };
     };
     window.dispatchEvent(new window.Event('resize')); // First time programatically
@@ -111,7 +110,7 @@ class _HhtmlExporter:
                 theme_kws["colors"] = self.main.widgets.iw._colors
                     
         dom_classes = tuple(self.main._box._dom_classes)
-        css_classes = [c for c in dom_classes if c.startswith('Slides')]
+        css_classes = [c for c in dom_classes if c.startswith('Slides') or c.startswith('has-')] # only export relevant classes
         if self.main.uid in dom_classes:
             css_classes.append(self.main.uid)
             
@@ -122,7 +121,7 @@ class _HhtmlExporter:
             content     = content, 
             script      = _script, 
             css_class   = ' '.join(css_classes),
-            padding_bottom = self.main.widgets.iw._fpad,
+            page_css    = self.main.html('style', self.main.widgets.iw._page_css).value,
             )
 
 

{ipyslides-7.3.2 → ipyslides-7.3.4}/ipyslides/_base/export_template.py

@@ -1,6 +1,6 @@
 # Template for building HTML from slides 
 
-def doc_html(code_css, style_css, content, script, css_class, padding_bottom):
+def doc_html(code_css, style_css, content, script, css_class, page_css = ''):
     return f'''<!DOCTYPE html>
 <html lang="en">
 <head>
@@ -13,8 +13,9 @@ def doc_html(code_css, style_css, content, script, css_class, padding_bottom):
     <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.0.3/jquery.min.js"></script> 
     
     {style_css}
-    {slides_css.replace("__PADBTM__",str(padding_bottom))}
+    {slides_css}
     {code_css}
+    {page_css}
 
     <!-- Custom stylesheet, it must be in the same directory as the html file -->
     <link rel="stylesheet" href="overrides.css">
@@ -50,7 +51,7 @@ def doc_html(code_css, style_css, content, script, css_class, padding_bottom):
     </div>
 </div>
 </body>
-{script.replace("__PADBTM__",str(padding_bottom))}
+{script}
 </html>
 '''
 
@@ -94,6 +95,9 @@ section .SlideBox {
 .SlidesWrapper .SlideLogo {
     position: fixed !important;
     line-height: 0 !important; /* suppress bad line-height here */
+    transform: scale(min(var(--contentScale), 1)) !important; /* scale footer to match content, but not more than 1 */
+    transform-origin: left bottom !important;
+    transition: transform 0.4s ease-in-out;
 }
 .SlidesWrapper::-webkit-scrollbar,
 .SlidesWrapper::-webkit-scrollbar-button,
@@ -103,7 +107,7 @@ section .SlideBox {
 
 .SlidesWrapper.Scrolling .slide-footer {
     visibility: hidden !important;
-    transition: visbility 200ms ease-in;
+    transition: visibility 200ms ease-in;
 }
 
 @media print {
@@ -137,12 +141,15 @@ section .SlideBox {
         margin: 0 !important;
         padding: 0 !important;
         page-break-inside: avoid !important;
-        page-break-after: always !important;
+        page-break-before: always !important;
+        break-before: page !important;
+        break-inside: avoid !important;
         overflow: hidden !important; /* otherwise it throws text to next page */
-        padding-bottom: __PADBTM__px !important; /* for avoiding overflow to bottom,same as under SlideArea */
+        padding-bottom: var(--pad-footer, 23px) !important; /* for avoiding overflow to bottom,same as under SlideArea */
     }
-    section:last-of-type {
-        page-break-after: avoid !important;
+    section:first-of-type {
+        page-break-before: avoid !important;
+        break-before: avoid !important;
     }
     section .SlideBox {
         margin-bottom: 0 !important;
@@ -153,7 +160,6 @@ section .SlideBox {
         position: static !important; /*override from document as printing absolute is issue */
         overflow: hidden !important;
         page-break-inside: avoid !important;
-        --paddingBottom: __PADBTM__px; /* fixed for printing, padding set in style_css */
     }
 }
 </style>

{ipyslides-7.3.2 → ipyslides-7.3.4}/ipyslides/_base/intro.py

@@ -123,7 +123,7 @@ Use `Save as PDF` option instead of Print PDF in browser to make links work in o
     - PDF printing may not work as expected in all browsers/IDEs and tested only in JupyterLab.
     - In case of issues with frames not displaying properly using `Ctrl + P`, export to HTML and then print.
     - Make sure your presentation is clean for print. "Inline Notes" are only meant for personal reference or sharing slides with notes.
-    - `Slides.settings.layout.aspect` may be adjusted for a little different than standard aspect ratios to avoid rounding issues in print, such as 16/9 to 16/9.001, etc.
+    - If print shows blank/gray pages, adjust printer setting settings such as margin and it would resolve the issue. If not, export to HTML and then print.
 
 **Printing from Exported HTML File**<br>
 You can also get PDF from exported HTML file. Use `Save as PDF` and enable background graphics when printing to keep links working.
@@ -133,7 +133,7 @@ slides, use [alert! slides.alt /]. You can paste screenshots from system tool
 into Clips GUI in side panel. On Linux, you need [alert! xclip /] or [alert! wl-paste /] installed.
 
 ::: note-tip
-    - You might want to reflow content for export purpose. Use checkbox in settings panel to enable it.
+    - You might want to flow content for export purpose. Use checkbox in settings panel to enable it.
     - Print slides with notes by enabling `Inline Notes` option in settings panel before print/export. Notes appear at top to grab immediate attetion of the speaker.
     - Use `Merge Parts` option in settings panel to show all parts of a page/slide as one page/slide.
 """

{ipyslides-7.3.2 → ipyslides-7.3.4}/ipyslides/_base/navigation.py

@@ -3,6 +3,8 @@ Author Notes: Classes in this module should only be instantiated in Slides class
 and then provided to other classes via composition, not inheritance.
 """
 
+from ..utils import update_class
+
 class Navigation:
     def __init__(self, _instanceSlides):
         "Instnace should be inside `Slides` class."
@@ -16,17 +18,15 @@ class Navigation:
         self.btn_next.on_click(self._shift_right)
         
     def _shift_right(self,change):
-        self.widgets.slidebox.remove_class('Prev') # remove backwards animation safely
-        self.widgets.slidebox.remove_class('AnimPrev') # content animation flag
+        update_class(self.widgets.slidebox, 'Prev AnimPrev', False) # remove backwards animation safely
         if change and not self.slides._current.next_frame():
             if self.wprogress.value < self.wprogress.max:
                 self.wprogress.value = self.wprogress.value + 1 # Forwards
             
     def _shift_left(self,change):
-        self.widgets.slidebox.remove_class('Prev') # remove backwards animation safely, need trigger before adding
+        self.widgets.slidebox.remove_class('Prev') # remove backwards animation safely, need trigger before adding, but avoid resetting AnimPrev here
         if change and not self.slides._current.prev_frame():
-            self.widgets.slidebox.add_class('Prev') # Backwards Animation
-            self.widgets.slidebox.add_class('AnimPrev') # content animation flag, need to stay persistent to avoid trigger removal too early
+            update_class(self.widgets.slidebox, 'Prev AnimPrev', True)
             if self.wprogress.value > 0:
                 self.wprogress.value = self.wprogress.value - 1 # Backwards
                

{ipyslides-7.3.2 → ipyslides-7.3.4}/ipyslides/_base/settings.py

@@ -4,6 +4,7 @@ and then provided to other classes via composition, not inheritance.
 """
 import json, re
 import traitlets
+import textwrap
 
 from traitlets import HasTraits, Int, Unicode, Bool, Float, TraitError
 from pathlib import Path
@@ -11,7 +12,7 @@ from inspect import Signature, Parameter
 from ipywidgets.widgets.trait_types import InstanceDict
 
 from ..formatters import code_css, htmlize
-from ..utils import html, today, _clipbox_children, _resolve_img, get_clips_dir, set_dir
+from ..utils import html, today, update_class, _clipbox_children, _resolve_img, get_clips_dir, set_dir
 from . import styles, _layout
 from ..dashlab import disabled
 
@@ -126,21 +127,23 @@ class Footer(ConfigTraits):
     date = Unicode("today", allow_none=True, help="Set date string or use 'today' for current date.")
     controls = Bool(True, help="Show/hide controls like next/prev buttons and clickers in PDF/export mode.")
     progress = Bool(True, help="Show/hide progress bar at bottom of slides.")
-
+    
     def _apply_change(self,change):
         # change is None when called as footer(...), so we update all things together
         self._update_footer() # html content updated
         wgts = self.main._widgets
         wgts._progbar.layout.display = "" if self.progress else "none" # show/hide progress bar
-        wgts.iw._fpad = 23 if any([self.text, self.date, self.section, self.numbering]) else 16 # 16 is same around all sides unless footer needs more
         wgts.controls.layout.visibility = "visible" if self.controls else "hidden"
-        wgts.iw.msg_tojs = 'RESCALE' # sets padding etc
 
         if not self.controls:
             self.main._slides.notify("Navigation controls hidden. But keyboard and edge click is still working!")
         
         for slide in self.main._slides:
             self._set_on(slide) # update footer per slide for print/export
+        
+        hastext = any([self.text, self.date, self.section, self.numbering])
+        update_class(self.main._widgets.mainbox, 'has-footer-text', hastext)
+        wgts.iw.msg_tojs = 'RESCALE' # keep class update first so scale uses latest footer padding
 
     def _running_section_text(self, slide):
         "Get running section title via Slides._sectionindex and return stripped text." 
@@ -192,12 +195,9 @@ class Layout(ConfigTraits):
     centered = Bool(True)
     scroll   = Bool(True)
     width    = Int(100)
-    aspect   = Float(16/9.001, help="Aspect ratio of slides, width/height. Add a small value to avoid exact 16/9, 16/10 etc. which causes bottom border gap in some browsers.")
+    aspect   = Float(16/9, help="Aspect ratio of slides, width/height.")
     ncol_refs = Int(2)
     theme    = Unicode('Jupyter')
-
-    _reflow = False # internal use only
-    _inotes = False # internal use only
     
     @traitlets.validate('width')
     def _limit_width(self, proposal):
@@ -206,6 +206,7 @@ class Layout(ConfigTraits):
         return proposal["value"]
   
     def _apply_change(self, change):
+        self._set_page_css() # set page size for print/export
         if change and change['owner'] == "theme":
             return self.main._update_theme({'owner':'layout'}) # otherwise colors don't apply to icons
         self.main._update_size(change = None) # will reset theme and send RESCALE message
@@ -217,12 +218,27 @@ class Layout(ConfigTraits):
             raise ValueError(f"Theme value expect on the followings: {themes!r}")
         self.main._widgets.theme.value = proposal["value"] # needs a robust update
         return proposal["value"] 
+    
+    @property
+    def _height(self) -> str:
+        "Get height of slides in mm based on aspect and width (210mm)."
+        return f"{round(210 / self.aspect, 2)}mm"
+    
+    def _set_page_css(self):
+        "Set page size and margin for print/export. Must be done once per view to avoid clashes."
+        self.main._widgets.iw._page_css = textwrap.dedent(f'''
+            @page {{
+                margin: 0 !important;
+                size: 210mm {self._height} !important; /* 1pt ~ 0.35mm, so no more than one decimal required */
+            }}
+        ''')
 
 @fix_sig
 class Toggle(ConfigTraits):
     "Toggle ON/OFF checks in settings panel."
-    reflow = Bool(False)
+    flow = Bool(False)
     notes  = Bool(False)
+    inotes = Bool(False)
     toast  = Bool(True)
     focus  = Bool(True, help="Focus on slide area when a slide is built or rebuilt.")
     rebuild= Bool(True, help="Auto rebuild markdown slides when an included notebook-scoped variable is updated.")
@@ -233,7 +249,9 @@ class Toggle(ConfigTraits):
             if widget := getattr(self.main._widgets.checks, trait, None):
                 traitlets.link((self,trait),(widget, "value"))
 
-    def _apply_change(self, change): pass
+    def _apply_change(self, change):
+        update_class(self.main._widgets.mainbox, 'has-flow-content', self.flow) # content flow on/off
+        update_class(self.main._widgets.mainbox, 'has-inline-notes', self.inotes) # inline notes on/off
 
 class AutoUnicode(Unicode):
     def validate(self, obj, value):
@@ -256,7 +274,7 @@ class Logo(ConfigTraits):
     @traitlets.validate('src')
     def _fix_path(self, proposal):
         if isinstance(proposal["value"], Path):
-            return str(Path)
+            return str(proposal["value"])
         return proposal["value"]
 
     def _set_props(self, **kwargs):
@@ -305,9 +323,7 @@ class Settings:
 
         self._widgets.sliders.fontsize.observe(lambda c: self.fonts(size=c.new), names=["value"])
         self._widgets.theme.observe(self._update_theme, names=["value"])
-        self._widgets.checks.reflow.observe(self._update_theme, names=["value"]) # set reflow through layout._reflow
-        self._widgets.checks.inotes.observe(self._update_theme, names=["value"]) # set inline notes through layout._inotes
-        self._widgets.checks.merge.observe(self._set_merge_class, names=["value"])
+        self._widgets.checks.merge.observe(self._set_merge_ctx, names=["value"])
         self._widgets.buttons.print.on_click(self._print_pdf)
         self._wslider.observe(self._update_size, names=["value"])
         self._update_theme({'owner':'layout'})  # Trigger Theme with aspect changed as well
@@ -334,12 +350,10 @@ class Settings:
             raise AttributeError(f"Can't reset attribute {name!r} on {self!r}")
         self.__dict__[name] = value
 
-    def _set_merge_class(self, change=None):
-        if self._widgets.checks.merge.value:
-            self._widgets.mainbox.add_class('SlidesMerged')
-        else:
-            self._widgets.mainbox.remove_class('SlidesMerged')
-
+    def _set_merge_ctx(self, change=None):
+        if curr := self._slides._current:
+            curr.update_display() # force update to reset frames
+        
     def _print_pdf(self, btn):
         if self._slides._next_pending:
             return self._slides.notify(
@@ -368,7 +382,7 @@ class Settings:
         if len(self._slides) < 5 or slide.number == 0:
             return '' # no clicks for few slides or title page
         
-        items = [getattr(item,'_sec_id','') for item in self._slides if item.index <= self._slides._lms_idx] # only before supplemnetal
+        items = [getattr(item,'_sec_id','') for item in self._slides if (item.index or 0) <= self._slides._lms_idx] # only before supplemnetal
         imax = len(items) - 1
         items = [items[int(round(i,0))] for i in [0, imax/4,imax/2, 3*imax/4, imax]]
         labels = '●●●●●'
@@ -400,10 +414,6 @@ class Settings:
                 _layout.layout_css(self._colors['accent'],self.layout.aspect)
             ).value + _layout.loading_style # loading style should be always there
             
-        # before applying style_css theme, set reflow and inotes
-        self.layout._reflow = self._widgets.checks.reflow.value
-        self.layout._inotes = self._widgets.checks.inotes.value
-        
         theme_css = styles.style_css(**self._theme_kws)
         self._widgets.htmls.theme.value = html("style", theme_css).value
         if self._widgets.checks.notes.value:

{ipyslides-7.3.2 → ipyslides-7.3.4}/ipyslides/_base/slide.py

@@ -11,7 +11,7 @@ from ipywidgets import HTML as ipwHTML, VBox
 from . import styles
 from ._layout import background_css, get_unique_css_class, loading_skeleton
 from .styles import collapse_node, hide_node
-from ..utils import XTML, html, _resolve_img, _styled_css, _build_css
+from ..utils import XTML, html, update_class, _resolve_img, _styled_css, _build_css
 from ..xmd import capture_content
 from ..formatters import _Output, widget_from_data, slidebound
 
@@ -135,7 +135,7 @@ class Slide:
         self._has_widgets = False # Update in _build_slide function
         self._has_vars = () # Update in _slide function for markdown slides only
         self._toc_args = () # empty by default
-        self._widget.add_class(f"n{self.number}")
+        self._update_class(add=f"n{self.number}")
         self._fcss = ipwHTML(layout={"margin": "0","padding": "0","heigh": "0"}) # frame separator CSS
         self._bg_ikws = {} # rebuild always re-derives background mapping from content
   
@@ -206,7 +206,7 @@ class Slide:
             # Clean up delimiters: trailing, empty, adjacent PAUSE delimiters
             self._contents = self._cleanup_delimiters(outputs)
             self._contents.extend(self._handle_refs()) # add at end if any
-            self._set_css_classes(remove = 'Out-Sync') # Now synced
+            self._update_class(remove = 'Out-Sync') # Now synced
             self.update_display()    
 
             if self._app.widgets.checks.focus.value: # User preference
@@ -254,8 +254,8 @@ class Slide:
         self._widget.clear_output(wait = True) # Clear, but don't go there
         # Need to know how many contents before user provide content
         with capture_content() as cap:
+            html('span', '', id = self._sec_id, css_class='Slide-UID').display() # to register section id in DOM
             display(VBox([
-                    html('span', '', id = self._sec_id, css_class='Slide-UID').as_widget(), # span to not occupy space, need to remove from frames later.
                     self._bglayer, # background image layer
                     self._ftrhtml, # dynamic footer layer
                     self._fcss, # frame separator CSS
@@ -311,13 +311,9 @@ class Slide:
             if s._section:
                 items.append({"c":"next", "s":s})
         
-        first_toc = True
+        first_toc_slide = next((s for s in self._app[:] if s._toc_args), None)
         for s in self._app[:]:
-            if s._toc_args and first_toc:
-                s._widget.add_class('FirstTOC')
-                first_toc = False
-            else:
-                s._widget.remove_class('FirstTOC')
+            update_class(s._widget, 'main-toc', s is first_toc_slide) # first TOC slide is special
 
         items = [XTML(textwrap.dedent('''
             <li class="toc-item {c}">
@@ -344,7 +340,7 @@ class Slide:
         
         self._frame_idxs = tuple(frames) if len(frames) > 1 else ()
         if self._frame_idxs:
-            self._widget.add_class('HasFrames') # make sure class is added
+            self._update_class(add='HasFrames') # make sure class is added
             self._reveal_frames() # quick preview of how built frames will appear
         elif hasattr(self, '_frame_idxs'): # from previous run may be
             del self._frame_idxs
@@ -365,7 +361,8 @@ class Slide:
 
             # Next PAUSE after columns is ignored if fragments were already built from the COLUMNS output.
             if meta.get("DELIM", "") == "PAUSE":
-                meta_prev = ensure_dict(contents[index - 1].metadata) if index - 1 >= 0 else {}
+                prev_index = index - 1 - offset # actual index in contents list
+                meta_prev = ensure_dict(contents[prev_index].metadata) if prev_index >= 0 else {}
                 if "COLUMNS" in meta_prev and get_frags(meta_prev):
                     continue
 
@@ -397,18 +394,12 @@ class Slide:
     
     def _update_view(self, which):
         self._set_progress()
-        getattr(self._app.widgets.slidebox, 
-            'remove_class' if which == 'next' else 'add_class'
-        )('AnimPrev') # set content animation direction between parts
-        
+        update_class(self._app.widgets.slidebox, 'AnimPrev', which == 'prev') # set content animation direction between parts
         frame = self._fidxs[self.indexf] if self._fidxs else {}
         self._update_transition_objs(animation=False) # avoid animations between frames
 
         if self.index == self._app.wprogress.max: # This is last slide
-            if self.indexf + 1 == self.nf:
-                self._app._box.add_class("InView-Last")
-            else:
-                self._app._box.remove_class("InView-Last")
+            update_class(self._app._box, "InView-Last", self.indexf + 1 == self.nf) # only if last frame
         
         self._app._send_nav_msg(
             which == 'next',
@@ -689,19 +680,13 @@ class Slide:
         if not self._app.this: # Otherwise it has side effects
             self._app.navigate_to(self.index) 
 
-    def _set_css_classes(self, add=None, remove=None):
+    def _update_class(self, add=None, remove=None):
         "Set CSS classes on this slide separated by space. classes are remove first and add after it."
         if remove is not None: # remove first to enable toggle
-            if not isinstance(remove, str):
-                raise TypeError("CSS classes should be a string with each class separated by space")
-            for c in remove.split():
-                self._widget.remove_class(c)
+            update_class(self._widget, remove, False)
         
-        if add is not None:
-            if not isinstance(add, str):
-                raise TypeError("CSS classes should be a string with each class separated by space")
-            for c in add.split():
-                self._widget.add_class(c)
+        if add is not None: # add after remove to enable toggle
+            update_class(self._widget, add, True)
 
     @property
     def _css_class(self):