Skip to content

Commit

Permalink
Merge branch 'main' of github.com:pmndrs/uikit
Browse files Browse the repository at this point in the history
  • Loading branch information
bbohlender committed Apr 11, 2024
2 parents 7d459fb + d4df084 commit 5c5d643
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Build performant 3D user interfaces for **Three.js** using **@react-three/fiber*
npm install three @react-three/fiber @react-three/uikit
```

### What does it look like ?
### 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](./docs/getting-started/basic-example.gif) |
| --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
Expand All @@ -36,7 +36,7 @@ createRoot(document.getElementById('root')).render(
)
```

## Pre-Styled Component Kits
## 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.

Expand All @@ -48,25 +48,25 @@ We provide multiple kits containing **themable pre-styled components**. Inspired
| [View All Components](https://docs.pmnd.rs/uikit/kits/default) | [View All Components](https://docs.pmnd.rs/uikit/kits/apfel) |
| `npx uikit component add default Button` | `npx uikit component add apfel Button` |

## How to get started?
## How to get started

> Some familiarity with
> react, threejs, and @react-three/fiber, is recommended.
Get started with **[building your first layout](https://docs.pmnd.rs/uikit/getting-started/first-layout)**, take a look at our **[examples](https://docs.pmnd.rs/uikit/getting-started/examples)** to see uikit in action, or learn more about:

- [All components and their properties](https://docs.pmnd.rs/uikit/getting-started/components-and-properties)
- [Interacitivity](https://docs.pmnd.rs/uikit/tutorials/interactivity)
- [Interactivity](https://docs.pmnd.rs/uikit/tutorials/interactivity)
- [Custom materials](https://docs.pmnd.rs/uikit/tutorials/custom-materials)
- [Custom fonts](https://docs.pmnd.rs/uikit/tutorials/custom-fonts)
- [Responsivene user interfaces](https://docs.pmnd.rs/uikit/tutorials/responsive)
- [Responsive user interfaces](https://docs.pmnd.rs/uikit/tutorials/responsive)
- [Scrolling](https://docs.pmnd.rs/uikit/tutorials/scroll)
- [Sizing](https://docs.pmnd.rs/uikit/tutorials/sizing)
- [Common pitfalls](https://docs.pmnd.rs/uikit/advanced/pitfalls)
- [Optimize performance](https://docs.pmnd.rs/uikit/advanced/performance)
- [Theming components](https://docs.pmnd.rs/uikit/kits/theming)

## Migration Guides
## Migration guides

- from [Koestlich](https://docs.pmnd.rs/uikit/migration/from-koestlich)
- from [HTML/CSS](https://docs.pmnd.rs/uikit/migration/from-html-css)
Expand Down
14 changes: 7 additions & 7 deletions docs/getting-started/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Build performant 3D user interfaces for **Three.js** using **@react-three/fiber*
npm install three @react-three/fiber @react-three/uikit
```

### What does it look like ?
### 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](./basic-example.gif) |
| ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ |
Expand All @@ -35,7 +35,7 @@ createRoot(document.getElementById('root')).render(
)
```

## Pre-Styled Component Kits
## 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`
Expand All @@ -46,26 +46,26 @@ We provide multiple kits containing **themable pre-styled components**. Inspired
| [View All Components](../kits/default.md) | [View All Components](../kits/apfel.md) |
| `npx uikit component add default Button` | `npx uikit component add apfel Button` |

## How to get started?
## How to get started

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

Get started with **[building your first layout](./first-layout.md)**, take a look at our **[examples](./examples.md)** to see uikit in action, or learn more about:

- [All components and their properties](./components-and-properties.md)
- [Interacitivity](../tutorials/interactivity.md)
- [Interactivity](../tutorials/interactivity.md)
- [Custom materials](../tutorials/custom-materials.md)
- [Custom fonts](../tutorials/custom-fonts.md)
- [Responsivene user interfaces](../tutorials/responsive.md)
- [Responsive user interfaces](../tutorials/responsive.md)
- [Scrolling](../tutorials/scroll.md)
- [Sizing](../tutorials/sizing.md)
- [Common pitfalls](../advanced/pitfalls.md)
- [Optimize performance](../advanced/performance.md)
- [Theming components](../kits/theming.md)

## Migration Guides
## Migration guides

- from [Koestlich](../migration/from-koestlich.md)
- from [HTML/CSS](../migration/from-html-css.md)
- from [Tailwind](../migration/from-tailwind.md)
- from [Tailwind](../migration/from-tailwind.md)

0 comments on commit 5c5d643

Please sign in to comment.