Fix some options not working bug

Author: blueswen

CHANGELOG

@@ -1,3 +1,7 @@
+mkdocs-glightbox-0.1.6 (2022-07-16)
+
+    * Fix some options not working bug
+
 mkdocs-glightbox-0.1.5 (2022-07-16)
 
     * Fix mkdocs-material header + sidebar vanishing issue when open lightbox (Inspired from https://github.com/biati-digital/glightbox/issues/22)

README.md

@@ -5,7 +5,7 @@
 
 A MkDocs plugin supports image lightbox with [GLightbox](https://github.com/biati-digital/glightbox).
 
-GLightbox is pure Javascript lightbox library with mobile support.
+GLightbox is a pure javascript lightbox library with mobile support.
 
 [Live demo](https://blueswen.github.io/mkdocs-glightbox/) with [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) theme.
 
@@ -36,7 +36,7 @@ GLightbox is pure Javascript lightbox library with mobile support.
     ```yaml
     plugins:
        - glightbox:
-           touchNavigation: false
+           touchNavigation: true
            loop: false
            effect: zoom
            width: 100%
@@ -48,12 +48,12 @@ GLightbox is pure Javascript lightbox library with mobile support.
     | Option          | Default | Description                                                                                                  |
     |-----------------|---------|--------------------------------------------------------------------------------------------------------------|
     | touchNavigation | true    | Enable or disable the touch navigation (swipe).                                                              |
-    | loop            | true    | Loop slides on end.                                                                                          |
+    | loop            | false   | Loop slides on end.                                                                                          |
     | effect          | zoom    | Name of the effect on lightbox open. (zoom, fade, none)                                                      |
     | width           | 100%    | Default width for inline elements and iframes. You can use any unit for example 90% or 100vw for full width. |
     | height          | auto    | Default height for inline elements and iframes. You can use any unit for example 90%, 100vh or auto.         |
-    | zoomable        | True    | Enable or disable zoomable images.                                                                           |
-    | draggable       | True    | Enable or disable mouse drag to go prev and next slide.                                                      |
+    | zoomable        | true    | Enable or disable zoomable images.                                                                           |
+    | draggable       | true    | Enable or disable mouse drag to go prev and next slide.                                                      |
 
     Check more options information on [GLightbox Docs](https://github.com/biati-digital/glightbox#lightbox-options).
 

mkdocs_glightbox/plugin.py

@@ -15,9 +15,9 @@ class LightboxPlugin(BasePlugin):
     """ Add lightbox to MkDocs """
 
     config_scheme = (
-        ("touchNavigation", config_options.Type(bool, default=False)),
+        ("touchNavigation", config_options.Type(bool, default=True)),
         ("loop", config_options.Type(bool, default=False)),
-        ("effect", config_options.Type(str, default="zoom")),
+        ("effect", config_options.Choice(("zoom", "fade", "none"), default="zoom")),
         ("width", config_options.Type(str, default="100%")),
         ("height", config_options.Type(str, default="auto")),
         ("zoomable", config_options.Type(bool, default=True)),
@@ -50,8 +50,10 @@ def on_post_page(self, output, page, config, **kwargs):
             soup.head.append(js_script)
 
             js_code = soup.new_tag("script")
-            lb_config = dict(self.config)
-            lb_config = {k: lb_config[k] for k in ["touchNavigation", "loop"]}
+            plugin_config = dict(self.config)
+            lb_config = {k: plugin_config[k] for k in ["touchNavigation", "loop", "width", "height", "zoomable", "draggable"]}
+            lb_config['openEffect'] = plugin_config.get('effect', 'zoom')
+            lb_config['closeEffect'] = plugin_config.get('effect', 'zoom')
             js_code.string = f"const lightbox = GLightbox({json.dumps(lb_config)});"
             if config["theme"].name == "material" or "navigation.instant" in config["theme"]._vars.get("features", []):
                 # support compatible with mkdocs-material Instant loading feature
@@ -62,18 +64,12 @@ def on_post_page(self, output, page, config, **kwargs):
 
     def on_page_content(self, html, page, config, **kwargs):
         """ Wrap img tag with archive tag with glightbox class and attributes from config """
-
-        lb_data_config = dict(self.config)
-        lb_data_config = {k: lb_data_config[k] for k in [
-            "effect", "width", "height", "zoomable", "draggable"]}
         soup = BeautifulSoup(html, "html.parser")
         imgs = soup.find_all("img")
         for img in imgs:
             a = soup.new_tag("a")
             a["class"] = "glightbox"
             a["href"] = img.get("src", "")
-            for key, val in lb_data_config.items():
-                a[f"data-{key}"] = val
             img.wrap(a)
         return str(soup)
 

setup.py

@@ -6,7 +6,7 @@
 
 setup(
     name="mkdocs-glightbox",
-    version="0.1.5",
+    version="0.1.6",
     author="Blueswen",
     author_email="[email protected]",
     url = "https://blueswen.github.io/mkdocs-glightbox",