Dangers of Mutability Docs

README.md

@@ -1,9 +1,9 @@
 # IDOM · [![Tests](https://github.com/idom-team/idom/workflows/Test/badge.svg?event=push)](https://github.com/idom-team/idom/actions?query=workflow%3ATest) [![PyPI Version](https://img.shields.io/pypi/v/idom.svg)](https://pypi.python.org/pypi/idom) [![License](https://img.shields.io/badge/License-MIT-purple.svg)](https://github.com/idom-team/idom/blob/main/LICENSE)
 
-IDOM is a Python package for making user interfaces. These interfaces are built from
-small elements of functionality like buttons text and images. IDOM allows you to combine
-these elements into reusable "components" that can be composed together to create
-complex views.
+IDOM is a Python web framework for building **interactive websites without needing a
+single line of Javascript**. These sites are built from small elements of functionality
+like buttons text and images. IDOM allows you to combine these elements into reusable
+"components" that can be composed together to create complex views.
 
 Ecosystem independence is also a core feature of IDOM. It can be added to existing
 applications built on a variety of sync and async web servers, as well as integrated

docs/examples.py

@@ -22,7 +22,7 @@ def load_examples() -> Iterator[tuple[str, Callable[[], ComponentType]]]:
 
 def all_example_names() -> set[str]:
     names = set()
-    for file in _iter_example_files():
+    for file in _iter_example_files(SOURCE_DIR):
         path = file.parent if file.name == "app.py" else file
         names.add("/".join(path.relative_to(SOURCE_DIR).with_suffix("").parts))
     return names
@@ -64,12 +64,12 @@ def get_example_files_by_name(
         return [path] if path.exists() else []
 
 
-def _iter_example_files() -> Iterator[Path]:
-    for path in SOURCE_DIR.iterdir():
+def _iter_example_files(root: Path) -> Iterator[Path]:
+    for path in root.iterdir():
         if path.is_dir():
             if not path.name.startswith("_") or path.name == "_examples":
-                yield from path.rglob("*.py")
-        elif path != CONF_FILE and path.suffix == ".py":
+                yield from _iter_example_files(path)
+        elif path.suffix == ".py" and path != CONF_FILE:
             yield path
 
 

docs/source/_custom_js/src/index.js

@@ -25,7 +25,16 @@ export function mountWidgetExample(
   });
 
   const mountEl = document.getElementById(mountID);
+  let isMounted = false;
+  triggerIfInViewport(mountEl, () => {
+    if (!isMounted) {
+      activateView(mountEl, serverInfo, useActivateButton);
+      isMounted = true;
+    }
+  });
+}
 
+function activateView(mountEl, serverInfo, useActivateButton) {
   if (!useActivateButton) {
     mountWithLayoutServer(mountEl, serverInfo);
     return;
@@ -67,3 +76,19 @@ export function mountWidgetExample(
 
   mountEl.appendChild(enableWidgetButton);
 }
+
+function triggerIfInViewport(element, callback) {
+  const observer = new window.IntersectionObserver(
+    ([entry]) => {
+      if (entry.isIntersecting) {
+        callback();
+      }
+    },
+    {
+      root: null,
+      threshold: 0.1, // set offset 0.1 means trigger if atleast 10% of element in viewport
+    }
+  );
+
+  observer.observe(element);
+}

docs/source/_static/css/sphinx-design-overrides.css

@@ -17,3 +17,7 @@ body {
   max-height: 700px;
   overflow: auto;
 }
+
+.sd-card-title .sd-badge {
+  font-size: 1em;
+}