Skip to content

Commit

Permalink
chore(deps): update deps (#405)
Browse files Browse the repository at this point in the history
* chore(tools): Update deps

* chore: Fix lints

* chore(deps): update deps in playground and docs
  • Loading branch information
JaimeTorrealba committed May 7, 2024
1 parent 3b8d739 commit 06155f5
Show file tree
Hide file tree
Showing 22 changed files with 2,069 additions and 2,127 deletions.
68 changes: 34 additions & 34 deletions docs/guide/abstractions/levioso.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,34 @@
# Levioso (Float)

<DocsDemo>
<LeviosoDemo />
</DocsDemo>

![Leviosa](https://media.giphy.com/media/HaCFT5ghY6L1m/giphy.gif)

The `cientos` package provides a `<Levioso />` wrapper that makes its content … float, just like Magic 🪄✨

## Usage

```html
<Levioso ref="groupRef">
<TorusKnot :position="[0, 4, 0]">
<TresMeshNormalMaterial />
</TorusKnot>
</Levioso>
```

## Props

| Prop | Description | Default |
| :--------------- | :--------------------------------------------------- | ------------- |
| `speed` | Floating speed, higher it rocks more 🤘. | `1` |
| `rotationFactor` | Factor for Euler rotation. | `1` |
| `floatFactor` | Factor for Up/down movement. | `1` |
| `range` | Range of y-axis values the object will float within. | `[-0.1, 0.1]` |

<style scoped>
img {
width: 100%;
}
</style>
# Levioso (Float)

<DocsDemo>
<LeviosoDemo />
</DocsDemo>

![Leviosa](https://media.giphy.com/media/HaCFT5ghY6L1m/giphy.gif)

The `cientos` package provides a `<Levioso />` wrapper that makes its content … float, just like Magic 🪄✨

## Usage

```html
<Levioso ref="groupRef">
<TorusKnot :position="[0, 4, 0]">
<TresMeshNormalMaterial />
</TorusKnot>
</Levioso>
```

## Props

| Prop | Description | Default |
| :--------------- | :--------------------------------------------------- | ------------- |
| `speed` | Floating speed, higher it rocks more 🤘. | `1` |
| `rotationFactor` | Factor for Euler rotation. | `1` |
| `floatFactor` | Factor for Up/down movement. | `1` |
| `range` | Range of y-axis values the object will float within. | `[-0.1, 0.1]` |

<style scoped>
img {
width: 100%;
}
</style>
Expand Down
106 changes: 53 additions & 53 deletions docs/guide/index.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,53 @@
# Cientos

![Cientos banner](/cientos-banner.png)

> Cientos (Spanish word for "hundreds", pronounced `/θjentos/` ) is a collection of useful ready-to-go helpers and components that are not part of the [core](https://docs.tresjs.org/) package. The name uses the word in Spanish to multiply by 100, to refer to the potential reach of the package to hold amazing abstractions.
The `cientos` package uses [`three-stdlib`](https://github.com/pmndrs/three-stdlib) module under the hood instead of the `three/examples/jsm` module. This means that you don't need to extend the catalogue of components using the `extend` method, `cientos` does it for you.

It just works. 💯

::: info
This package is not required to use the core library, but it improves DX, especially for complex scenes.
:::

## Installation

::: code-group

```bash [pnpm]
pnpm add @tresjs/cientos
```

```bash [npm]
npm install @tresjs/cientos

```

```bash [yarn]
yarn add @tresjs/cientos
```

:::

## Basic Usage

```ts
import { OrbitControls } from '@tresjs/cientos'
```

Now you can use the `OrbitControls` component in your scene.

```html
<template>
<TresCanvas shadows alpha>
<TresPerspectiveCamera :args="[45, 1, 0.1, 1000]" />
<OrbitControls />
</TresCanvas>
</template>
```

::: warning
Notice that you don't need to write the prefix `Tres` such as `<TresOrbitControl />` to use the component
:::
# Cientos

![Cientos banner](/cientos-banner.png)

> Cientos (Spanish word for "hundreds", pronounced `/θjentos/` ) is a collection of useful ready-to-go helpers and components that are not part of the [core](https://docs.tresjs.org/) package. The name uses the word in Spanish to multiply by 100, to refer to the potential reach of the package to hold amazing abstractions.
The `cientos` package uses [`three-stdlib`](https://github.com/pmndrs/three-stdlib) module under the hood instead of the `three/examples/jsm` module. This means that you don't need to extend the catalogue of components using the `extend` method, `cientos` does it for you.

It just works. 💯

::: info
This package is not required to use the core library, but it improves DX, especially for complex scenes.
:::

## Installation

::: code-group

```bash [pnpm]
pnpm add @tresjs/cientos
```

```bash [npm]
npm install @tresjs/cientos

```

```bash [yarn]
yarn add @tresjs/cientos
```

:::

## Basic Usage

```ts
import { OrbitControls } from '@tresjs/cientos'
```

Now you can use the `OrbitControls` component in your scene.

```html
<template>
<TresCanvas shadows alpha>
<TresPerspectiveCamera :args="[45, 1, 0.1, 1000]" />
<OrbitControls />
</TresCanvas>
</template>
```

::: warning
Notice that you don't need to write the prefix `Tres` such as `<TresOrbitControl />` to use the component
:::
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/shapes/box.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The `cientos` package provides a `<Box />` component that serves as a short-cut for a `BoxGeometry` and a `MeshBasicMaterial` with a `Mesh` object.

```typescript
```
args: [
width: number,
height: number,
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/shapes/circle.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The `cientos` package provides a `<Circle />` component that serves as a short-cut for a `CircleGeometry` and a `MeshBasicMaterial` with a `Mesh` object.

```typescript
```
args: [radius: number, segments: number, thetaStart: number, thetaLength: number]
```

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/shapes/cone.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The `cientos` package provides a `<Cone />` component that serves as a short-cut for a `ConeGeometry` and a `MeshBasicMaterial` with a `Mesh` object.

```typescript
```
args: [
radius: number,
height: number,
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/shapes/dodecahedron.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The `cientos` package provides a `<Dodecahedron />` component that serves as a short-cut for a `DodecahedronGeometry` and a `MeshBasicMaterial` with a `Mesh` object.

```typescript
```
args: [radius: number, detail: number]
```

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/shapes/icosahedron.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The `cientos` package provides a `<Icosahedron />` component that serves as a short-cut for a `IcosahedronGeometry` and a `MeshBasicMaterial` with a `Mesh` object.

```typescript
```
args: [radius: number, detail: number]
```

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/shapes/octahedron.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The `cientos` package provides a `<Octahedron />` component that serves as a short-cut for a `OctahedronGeometry` and a `MeshBasicMaterial` with a `Mesh` object.

```typescript
```
args: [radius: number, detail: number]
```

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/shapes/plane.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The `cientos` package provides a `<Plane />` component that serves as a short-cut for a `PlaneGeometry` and a `MeshBasicMaterial` with a `Mesh` object.

```typescript
```
args: [width: number, height: number, widthSegments: number, heightSegments: number]
```

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/shapes/ring.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The `cientos` package provides a `<Ring />` component that serves as a short-cut for a `RingGeometry` and a `MeshBasicMaterial` with a `Mesh` object.

```typescript
```
args: [
innerRadius: number,
outerRadius: number,
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/shapes/rounded-box.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

The `cientos` package provides a `<RoundedBox />` component that serves as a short-cut for a `RoundedBoxGeometry` and a `MeshBasicMaterial` with a `Mesh` object.

```typescript
```
args: [
width: number, // default 1
height: number, // default 1
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/shapes/sphere.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The `cientos` package provides a `<Sphere />` component that serves as a short-cut for a `SphereGeometry` and a `MeshBasicMaterial` with a `Mesh` object.

```typescript
```
args: [
radius: number,
widthSegments: number,
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/shapes/tetrahedron.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The `cientos` package provides a `<Tetrahedron />` component that serves as a short-cut for a `TetrahedronGeometry` and a `MeshBasicMaterial` with a `Mesh` object.

```typescript
```
args: [radius: number, detail: number]
```

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/shapes/torus-knot.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The `cientos` package provides a `<TorusKnot />` component that serves as a short-cut for a `TorusKnotGeometry` and a `MeshBasicMaterial` with a `Mesh` object.

```typescript
```
args: [
radius: number,
tube: number,
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/shapes/torus.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The `cientos` package provides a `<Torus />` component that serves as a short-cut for a `TorusGeometry` and a `MeshBasicMaterial` with a `Mesh` object.

```typescript
```
args: [
radius: number,
tube: number,
Expand Down
4 changes: 2 additions & 2 deletions docs/guide/shapes/tube.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Reference: [TubeGeometry](https://threejs.org/docs/?q=tube#api/en/geometries/Tub

## Usage

```typescript
```
<script>
export default {
setup() {
Expand Down Expand Up @@ -39,7 +39,7 @@ export default {

## Args

```typescript
```
type CurveType = QuadraticBezierCurve3 | CubicBezierCurve3 | CatmullRomCurve3 | LineCurve3
args: [
Expand Down
Loading

0 comments on commit 06155f5

Please sign in to comment.