Skip to content

Commit 06155f5

Browse files
JaimeTorrealbaJaimeTorrealba
authored
chore(deps): update deps (#405)
* chore(tools): Update deps * chore: Fix lints * chore(deps): update deps in playground and docs
1 parent 3b8d739 commit 06155f5

22 files changed

+2069
-2127
lines changed

‎docs/guide/abstractions/levioso.md

+34-34
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
1-
# Levioso (Float)
2-
3-
<DocsDemo>
4-
<LeviosoDemo />
5-
</DocsDemo>
6-
7-
![Leviosa](https://media.giphy.com/media/HaCFT5ghY6L1m/giphy.gif)
8-
9-
The `cientos` package provides a `<Levioso />` wrapper that makes its content … float, just like Magic 🪄✨
10-
11-
## Usage
12-
13-
```html
14-
<Levioso ref="groupRef">
15-
<TorusKnot :position="[0, 4, 0]">
16-
<TresMeshNormalMaterial />
17-
</TorusKnot>
18-
</Levioso>
19-
```
20-
21-
## Props
22-
23-
| Prop | Description | Default |
24-
| :--------------- | :--------------------------------------------------- | ------------- |
25-
| `speed` | Floating speed, higher it rocks more 🤘. | `1` |
26-
| `rotationFactor` | Factor for Euler rotation. | `1` |
27-
| `floatFactor` | Factor for Up/down movement. | `1` |
28-
| `range` | Range of y-axis values the object will float within. | `[-0.1, 0.1]` |
29-
30-
<style scoped>
31-
img {
32-
width: 100%;
33-
}
34-
</style>
1+
# Levioso (Float)
2+
3+
<DocsDemo>
4+
<LeviosoDemo />
5+
</DocsDemo>
6+
7+
![Leviosa](https://media.giphy.com/media/HaCFT5ghY6L1m/giphy.gif)
8+
9+
The `cientos` package provides a `<Levioso />` wrapper that makes its content … float, just like Magic 🪄✨
10+
11+
## Usage
12+
13+
```html
14+
<Levioso ref="groupRef">
15+
<TorusKnot :position="[0, 4, 0]">
16+
<TresMeshNormalMaterial />
17+
</TorusKnot>
18+
</Levioso>
19+
```
20+
21+
## Props
22+
23+
| Prop | Description | Default |
24+
| :--------------- | :--------------------------------------------------- | ------------- |
25+
| `speed` | Floating speed, higher it rocks more 🤘. | `1` |
26+
| `rotationFactor` | Factor for Euler rotation. | `1` |
27+
| `floatFactor` | Factor for Up/down movement. | `1` |
28+
| `range` | Range of y-axis values the object will float within. | `[-0.1, 0.1]` |
29+
30+
<style scoped>
31+
img {
32+
width: 100%;
33+
}
34+
</style>

‎docs/guide/index.md

+53-53
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,53 @@
1-
# Cientos
2-
3-
![Cientos banner](/cientos-banner.png)
4-
5-
> 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.
6-
7-
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.
8-
9-
It just works. 💯
10-
11-
::: info
12-
This package is not required to use the core library, but it improves DX, especially for complex scenes.
13-
:::
14-
15-
## Installation
16-
17-
::: code-group
18-
19-
```bash [pnpm]
20-
pnpm add @tresjs/cientos
21-
```
22-
23-
```bash [npm]
24-
npm install @tresjs/cientos
25-
26-
```
27-
28-
```bash [yarn]
29-
yarn add @tresjs/cientos
30-
```
31-
32-
:::
33-
34-
## Basic Usage
35-
36-
```ts
37-
import { OrbitControls } from '@tresjs/cientos'
38-
```
39-
40-
Now you can use the `OrbitControls` component in your scene.
41-
42-
```html
43-
<template>
44-
<TresCanvas shadows alpha>
45-
<TresPerspectiveCamera :args="[45, 1, 0.1, 1000]" />
46-
<OrbitControls />
47-
</TresCanvas>
48-
</template>
49-
```
50-
51-
::: warning
52-
Notice that you don't need to write the prefix `Tres` such as `<TresOrbitControl />` to use the component
53-
:::
1+
# Cientos
2+
3+
![Cientos banner](/cientos-banner.png)
4+
5+
> 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.
6+
7+
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.
8+
9+
It just works. 💯
10+
11+
::: info
12+
This package is not required to use the core library, but it improves DX, especially for complex scenes.
13+
:::
14+
15+
## Installation
16+
17+
::: code-group
18+
19+
```bash [pnpm]
20+
pnpm add @tresjs/cientos
21+
```
22+
23+
```bash [npm]
24+
npm install @tresjs/cientos
25+
26+
```
27+
28+
```bash [yarn]
29+
yarn add @tresjs/cientos
30+
```
31+
32+
:::
33+
34+
## Basic Usage
35+
36+
```ts
37+
import { OrbitControls } from '@tresjs/cientos'
38+
```
39+
40+
Now you can use the `OrbitControls` component in your scene.
41+
42+
```html
43+
<template>
44+
<TresCanvas shadows alpha>
45+
<TresPerspectiveCamera :args="[45, 1, 0.1, 1000]" />
46+
<OrbitControls />
47+
</TresCanvas>
48+
</template>
49+
```
50+
51+
::: warning
52+
Notice that you don't need to write the prefix `Tres` such as `<TresOrbitControl />` to use the component
53+
:::

‎docs/guide/shapes/box.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

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

7-
```typescript
7+
```
88
args: [
99
width: number,
1010
height: number,

‎docs/guide/shapes/circle.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

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

7-
```typescript
7+
```
88
args: [radius: number, segments: number, thetaStart: number, thetaLength: number]
99
```
1010

‎docs/guide/shapes/cone.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

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

7-
```typescript
7+
```
88
args: [
99
radius: number,
1010
height: number,

‎docs/guide/shapes/dodecahedron.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

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

7-
```typescript
7+
```
88
args: [radius: number, detail: number]
99
```
1010

‎docs/guide/shapes/icosahedron.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

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

7-
```typescript
7+
```
88
args: [radius: number, detail: number]
99
```
1010

‎docs/guide/shapes/octahedron.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

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

7-
```typescript
7+
```
88
args: [radius: number, detail: number]
99
```
1010

‎docs/guide/shapes/plane.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

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

7-
```typescript
7+
```
88
args: [width: number, height: number, widthSegments: number, heightSegments: number]
99
```
1010

‎docs/guide/shapes/ring.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

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

7-
```typescript
7+
```
88
args: [
99
innerRadius: number,
1010
outerRadius: number,

‎docs/guide/shapes/rounded-box.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

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

9-
```typescript
9+
```
1010
args: [
1111
width: number, // default 1
1212
height: number, // default 1

‎docs/guide/shapes/sphere.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

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

7-
```typescript
7+
```
88
args: [
99
radius: number,
1010
widthSegments: number,

‎docs/guide/shapes/tetrahedron.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

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

7-
```typescript
7+
```
88
args: [radius: number, detail: number]
99
```
1010

‎docs/guide/shapes/torus-knot.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

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

7-
```typescript
7+
```
88
args: [
99
radius: number,
1010
tube: number,

‎docs/guide/shapes/torus.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

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

7-
```typescript
7+
```
88
args: [
99
radius: number,
1010
tube: number,

‎docs/guide/shapes/tube.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Reference: [TubeGeometry](https://threejs.org/docs/?q=tube#api/en/geometries/Tub
88

99
## Usage
1010

11-
```typescript
11+
```
1212
<script>
1313
export default {
1414
setup() {
@@ -39,7 +39,7 @@ export default {
3939

4040
## Args
4141

42-
```typescript
42+
```
4343
type CurveType = QuadraticBezierCurve3 | CubicBezierCurve3 | CatmullRomCurve3 | LineCurve3
4444
4545
args: [

0 commit comments

Comments
 (0)