yew_spline 0.2.1

Spline runtime component for Yew
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

# Yew Spline
Yew Spline is a Spline runtime component for Yew based on the [@splinetool/runtime NPM package](https://www.npmjs.com/package/@splinetool/runtime), so you can display Spline scenes in Yew.   
   
Spline is a 3d editor that let's you make interactive 3d scenes to be viewed on the web. For more information visit [https://spline.design/](https://spline.design/).

## How to use
First you add `yew_spline` to your cargo.toml
```toml
[dependencies]
yew = "0.19.3^"
yew_spline = "..."
```
Then you use the <Spline /> component in your Html.

## Examples
__Use the splinecode URL__
```rust
use yew::prelude::*;
use yew_spline::spline::Spline;

#[function_component(App)]
pub fn app() -> Html {
    html! {
        <Spline scene={"https://prod.spline.design/123/scene.splinecode"} />
    }
}
```

---

__Use a local splinecode file__   
If you download a splinecode file to use locally instead of loading it in
from the Spline servers, you have to link the directory it's in, in the `index.html` file. 

```html
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Yew Spline</title>

    <link data-trunk rel="copy-dir" href="./src/assets">
</head>
<body>
    
</body>
</html>
```
In this example I have the standard src folder, but I have an assets folder with a spline folder nested inside.

```rust
use yew::prelude::*;
use yew_spline::spline::Spline;

#[function_component(App)]
pub fn app() -> Html {
    html! {
        <Spline scene={"assets/spline/scene.splinecode"} />
    }
}
```

## License
Yew Spline is MIT licensed. See [license](LICENSE)