[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"github-stars":3,"guide-nav":5,"doc-\u002Fdocs\u002Fcomponents\u002Fsparkle":129},{"stars":4},5504,[6,11,15,19,23,27,31,35,39,43,47,51,55,59,63,67,72,76,80,84,88,93,97,101,105,109,113,117,121,125],{"path":7,"title":8,"description":9,"category":10},"\u002Fdocs\u002Fguide","Getting started","Shaders is a library of GPU effect components for Vue, React, Svelte, Solid, JavaScript and Framer, with a design editor for building with them.","code",{"path":12,"title":13,"description":14,"category":10},"\u002Fdocs\u002Fguide\u002Fquickstart","Quickstart","Install Shaders, render your first effect, and drive a prop from state.",{"path":16,"title":17,"description":18,"category":10},"\u002Fdocs\u002Fguide\u002Fcomposing-effects","Composing effects","Stack components as layers and nest them to control which layers an effect touches.",{"path":20,"title":21,"description":22,"category":10},"\u002Fdocs\u002Fguide\u002Fblending-masking","Blending and masking","Control how a layer mixes with the layers below it, and reveal one layer through another.",{"path":24,"title":25,"description":26,"category":10},"\u002Fdocs\u002Fguide\u002Fprops-reactivity","Props and reactivity","Bind props to your framework's state so effects update when it changes, and animate props with an animation library.",{"path":28,"title":29,"description":30,"category":10},"\u002Fdocs\u002Fguide\u002Fdynamic-props","Dynamic props","Drive any numeric or position prop from time, the cursor, or another layer, without writing animation code.",{"path":32,"title":33,"description":34,"category":10},"\u002Fdocs\u002Fguide\u002Flayout-positioning","Layout and positioning","Size and place a shader in your page with CSS, as a background, a fill, or an inline block.",{"path":36,"title":37,"description":38,"category":10},"\u002Fdocs\u002Fguide\u002Fsizing-and-units","Sizing and units","Size and place layers in CSS units (px, %, vw, rem, and canvas units) that stay correct as the canvas and window resize.",{"path":40,"title":41,"description":42,"category":10},"\u002Fdocs\u002Fguide\u002Ftransforms","Transforms","Position, size, and rotate any layer inside the canvas with a bounding box, in any CSS unit.",{"path":44,"title":45,"description":46,"category":10},"\u002Fdocs\u002Fguide\u002Fshape-effects","Shape effects","Pick the 2D, 3D or custom SVG shape that Glass, Neon, Emboss and other shape effects draw inside.",{"path":48,"title":49,"description":50,"category":10},"\u002Fdocs\u002Fguide\u002Fcolor-space","Color space","Match colors to your design tool with the output color space, and keep bright layers from clipping with tone mapping.",{"path":52,"title":53,"description":54,"category":10},"\u002Fdocs\u002Fguide\u002Fhooks-events","Hooks and events","Run code when an effect is ready to show, and show a fallback when the GPU can't run it.",{"path":56,"title":57,"description":58,"category":10},"\u002Fdocs\u002Fguide\u002Fperformance","Performance","Learn what makes an effect expensive on the GPU and how to keep it inside the frame budget.",{"path":60,"title":61,"description":62,"category":10},"\u002Fdocs\u002Fguide\u002Fcustom-shaders","Custom components","Write your own component in TypeScript, use it like any component in the library, and write WGSL by hand when you need to.",{"path":64,"title":65,"description":66,"category":10},"\u002Fdocs\u002Fguide\u002Ftelemetry","Telemetry","The `\u003CShader>` component occasionally sends an anonymous performance report to help us improve the engine over time.",{"path":68,"title":69,"description":70,"category":71},"\u002Fdocs\u002Fguide\u002Fmcp","Shaders MCP","Connect your AI coding agent to Shaders so it can find, install and edit effects in your codebase.","workflows",{"path":73,"title":74,"description":75,"category":71},"\u002Fdocs\u002Fguide\u002Fcli","Shaders CLI","Install your own shaders and Pro shaders into your codebase as component files, and keep them in sync with the design editor.",{"path":77,"title":78,"description":79,"category":71},"\u002Fdocs\u002Fguide\u002Fagent-skill","Agent skill","Give your coding agent a skill that teaches it to build with Shaders components, the CLI and Pro shaders.",{"path":81,"title":82,"description":83,"category":10},"\u002Fdocs\u002Fguide\u002Fvideo-rendering","Rendering to video","Turn a shader effect into a video file, from the design editor or from a frame-by-frame pipeline such as Remotion, Hyperframes or Puppeteer.",{"path":85,"title":86,"description":87,"category":10},"\u002Fdocs\u002Fguide\u002Fssr","Server rendering","Render Shaders in Next.js, Nuxt, SvelteKit, SolidStart and other SSR apps by keeping each shader on the client.",{"path":89,"title":90,"description":91,"category":92},"\u002Fdocs\u002Fguide\u002Fquick-tour-of-the-design-editor","Quick tour of the design editor","A short walkthrough of the full Shaders workflow, from designing on the infinite canvas to exporting code.","editor",{"path":94,"title":95,"description":96,"category":92},"\u002Fdocs\u002Fguide\u002Fintro-to-the-interface","Intro to the interface","A tour of the design editor interface: the canvas, layers, the Properties panel, and the ways to share and export.",{"path":98,"title":99,"description":100,"category":92},"\u002Fdocs\u002Fguide\u002Fcomposing-your-first-shader-effect","Composing your first shader effect","Building a first shader effect in the design editor by stacking and nesting components as layers.",{"path":102,"title":103,"description":104,"category":92},"\u002Fdocs\u002Fguide\u002Fmasking-and-blending","Masking and blending","How blend modes and masks combine components in the design editor.",{"path":106,"title":107,"description":108,"category":92},"\u002Fdocs\u002Fguide\u002Fdynamic-prop-mapping","Dynamic prop mapping","Turning static props into dynamic ones in the design editor: mapping one layer's output into another's prop, following the cursor, or animating automatically.",{"path":110,"title":111,"description":112,"category":92},"\u002Fdocs\u002Fguide\u002Fcustom-media-and-transformations","Custom media and transformations","Uploading images, videos, and SVG files to the media gallery, adding them to a composition, and placing them with transformations.",{"path":114,"title":115,"description":116,"category":92},"\u002Fdocs\u002Fguide\u002Finstalling-a-shader-via-mcp","Installing a shader via MCP","Installing a shader from the design editor into a hero section with the Shaders MCP.",{"path":118,"title":119,"description":120,"category":92},"\u002Fdocs\u002Fguide\u002Fexploring-shape-effects","Exploring shape effects","Applying shape effects such as liquid glass, liquid metal, and glowing edges to built-in shapes and your own SVG.",{"path":122,"title":123,"description":124,"category":92},"\u002Fdocs\u002Fguide\u002Fglass-component-spotlight","Component spotlight: Glass","A short look at the Glass component and the liquid-glass look it creates.",{"path":126,"title":127,"description":128,"category":92},"\u002Fdocs\u002Fguide\u002Fdigital-looks-component-spotlight","Component spotlight: Digital looks","A look at the digital stylization components for glitchy, futuristic, or technical effects.",{"id":130,"title":131,"body":132,"category":539,"componentType":540,"description":142,"extension":541,"meta":542,"navigation":460,"path":543,"requiresChild":460,"seo":544,"sourceUrl":545,"stem":546,"__hash__":547},"components\u002Fdocs\u002Fcomponents\u002FSparkle.md","Sparkle",{"type":133,"value":134,"toc":535},"minimark",[135,139,143,146,151,155,159,531],[136,137,131],"h1",{"id":138},"sparkle",[140,141,142],"p",{},"Twinkling star glints over the bright parts of the layer inside",[144,145],"shader-preview",{"component":131},[147,148,150],"h2",{"id":149},"props","Props",[152,153],"props-table",{":props":154},"[{\"name\":\"size\",\"type\":\"number\",\"default\":\"100\",\"description\":\"Spacing between glints, in CSS pixels (smaller means more glints)\"},{\"name\":\"intensity\",\"type\":\"number\",\"default\":\"10\",\"description\":\"Brightness of the glints\"},{\"name\":\"threshold\",\"type\":\"number\",\"default\":\"0.2\",\"description\":\"How bright the layer must be before glints appear: 0 allows all but black, 0.5 is mid-grey and up, 1 only pure white\"},{\"name\":\"expand\",\"type\":\"number\",\"default\":\"0\",\"description\":\"Lets glints appear up to this many CSS pixels outside the bright areas\"},{\"name\":\"rayLength\",\"type\":\"number\",\"default\":\"5\",\"description\":\"Length of the four rays around each glint (they fade out by half the spacing)\"},{\"name\":\"colorize\",\"type\":\"number\",\"default\":\"0.45\",\"description\":\"How much each glint takes on the colour beneath it (0 is pure white)\"},{\"name\":\"speed\",\"type\":\"number\",\"default\":\"1\",\"description\":\"How fast the glints twinkle\"},{\"name\":\"seed\",\"type\":\"number\",\"default\":\"0\",\"description\":\"Re-rolls where the glints sit and when they blink\"}]",[147,156,158],{"id":157},"usage","Usage",[160,161,163,249,316,375,435],"code-group",{":tabs":162},"[\"Vue\", \"React\", \"Svelte\", \"Solid\", \"JS\"]",[164,165,170],"pre",{"className":166,"code":167,"language":168,"meta":169,"style":169},"language-vue-html shiki shiki-themes github-dark","\u003CShader>\n  \u003CSparkle\n    :intensity=\"10\"\n  >\n    \u003CCircle \u002F>\n  \u003C\u002FSparkle>\n\u003C\u002FShader>\n","vue-html","",[10,171,172,188,197,211,217,229,239],{"__ignoreMap":169},[173,174,177,181,185],"span",{"class":175,"line":176},"line",1,[173,178,180],{"class":179},"s95oV","\u003C",[173,182,184],{"class":183},"s4JwU","Shader",[173,186,187],{"class":179},">\n",[173,189,191,194],{"class":175,"line":190},2,[173,192,193],{"class":179},"  \u003C",[173,195,196],{"class":183},"Sparkle\n",[173,198,200,204,207],{"class":175,"line":199},3,[173,201,203],{"class":202},"svObZ","    :intensity",[173,205,206],{"class":179},"=",[173,208,210],{"class":209},"sU2Wk","\"10\"\n",[173,212,214],{"class":175,"line":213},4,[173,215,216],{"class":179},"  >\n",[173,218,220,223,226],{"class":175,"line":219},5,[173,221,222],{"class":179},"    \u003C",[173,224,225],{"class":183},"Circle",[173,227,228],{"class":179}," \u002F>\n",[173,230,232,235,237],{"class":175,"line":231},6,[173,233,234],{"class":179},"  \u003C\u002F",[173,236,131],{"class":183},[173,238,187],{"class":179},[173,240,242,245,247],{"class":175,"line":241},7,[173,243,244],{"class":179},"\u003C\u002F",[173,246,184],{"class":183},[173,248,187],{"class":179},[164,250,254],{"className":251,"code":252,"language":253,"meta":169,"style":169},"language-jsx shiki shiki-themes github-dark","\u003CShader>\n  \u003CSparkle\n    intensity={10}\n  >\n    \u003CCircle \u002F>\n  \u003C\u002FSparkle>\n\u003C\u002FShader>\n","jsx",[10,255,256,265,271,288,292,300,308],{"__ignoreMap":169},[173,257,258,260,263],{"class":175,"line":176},[173,259,180],{"class":179},[173,261,184],{"class":262},"sDLfK",[173,264,187],{"class":179},[173,266,267,269],{"class":175,"line":190},[173,268,193],{"class":179},[173,270,196],{"class":262},[173,272,273,276,279,282,285],{"class":175,"line":199},[173,274,275],{"class":202},"    intensity",[173,277,206],{"class":278},"snl16",[173,280,281],{"class":179},"{",[173,283,284],{"class":262},"10",[173,286,287],{"class":179},"}\n",[173,289,290],{"class":175,"line":213},[173,291,216],{"class":179},[173,293,294,296,298],{"class":175,"line":219},[173,295,222],{"class":179},[173,297,225],{"class":262},[173,299,228],{"class":179},[173,301,302,304,306],{"class":175,"line":231},[173,303,234],{"class":179},[173,305,131],{"class":262},[173,307,187],{"class":179},[173,309,310,312,314],{"class":175,"line":241},[173,311,244],{"class":179},[173,313,184],{"class":262},[173,315,187],{"class":179},[164,317,320],{"className":318,"code":252,"language":319,"meta":169,"style":169},"language-svelte shiki shiki-themes github-dark","svelte",[10,321,322,330,336,347,351,359,367],{"__ignoreMap":169},[173,323,324,326,328],{"class":175,"line":176},[173,325,180],{"class":179},[173,327,184],{"class":262},[173,329,187],{"class":179},[173,331,332,334],{"class":175,"line":190},[173,333,193],{"class":179},[173,335,196],{"class":262},[173,337,338,340,343,345],{"class":175,"line":199},[173,339,275],{"class":202},[173,341,342],{"class":179},"={",[173,344,284],{"class":262},[173,346,287],{"class":179},[173,348,349],{"class":175,"line":213},[173,350,216],{"class":179},[173,352,353,355,357],{"class":175,"line":219},[173,354,222],{"class":179},[173,356,225],{"class":262},[173,358,228],{"class":179},[173,360,361,363,365],{"class":175,"line":231},[173,362,234],{"class":179},[173,364,131],{"class":262},[173,366,187],{"class":179},[173,368,369,371,373],{"class":175,"line":241},[173,370,244],{"class":179},[173,372,184],{"class":262},[173,374,187],{"class":179},[164,376,379],{"className":377,"code":252,"language":378,"meta":169,"style":169},"language-tsx shiki shiki-themes github-dark","tsx",[10,380,381,389,395,407,411,419,427],{"__ignoreMap":169},[173,382,383,385,387],{"class":175,"line":176},[173,384,180],{"class":179},[173,386,184],{"class":262},[173,388,187],{"class":179},[173,390,391,393],{"class":175,"line":190},[173,392,193],{"class":179},[173,394,196],{"class":262},[173,396,397,399,401,403,405],{"class":175,"line":199},[173,398,275],{"class":202},[173,400,206],{"class":278},[173,402,281],{"class":179},[173,404,284],{"class":262},[173,406,287],{"class":179},[173,408,409],{"class":175,"line":213},[173,410,216],{"class":179},[173,412,413,415,417],{"class":175,"line":219},[173,414,222],{"class":179},[173,416,225],{"class":262},[173,418,228],{"class":179},[173,420,421,423,425],{"class":175,"line":231},[173,422,234],{"class":179},[173,424,131],{"class":262},[173,426,187],{"class":179},[173,428,429,431,433],{"class":175,"line":241},[173,430,244],{"class":179},[173,432,184],{"class":262},[173,434,187],{"class":179},[164,436,440],{"className":437,"code":438,"language":439,"meta":169,"style":169},"language-javascript shiki shiki-themes github-dark","import { createShader } from 'shaders\u002Fjs'\n\nconst shader = await createShader(canvas, {\n  components: [\n    { type: 'Sparkle', props: { intensity: 10 }, children: [\n      { type: 'Circle', props: {} }\n    ]}\n  ]\n})\n","javascript",[10,441,442,456,462,482,487,503,514,519,525],{"__ignoreMap":169},[173,443,444,447,450,453],{"class":175,"line":176},[173,445,446],{"class":278},"import",[173,448,449],{"class":179}," { createShader } ",[173,451,452],{"class":278},"from",[173,454,455],{"class":209}," 'shaders\u002Fjs'\n",[173,457,458],{"class":175,"line":190},[173,459,461],{"emptyLinePlaceholder":460},true,"\n",[173,463,464,467,470,473,476,479],{"class":175,"line":199},[173,465,466],{"class":278},"const",[173,468,469],{"class":262}," shader",[173,471,472],{"class":278}," =",[173,474,475],{"class":278}," await",[173,477,478],{"class":202}," createShader",[173,480,481],{"class":179},"(canvas, {\n",[173,483,484],{"class":175,"line":213},[173,485,486],{"class":179},"  components: [\n",[173,488,489,492,495,498,500],{"class":175,"line":219},[173,490,491],{"class":179},"    { type: ",[173,493,494],{"class":209},"'Sparkle'",[173,496,497],{"class":179},", props: { intensity: ",[173,499,284],{"class":262},[173,501,502],{"class":179}," }, children: [\n",[173,504,505,508,511],{"class":175,"line":231},[173,506,507],{"class":179},"      { type: ",[173,509,510],{"class":209},"'Circle'",[173,512,513],{"class":179},", props: {} }\n",[173,515,516],{"class":175,"line":241},[173,517,518],{"class":179},"    ]}\n",[173,520,522],{"class":175,"line":521},8,[173,523,524],{"class":179},"  ]\n",[173,526,528],{"class":175,"line":527},9,[173,529,530],{"class":179},"})\n",[532,533,534],"style",{},"html pre.shiki code .s95oV, html code.shiki .s95oV{--shiki-default:#E1E4E8}html pre.shiki code .s4JwU, html code.shiki .s4JwU{--shiki-default:#85E89D}html pre.shiki code .svObZ, html code.shiki .svObZ{--shiki-default:#B392F0}html pre.shiki code .sU2Wk, html code.shiki .sU2Wk{--shiki-default:#9ECBFF}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html pre.shiki code .sDLfK, html code.shiki .sDLfK{--shiki-default:#79B8FF}html pre.shiki code .snl16, html code.shiki .snl16{--shiki-default:#F97583}",{"title":169,"searchDepth":190,"depth":190,"links":536},[537,538],{"id":149,"depth":190,"text":150},{"id":157,"depth":190,"text":158},"Stylize","Filter\u002FEffect","md",{},"\u002Fdocs\u002Fcomponents\u002Fsparkle",{"title":131,"description":142},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fshaders\u002FSparkle\u002Findex.ts","docs\u002Fcomponents\u002FSparkle","5LDSeY_PNNdnhTxVnUa8S36lqEtJZAyvCKf-8JVakL8"]