Types & top-level exports

The S3 type namespace

All public type aliases live in a single re-exported namespace:

import { S3 } from "solid-three"

type Position = S3.Vector3
type Controls = S3.Props<typeof OrbitControls>

The namespace is the re-export of src/types.ts and includes:

• Renderer surface — Renderer, RendererLike, ResolvedRenderer, Register
• Context — Context, Viewport, CameraKind
• Frame loop — FrameListener, FrameListenerCallback, FrameListenerOptions
• Events — ThreeEvent, EventHandlers, CanvasEventHandlers, EventName
• Three representations — Representation, Vector2, Vector3, Vector4, Color, Layers, Quaternion, Euler, Matrix3, Matrix4
• Solid-three metadata — Meta, Data, MapToRepresentation, Props
• Loaders — LoaderData, LoaderUrl
• Utility helpers — AccessorMaybe, PromiseMaybe, Constructor, InstanceOf, Overwrite, Prettify, ConstructorOverloadParameters

The same names are also reachable as named imports, e.g. import type { Context, Props } from "solid-three" — but the namespace form is what the examples in these docs use. A few of the most commonly needed ones — Register (augmentable via declare module "solid-three"), SupportedRenderer, and ResolvedRenderer — are re-exported at the top level too.

All top-level exports

Everything importable from solid-three, and where each is documented.

Components

Hooks

Utilities

Types