sveders v0.0.111

sveders

sveders is a package that allows you to render WebGL shader backgrounds in your Svelte applications. It uses Three.js for its WebGL capabilities.

Installation

To install sveders, simply run the following command:

npm install sveders

Example on Stackblitz

Components

sveders provides prebaked components that you can use out of the box. More components are constantly being added. Here are the currently available components:

• <Cells/>
• <Dropper/>
• <Glitch/>
• <Liquid/>
• <Mushroom/>
• <Rain/>
• <Ribbons/>
• <Sdf/>
• <Stochastic/>
• <Water/>

Props

The components accept an optional dims prop, which allows you to specify the width and height of the component. If it is not specified the canvas will try to fill its container.

Example

<script>
import { Cells, Rain } from "sveders"
</script>

<Cells dims={{width:500, height:500}} />
<Rain dims={{width:"69%", height:"69%"}}>

Shaders - Modules

If you prefer to use the base scene and pick from available shaders or inject your own, sveders provides shader modules.

###The shader modules allow you to customize the rendering of the base scene by choosing from available shaders or injecting your own. Note that if you inject your own you will have access to GLSL variables provided by Three.js.

Available Shaders

sveders provides the following shaders that you can use:

• cells
• dropper
• glitch
• liquid
• mushroom
• rain
• ribbons
• sdf
• stochastic
• water

Props

In order to use the shader modules, you need to import the Base and Shaders components from "sveders".

The Base component accepts the shader prop, which specifies the shader to use. You can also provide an optional dims prop to set the width and height of the component.

Example

<script>
import { Base, Shaders } from "sveders"
</script>

<Base shader={Shaders.liquid} />
<Base shader={Shaders.mushroom} dims={{width:500, height:500}}>

Additional Notes

Please note that the package is still a work in progress and more features will be added in the future.