Function make_vdom_constructor

src/py/reactpy/reactpy/core/vdom.py:213–244

Return a constructor for VDOM dictionaries with the given tag name. The resulting callable will have the same interface as :func:`vdom` but without its first ``tag`` argument.

(
    tag: str, allow_children: bool = True, import_source: ImportSourceDict | None = None
)

def make_vdom_constructor(
    tag: str, allow_children: bool = True, import_source: ImportSourceDict | None = None
) -> VdomDictConstructor:
    """Return a constructor for VDOM dictionaries with the given tag name.

    The resulting callable will have the same interface as :func:`vdom` but without its
    first ``tag`` argument.
    """

    def constructor(*attributes_and_children: Any, **kwargs: Any) -> VdomDict:
        model = vdom(tag, *attributes_and_children, **kwargs)
        if not allow_children and "children" in model:
            msg = f"{tag!r} nodes cannot have children."
            raise TypeError(msg)
        if import_source:
            model["importSource"] = import_source
        return model

    # replicate common function attributes
    constructor.__name__ = tag
    constructor.__doc__ = (
        "Return a new "
        f"`<{tag}> <https://developer.mozilla.org/en-US/docs/Web/HTML/Element/{tag}>`__ "
        "element represented by a :class:`VdomDict`."
    )

    module_name = f_module_name(1)
    if module_name:
        constructor.__module__ = module_name
        constructor.__qualname__ = f"{module_name}.{tag}"

    return cast(VdomDictConstructor, constructor)


def custom_vdom_constructor(func: _CustomVdomDictConstructor) -> VdomDictConstructor: