react

Import

Import

import * as api from "@fungi.computer/sprite/react";

Exports

Kind	Export	Description
Ttype alias	SpriteProps	Avatar presentation plus ordinary attributes for the DOM host.
constconstant	Sprite	Own one player; source and appearance changes do not remount its React host.
fnfunction	SpriteProvider()	Shell-owned renderer and asset configuration; no selected identity lives here.

SpritePropsTtype alias

Signature

type SpriteProps = AvatarPresentation &
  Omit<HTMLAttributes<HTMLDivElement>, "children"> &
  object;

Avatar presentation plus ordinary attributes for the DOM host.

Type Declaration

Name	Type	Description
service?	SpriteService	Optional for standalone use; a shell normally supplies SpriteProvider.
paused?	boolean	-
onState()?	(state) => void	Observe loading, ready, error, and disposal changes.

Spriteconstconstant

Signature

const Sprite: ForwardRefExoticComponent<
  AvatarPresentation &
    Omit<HTMLAttributes<HTMLDivElement>, "children"> &
    object &
    RefAttributes<HTMLDivElement>
>;

Own one player; source and appearance changes do not remount its React host.

SpriteProvider()fnfunction

Signature

function SpriteProvider(__namedParameters): Element;

Shell-owned renderer and asset configuration; no selected identity lives here.

Parameters

Parameter	Type
__namedParameters	{ service: SpriteService; children: ReactNode; }
__namedParameters.service	SpriteService
__namedParameters.children	ReactNode

Returns

Element