@splinetool/viewer 0.0.19 → 0.0.21

package/README.md

@@ -54,6 +54,45 @@ A css like color that will override the background color of your scene as it was
 
 This option controls the agressiveness of the preload of your scene. Possible values are `auto`, `lazy` and `eager`. By default (`auto`) the behavior is to `lazy` load the scene and only start to preload when the tag enters the viewport. If you need to start loading immediately then you can set `loading="eager"` instead.
 
+### `unloadable` (optional)
+
+When true (default is false), this options makes the viewer unload the spline element when it leaves the viewport.
+
+### `eventsTarget` (optional)
+
+Values can either be `local` (events listened on the canvas) or `global` (events listened on the window).
+
+## Events
+
+You can listen for a few custom events on the `spline-viewer` element that are triggered at various moments of its lifecycle.
+
+```js
+const mySplineViewer = document.getElementById('MySplineViewer');
+mySplineViewer.addEventListener('load-start', (e) => {
+	console.log('loading started', e.detail.url);
+});
+```
+
+### `viewport-intersection`
+
+Triggered when the viewer enters or leaves the viewport. Event contains a `intersection:boolean` detail value.
+
+### `context-loss`
+
+Triggered when the webgl context of the canvas is lost.
+
+### `load-start`
+
+Triggered when the viewer starts loading a scene. Event contains a `url:string` detail value. Use This if you want to display a preloader during loading.
+
+### `load-complete`
+
+Triggered when the viewer finishes loading a scene. Event contains a `url:string` detail value. Use This if you want to display a preloader during loading.
+
+### `unload`
+
+Triggered when the viewer finishes loading a scene. Event contains a `url:string` detail value. Use This if you want to display a preloader during loading.
+
 ## Exporting for `<spline-viewer` from Spline editor
 
 If you want a scene to be loaded by the `<spline-viewer>` component, you need to export it from Spline editor using the `Spline Viewer` export type. First click on the Export button from the toolbar, then click on the `Spline Viewer` tab on the sidebar of the export modal. Finally click on update and when export is done you can copy paste the code snippet or the exported URL.