Function module_from_template

src/py/reactpy/reactpy/web/module.py:79–157

Create a :class:`WebModule` from a framework template This is useful for experimenting with component libraries that do not already support ReactPy's :ref:`Custom Javascript Component` interface. .. warning:: This approach is not recommended for use in a production setting bec

(
    template: str,
    package: str,
    cdn: str = "https://esm.sh",
    fallback: Any | None = None,
    resolve_exports: bool | None = None,
    resolve_exports_depth: int = 5,
    unmount_before_update: bool = False,
)

def module_from_template(
    template: str,
    package: str,
    cdn: str = "https://esm.sh",
    fallback: Any | None = None,
    resolve_exports: bool | None = None,
    resolve_exports_depth: int = 5,
    unmount_before_update: bool = False,
) -> WebModule:
    """Create a :class:`WebModule` from a framework template

    This is useful for experimenting with component libraries that do not already
    support ReactPy's :ref:`Custom Javascript Component` interface.

    .. warning::

        This approach is not recommended for use in a production setting because the
        framework templates may use unpinned dependencies that could change without
        warning. It's best to author a module adhering to the
        :ref:`Custom Javascript Component` interface instead.

    **Templates**

    - ``react``: for modules exporting React components

    Parameters:
        template:
            The name of the framework template to use with the given ``package``.
        package:
            The name of a package to load. May include a file extension (defaults to
            ``.js`` if not given)
        cdn:
            Where the package should be loaded from. The CDN must distribute ESM modules
        fallback:
            What to temporarily display while the module is being loaded.
        resolve_imports:
            Whether to try and find all the named exports of this module.
        resolve_exports_depth:
            How deeply to search for those exports.
        unmount_before_update:
            Cause the component to be unmounted before each update. This option should
            only be used if the imported package fails to re-render when props change.
            Using this option has negative performance consequences since all DOM
            elements must be changed on each render. See :issue:`461` for more info.
    """
    warn(
        "module_from_template() is deprecated due to instability - use the Javascript "
        "Components API instead. This function will be removed in a future release.",
        DeprecationWarning,
    )
    template_name, _, template_version = template.partition("@")
    template_version = "@" + template_version if template_version else ""

    # We do this since the package may be any valid URL path. Thus we may need to strip
    # object parameters or query information so we save the resulting template under the
    # correct file name.
    package_name = urlparse(package).path