Exported Python API signatures¶

Generated from the source AST by python scripts/generate_api.py. For behavior and runnable examples, read the API guide and hooks reference. Rendering functions require the browser or Node/Pyodide runtime; importing the package itself works in ordinary Python.

The _UNSET default means an optional React argument is omitted. html and svg are dynamic tag namespaces.

Classes¶

ClassComponent¶

Import: pyreact_forge.ClassComponent

ClassComponent(props)

Subclass and decorate with @class_component; render() returns an element.

Lifecycle names use snake_case. set_state accepts a partial dictionary or a function of previous state, with React's ordinary asynchronous merge rules.

PureComponent¶

Import: pyreact_forge.PureComponent

class PureComponent

class_component¶

Import: pyreact_forge.class_component

class_component(cls)

Core¶

Component¶

Import: pyreact_forge.Component

Component(fn: Callable | None=None, *, react_type=None, name=None, native_props=False)

A reusable Python component, invoked by React rather than eagerly.

Context¶

Import: pyreact_forge.Context

Context(default)

Ref¶

Import: pyreact_forge.Ref

class Ref

Root¶

Import: pyreact_forge.Root

class Root

RuntimeRequiredError¶

Import: pyreact_forge.RuntimeRequiredError

class RuntimeRequiredError

activity¶

Import: pyreact_forge.activity

activity(*children, mode='visible')

add_transition_type¶

Import: pyreact_forge.add_transition_type

add_transition_type(name)

cache¶

Import: pyreact_forge.cache

cache(fn)

cache_signal¶

Import: pyreact_forge.cache_signal

cache_signal()

children_count¶

Import: pyreact_forge.children_count

children_count(children)

children_to_array¶

Import: pyreact_forge.children_to_array

children_to_array(children)

clone_element¶

Import: pyreact_forge.clone_element

clone_element(node, *children, **props)

component¶

Import: pyreact_forge.component

component(fn=None, *, name=None)

create_context¶

Import: pyreact_forge.create_context

create_context(default=None)

create_portal¶

Import: pyreact_forge.create_portal

create_portal(children, container, key=None)

create_ref¶

Import: pyreact_forge.create_ref

create_ref()

create_root¶

Import: pyreact_forge.create_root

create_root(container='root', *, identifier_prefix='')

debug_stats¶

Import: pyreact_forge.debug_stats

debug_stats()

error_boundary¶

Import: pyreact_forge.error_boundary

error_boundary(*children, fallback=None, reset_key=None)

flush_sync¶

Import: pyreact_forge.flush_sync

flush_sync(fn)

forward_ref¶

Import: pyreact_forge.forward_ref

forward_ref(fn)

fragment¶

Import: pyreact_forge.fragment

fragment(*children, **props)

h¶

Import: pyreact_forge.h

h(type_, *children, **props)

Create an element. HTML/SVG use snake_case props; Python props stay intact.

html¶

Import: pyreact_forge.html

Dynamic tag namespace: for example html.div(...), svg.circle(...) or html("custom-element", ...).

hydrate_root¶

Import: pyreact_forge.hydrate_root

hydrate_root(container, node, *, identifier_prefix='')

import_component¶

Import: pyreact_forge.import_component

import_component(name)

Use a JS React component registered with registerComponent(name, value).

is_valid_element¶

Import: pyreact_forge.is_valid_element

is_valid_element(node)

lazy¶

Import: pyreact_forge.lazy

lazy(loader)

map_children¶

Import: pyreact_forge.map_children

map_children(children, fn)

memo¶

Import: pyreact_forge.memo

memo(type_: Component, compare=None)

mount¶

Import: pyreact_forge.mount

mount(node, container='root', *, strict=False)

preconnect¶

Import: pyreact_forge.preconnect

preconnect(href, **options)

prefetch_dns¶

Import: pyreact_forge.prefetch_dns

prefetch_dns(href)

preinit¶

Import: pyreact_forge.preinit

preinit(href, **options)

preinit_module¶

Import: pyreact_forge.preinit_module

preinit_module(href, **options)

preload¶

Import: pyreact_forge.preload

preload(href, **options)

preload_module¶

Import: pyreact_forge.preload_module

preload_module(href, **options)

profiler¶

Import: pyreact_forge.profiler

profiler(*children, id, on_render)

request_form_reset¶

Import: pyreact_forge.request_form_reset

request_form_reset(form)

runtime_capabilities¶

Import: pyreact_forge.runtime_capabilities

runtime_capabilities()

strict_mode¶

Import: pyreact_forge.strict_mode

strict_mode(*children)

suspense¶

Import: pyreact_forge.suspense

suspense(*children, fallback=None)

svg¶

Import: pyreact_forge.svg

Dynamic tag namespace: for example html.div(...), svg.circle(...) or html("custom-element", ...).

view_transition¶

Import: pyreact_forge.view_transition

view_transition(*children, **props)

Hooks¶

start_transition¶

Import: pyreact_forge.start_transition

start_transition(fn)

use¶

Import: pyreact_forge.use

use(promise_or_context)

use_action_state¶

Import: pyreact_forge.use_action_state

use_action_state(action, initial, permalink=None)

use_callback¶

Import: pyreact_forge.use_callback

use_callback(fn, dependencies)

use_context¶

Import: pyreact_forge.use_context

use_context(context)

use_debug_value¶

Import: pyreact_forge.use_debug_value

use_debug_value(value, formatter=None)

use_deferred_value¶

Import: pyreact_forge.use_deferred_value

use_deferred_value(value, initial=_UNSET)

use_effect¶

Import: pyreact_forge.use_effect

use_effect(effect, dependencies=None)

use_effect_event¶

Import: pyreact_forge.use_effect_event

use_effect_event(fn)

use_form_status¶

Import: pyreact_forge.use_form_status

use_form_status()

use_id¶

Import: pyreact_forge.use_id

use_id()

use_imperative_handle¶

Import: pyreact_forge.use_imperative_handle

use_imperative_handle(ref, create_handle, dependencies=None)

use_insertion_effect¶

Import: pyreact_forge.use_insertion_effect

use_insertion_effect(effect, dependencies=None)

use_layout_effect¶

Import: pyreact_forge.use_layout_effect

use_layout_effect(effect, dependencies=None)

use_memo¶

Import: pyreact_forge.use_memo

use_memo(factory, dependencies)

use_optimistic¶

Import: pyreact_forge.use_optimistic

use_optimistic(value, reducer=None)

use_reducer¶

Import: pyreact_forge.use_reducer

use_reducer(reducer, initial, initializer=None)

use_ref¶

Import: pyreact_forge.use_ref

use_ref(initial=None)

use_state¶

Import: pyreact_forge.use_state

use_state(initial=None)

use_sync_external_store¶

Import: pyreact_forge.use_sync_external_store

use_sync_external_store(subscribe, get_snapshot, get_server_snapshot=None)

use_transition¶

Import: pyreact_forge.use_transition

use_transition()

Resource¶

Resource¶

Import: pyreact_forge.Resource

Resource(loader)

resource¶

Import: pyreact_forge.resource

resource(loader)

Optional router¶

Link¶

Import: pyreact_forge.router.Link

Link(children=None, href='/', **props)

Router¶

Import: pyreact_forge.router.Router

Router(routes, not_found=None)

match_path¶

Import: pyreact_forge.router.match_path

match_path(pattern, path)

Match literal paths, :parameters and a trailing *; query/hash are ignored.

navigate¶

Import: pyreact_forge.router.navigate

navigate(path, *, replace=False)

use_location¶

Import: pyreact_forge.router.use_location

use_location()