rename hasMount to exportsMount

also removes forgotten console.error for
having children if exportsMount

Author: rmorshea

docs/source/faq.rst

@@ -49,7 +49,7 @@ Yes, but with some restrictions:
 1. The Javascript in question must be distributed as an ECMAScript Module
    (`ESM <https://hacks.mozilla.org/2018/03/es-modules-a-cartoon-deep-dive/>`__)
 2. The module must export a ``mount(element, component, props)`` function
-3. Set ``has_mount=True`` when creating your :class:`~idom.client.module.Module`
+3. Set ``exports_mount=True`` when creating your :class:`~idom.client.module.Module`
    instance.
 
 These restrictions apply because the Javascript from the CDN must be able to run

src/idom/client/app/packages/idom-client-react/src/index.js

@@ -69,6 +69,7 @@ function ImportedElement({ model }) {
       mountImportSource(mountPoint.current, module, model, config);
     });
   });
+
   return html`<div ref=${mountPoint} />`;
 }
 
@@ -138,10 +139,7 @@ function eventHandler(sendEvent, eventSpec) {
 }
 
 function mountImportSource(element, module, model, config) {
-  if (model.importSource.hasMount) {
-    if (model.children) {
-      console.error("Mount function does not support children");
-    }
+  if (model.importSource.exportsMount) {
     const props = elementAttributes(model, config.sendEvent);
     if (model.children) {
       props.children = model.children;

src/idom/client/module.py

@@ -38,7 +38,7 @@ def install(
     ignore_installed: bool = False,
     fallback: Optional[str] = None,
     # dynamically installed modules probably won't have a mount so we default to False
-    has_mount: bool = False,
+    exports_mount: bool = False,
 ) -> Union[Module, List[Module]]:
     return_one = False
     if isinstance(packages, str):
@@ -51,10 +51,11 @@ def install(
         manage.build(packages, clean_build=False)
 
     if return_one:
-        return Module(pkg_names[0], fallback=fallback, has_mount=has_mount)
+        return Module(pkg_names[0], fallback=fallback, exports_mount=exports_mount)
     else:
         return [
-            Module(pkg, fallback=fallback, has_mount=has_mount) for pkg in pkg_names
+            Module(pkg, fallback=fallback, exports_mount=exports_mount)
+            for pkg in pkg_names
         ]
 
 
@@ -74,7 +75,7 @@ class Module:
             ``./some-other-installed-module.js``.
         fallack:
             What to display while the modules is being loaded.
-        has_mount:
+        exports_mount:
             Whether the module exports a ``mount`` function that allows components to
             be mounted directly to the DOM. Such a mount function enables greater
             flexibility in how custom components can be implemented.
@@ -90,7 +91,7 @@ class Module:
         "url",
         "fallback",
         "exports",
-        "has_mount",
+        "exports_mount",
         "check_exports",
         "_export_names",
     )
@@ -100,11 +101,11 @@ def __init__(
         url_or_name: str,
         source_file: Optional[Union[str, Path]] = None,
         fallback: Optional[str] = None,
-        has_mount: bool = False,
+        exports_mount: bool = False,
         check_exports: bool = True,
     ) -> None:
         self.fallback = fallback
-        self.has_mount = has_mount
+        self.exports_mount = exports_mount
         self.check_exports = check_exports
 
         self.exports: Set[str] = set()
@@ -126,9 +127,9 @@ def __init__(
         else:
             raise ValueError(f"{url_or_name!r} is not installed or is not a URL")
 
-        if check_exports and has_mount and "mount" not in self.exports:
+        if check_exports and exports_mount and "mount" not in self.exports:
             raise ValueError(
-                f"Module {url_or_name!r} does not export 'mount' but has_mount=True"
+                f"Module {url_or_name!r} does not export 'mount' but exports_mount=True"
             )
 
     def declare(
@@ -157,7 +158,7 @@ def declare(
             self.url,
             name,
             has_children=has_children,
-            has_mount=self.has_mount,
+            exports_mount=self.exports_mount,
             fallback=fallback or self.fallback,
         )
 
@@ -190,10 +191,10 @@ def __init__(
         module: str,
         name: str,
         has_children: bool = True,
-        has_mount: bool = False,
+        exports_mount: bool = False,
         fallback: Optional[str] = None,
     ) -> None:
-        if IDOM_CLIENT_MODULES_MUST_HAVE_MOUNT.current and not has_mount:
+        if IDOM_CLIENT_MODULES_MUST_HAVE_MOUNT.current and not exports_mount:
             # This check is not perfect since IDOM_CLIENT_MODULES_MUST_HAVE_MOUNT can be
             # set after Import instances have been constructed. A more comprehensive
             # check can be introduced if that is shown to be an issue in practice.
@@ -203,7 +204,7 @@ def __init__(
         self._name = name
         self._constructor = make_vdom_constructor(name, has_children)
         self._import_source = ImportSourceDict(
-            source=module, fallback=fallback, hasMount=has_mount
+            source=module, fallback=fallback, exportsMount=exports_mount
         )
 
     def __call__(

src/idom/config.py

@@ -76,8 +76,8 @@ def all_options() -> List[_Option[Any]]:
 
 Client implementations that do not support dynamically installed modules can set this
 option to block the usages of components that are not mounted in isolation. More
-specifically, this requires the ``has_mount`` option of :class:`~idom.client.module.Module`
-to be ``True``.
+specifically, this requires the ``exports_mount`` option of
+:class:`~idom.client.module.Module` to be ``True``.
 """
 
 IDOM_FEATURE_INDEX_AS_DEFAULT_KEY = _Option(

src/idom/core/vdom.py

@@ -58,7 +58,7 @@
                     "if": {"not": {"type": "null"}},
                     "then": {"$ref": "#/definitions/elementOrString"},
                 },
-                "hasMount": {"type": "boolean"},
+                "exportsMount": {"type": "boolean"},
             },
             "required": ["source"],
         },
@@ -84,7 +84,7 @@ def validate_vdom(value: Any) -> None:
 class ImportSourceDict(TypedDict):
     source: str
     fallback: Any
-    hasMount: bool  # noqa
+    exportsMount: bool  # noqa
 
 
 class _VdomDictOptional(TypedDict, total=False):

tests/test_client/test_app.py

@@ -50,7 +50,7 @@ def test_vanilla_js_component_with_mount(driver, display):
     vanilla_js_component = Module(
         "vanilla-js-component",
         source_file=HERE / "js" / "vanilla-js-component.js",
-        has_mount=True,
+        exports_mount=True,
     )
 
     @idom.component

tests/test_client/test_module.py

@@ -31,7 +31,7 @@ def test_any_relative_or_abolute_url_allowed():
 def test_module_import_repr():
     assert (
         repr(Module("/absolute/url/module").declare("SomeComponent"))
-        == "Import(name='SomeComponent', source='/absolute/url/module', fallback=None, hasMount=False)"
+        == "Import(name='SomeComponent', source='/absolute/url/module', fallback=None, exportsMount=False)"
     )
 
 
@@ -99,16 +99,18 @@ def test_idom_client_modules_must_have_mount():
             idom.Import(
                 "https://some.url",
                 "SomeComponent",
-                has_mount=False,
+                exports_mount=False,
             )
     finally:
         IDOM_CLIENT_MODULES_MUST_HAVE_MOUNT.current = old_opt
 
 
-def test_module_must_export_mount_if_has_mount_is_set():
-    with pytest.raises(ValueError, match="does not export 'mount' but has_mount=True"):
+def test_module_must_export_mount_if_exports_mount_is_set():
+    with pytest.raises(
+        ValueError, match="does not export 'mount' but exports_mount=True"
+    ):
         idom.Module(
             "component-without-mount",
             source_file=JS_FIXTURES / "component-without-mount.js",
-            has_mount=True,
+            exports_mount=True,
         )