Skip to content
forked from pmndrs/uikit

🎨 user interfaces for react-three-fiber

License

Notifications You must be signed in to change notification settings

mattrossman/uikit

 
 

Repository files navigation

uikit

Version Downloads Twitter Discord

uikit banner

Build performant 3D user interfaces for Three.js using @react-three/fiber and yoga with support for nested scrolling, buttons, inputs, dropdowns, tabs, checkboxes, and more.

Perfect for games, XR (VR/AR), and any web-based Spatial Computing App.

npm install three @react-three/fiber @react-three/uikit

What does it look like ?

A simple UI with 2 containers horizontally aligned, rendered in fullscreen. When the user hovers over a container, the container's opacity changes. render of the above code
import { createRoot } from 'react-dom/client'
import React from 'react'
import { Canvas } from '@react-three/fiber'
import { Fullscreen, Container } from '@react-three/uikit'

createRoot(document.getElementById('root')).render(
  <Canvas>
    <Fullscreen flexDirection="row" padding={100} gap={100}>
      <Container flexGrow={1} backgroundOpacity={0.5} hover={{ backgroundOpacity: 1 }} backgroundColor="red" />
      <Container flexGrow={1} backgroundOpacity={0.5} hover={{ backgroundOpacity: 1 }} backgroundColor="blue" />
    </Fullscreen>
  </Canvas>,
)

Pre-Styled Component Kits

We provide multiple kits containing themable pre-styled components. Inspired by shadcn, you can use our CLI to install the source code of any component to your desired loaction with one command.

For example, to add the button from the default kit, run: npx uikit component add default Button

default

based on Shadcn

apfel

inspired by AVP
Overview over all default components Overview over all apfel components
View All Components View All Components
npx uikit component add default Button npx uikit component add apfel Button

How to get started?

Some familiarity with react, threejs, and @react-three/fiber, is recommended.

Get started with building your first layout, take a look at our examples to see uikit in action, or learn more about:

Migration Guides

About

🎨 user interfaces for react-three-fiber

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 99.5%
  • JavaScript 0.5%