[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fcomponents\u002Fsparkle":145},[4,10,16,20,24,28,32,36,40,44,48,52,56,60,64,69,73,78,82,86,90,94,98,102,106,110,114,117,120,124,127,131,134,138,141],{"path":5,"title":6,"description":7,"category":8,"exclude":9,"forceFramework":9},"\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",null,{"path":11,"title":12,"description":13,"category":8,"exclude":14,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fquickstart","Quickstart","Install Shaders, render your first effect, and drive a prop from state.",[15],"js",{"path":17,"title":18,"description":19,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fcomposing-effects","Composing effects","Stack components as layers and nest them to control which layers an effect touches.",{"path":21,"title":22,"description":23,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fblending-masking","Blending and masking","Control how a layer mixes with the layers below it, and reveal one layer through another.",{"path":25,"title":26,"description":27,"category":8,"exclude":9,"forceFramework":9},"\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":29,"title":30,"description":31,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fdynamic-props","Dynamic props","Drive any numeric or position prop from time, the cursor, or another layer, without writing animation code.",{"path":33,"title":34,"description":35,"category":8,"exclude":9,"forceFramework":9},"\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":37,"title":38,"description":39,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Ftransforms","Transforms","Position, size, and rotate any layer inside the canvas with a bounding box, in % or px units.",{"path":41,"title":42,"description":43,"category":8,"exclude":9,"forceFramework":9},"\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":45,"title":46,"description":47,"category":8,"exclude":9,"forceFramework":9},"\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":49,"title":50,"description":51,"category":8,"exclude":9,"forceFramework":9},"\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":53,"title":54,"description":55,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fperformance","Performance","Learn what makes an effect expensive on the GPU and how to keep it inside the frame budget.",{"path":57,"title":58,"description":59,"category":8,"exclude":9,"forceFramework":9},"\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":61,"title":62,"description":63,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Ftelemetry","Telemetry","The `\u003CShader>` component occasionally sends an anonymous performance report to help us improve the engine over time.",{"path":65,"title":66,"description":67,"category":68,"exclude":9,"forceFramework":9},"\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":70,"title":71,"description":72,"category":68,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fcli","Shaders CLI","Install shaders and presets into your codebase as component files, and keep them in sync with the design editor.",{"path":74,"title":75,"description":76,"category":77,"exclude":9,"forceFramework":9},"\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":79,"title":80,"description":81,"category":77,"exclude":9,"forceFramework":9},"\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":83,"title":84,"description":85,"category":77,"exclude":9,"forceFramework":9},"\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":87,"title":88,"description":89,"category":77,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fmasking-and-blending","Masking and blending","How blend modes and masks combine components in the design editor.",{"path":91,"title":92,"description":93,"category":77,"exclude":9,"forceFramework":9},"\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":95,"title":96,"description":97,"category":77,"exclude":9,"forceFramework":9},"\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":99,"title":100,"description":101,"category":77,"exclude":9,"forceFramework":9},"\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":103,"title":104,"description":105,"category":77,"exclude":9,"forceFramework":9},"\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":107,"title":108,"description":109,"category":77,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fglass-component-spotlight","Component spotlight: Glass","A short look at the Glass component and the liquid-glass look it creates.",{"path":111,"title":112,"description":113,"category":77,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fdigital-looks-component-spotlight","Component spotlight: Digital looks","A look at the digital stylization components for glitchy, futuristic, or technical effects.",{"path":115,"title":12,"description":116,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fjs\u002Fquickstart","Install Shaders without a framework, render your first effect on a canvas, and update props at runtime.",{"path":118,"title":12,"description":119,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Freact\u002Fquickstart","Install Shaders in a React app, render your first effect, and drive a prop from state.",{"path":121,"title":122,"description":123,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Freact\u002Fssr","Next.js and SSR","Render Shaders in Next.js and other React SSR apps by keeping each shader on the client.",{"path":125,"title":12,"description":126,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fsolid\u002Fquickstart","Install Shaders in a Solid app, render your first effect, and drive a prop from a signal.",{"path":128,"title":129,"description":130,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fsolid\u002Fssr","SolidStart and SSR","Render Shaders in SolidStart and other Solid SSR apps by keeping each shader on the client.",{"path":132,"title":12,"description":133,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fsvelte\u002Fquickstart","Install Shaders in a Svelte app, render your first effect, and drive a prop from state.",{"path":135,"title":136,"description":137,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fsvelte\u002Fssr","SvelteKit and SSR","Render Shaders in SvelteKit and other Svelte SSR apps, where each shader already waits for the browser.",{"path":139,"title":12,"description":140,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fvue\u002Fquickstart","Install Shaders in a Vue app, render your first effect, and drive a prop from a ref.",{"path":142,"title":143,"description":144,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fvue\u002Fssr","Nuxt and SSR","Render Shaders in Nuxt and other Vue SSR apps by keeping each shader on the client.",{"id":146,"title":147,"body":148,"category":555,"componentType":556,"description":158,"extension":557,"meta":558,"navigation":476,"path":559,"requiresChild":476,"seo":560,"sourceUrl":561,"stem":562,"__hash__":563},"components\u002Fdocs\u002Fcomponents\u002FSparkle.md","Sparkle",{"type":149,"value":150,"toc":551},"minimark",[151,155,159,162,167,171,175,547],[152,153,147],"h1",{"id":154},"sparkle",[156,157,158],"p",{},"Twinkling star glints over the bright parts of the layer inside",[160,161],"shader-preview",{"component":147},[163,164,166],"h2",{"id":165},"props","Props",[168,169],"props-table",{":props":170},"[{\"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\"}]",[163,172,174],{"id":173},"usage","Usage",[176,177,179,265,332,391,451],"code-group",{":tabs":178},"[\"Vue\", \"React\", \"Svelte\", \"Solid\", \"JS\"]",[180,181,186],"pre",{"className":182,"code":183,"language":184,"meta":185,"style":185},"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","",[8,187,188,204,213,227,233,245,255],{"__ignoreMap":185},[189,190,193,197,201],"span",{"class":191,"line":192},"line",1,[189,194,196],{"class":195},"s95oV","\u003C",[189,198,200],{"class":199},"s4JwU","Shader",[189,202,203],{"class":195},">\n",[189,205,207,210],{"class":191,"line":206},2,[189,208,209],{"class":195},"  \u003C",[189,211,212],{"class":199},"Sparkle\n",[189,214,216,220,223],{"class":191,"line":215},3,[189,217,219],{"class":218},"svObZ","    :intensity",[189,221,222],{"class":195},"=",[189,224,226],{"class":225},"sU2Wk","\"10\"\n",[189,228,230],{"class":191,"line":229},4,[189,231,232],{"class":195},"  >\n",[189,234,236,239,242],{"class":191,"line":235},5,[189,237,238],{"class":195},"    \u003C",[189,240,241],{"class":199},"Circle",[189,243,244],{"class":195}," \u002F>\n",[189,246,248,251,253],{"class":191,"line":247},6,[189,249,250],{"class":195},"  \u003C\u002F",[189,252,147],{"class":199},[189,254,203],{"class":195},[189,256,258,261,263],{"class":191,"line":257},7,[189,259,260],{"class":195},"\u003C\u002F",[189,262,200],{"class":199},[189,264,203],{"class":195},[180,266,270],{"className":267,"code":268,"language":269,"meta":185,"style":185},"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",[8,271,272,281,287,304,308,316,324],{"__ignoreMap":185},[189,273,274,276,279],{"class":191,"line":192},[189,275,196],{"class":195},[189,277,200],{"class":278},"sDLfK",[189,280,203],{"class":195},[189,282,283,285],{"class":191,"line":206},[189,284,209],{"class":195},[189,286,212],{"class":278},[189,288,289,292,295,298,301],{"class":191,"line":215},[189,290,291],{"class":218},"    intensity",[189,293,222],{"class":294},"snl16",[189,296,297],{"class":195},"{",[189,299,300],{"class":278},"10",[189,302,303],{"class":195},"}\n",[189,305,306],{"class":191,"line":229},[189,307,232],{"class":195},[189,309,310,312,314],{"class":191,"line":235},[189,311,238],{"class":195},[189,313,241],{"class":278},[189,315,244],{"class":195},[189,317,318,320,322],{"class":191,"line":247},[189,319,250],{"class":195},[189,321,147],{"class":278},[189,323,203],{"class":195},[189,325,326,328,330],{"class":191,"line":257},[189,327,260],{"class":195},[189,329,200],{"class":278},[189,331,203],{"class":195},[180,333,336],{"className":334,"code":268,"language":335,"meta":185,"style":185},"language-svelte shiki shiki-themes github-dark","svelte",[8,337,338,346,352,363,367,375,383],{"__ignoreMap":185},[189,339,340,342,344],{"class":191,"line":192},[189,341,196],{"class":195},[189,343,200],{"class":278},[189,345,203],{"class":195},[189,347,348,350],{"class":191,"line":206},[189,349,209],{"class":195},[189,351,212],{"class":278},[189,353,354,356,359,361],{"class":191,"line":215},[189,355,291],{"class":218},[189,357,358],{"class":195},"={",[189,360,300],{"class":278},[189,362,303],{"class":195},[189,364,365],{"class":191,"line":229},[189,366,232],{"class":195},[189,368,369,371,373],{"class":191,"line":235},[189,370,238],{"class":195},[189,372,241],{"class":278},[189,374,244],{"class":195},[189,376,377,379,381],{"class":191,"line":247},[189,378,250],{"class":195},[189,380,147],{"class":278},[189,382,203],{"class":195},[189,384,385,387,389],{"class":191,"line":257},[189,386,260],{"class":195},[189,388,200],{"class":278},[189,390,203],{"class":195},[180,392,395],{"className":393,"code":268,"language":394,"meta":185,"style":185},"language-tsx shiki shiki-themes github-dark","tsx",[8,396,397,405,411,423,427,435,443],{"__ignoreMap":185},[189,398,399,401,403],{"class":191,"line":192},[189,400,196],{"class":195},[189,402,200],{"class":278},[189,404,203],{"class":195},[189,406,407,409],{"class":191,"line":206},[189,408,209],{"class":195},[189,410,212],{"class":278},[189,412,413,415,417,419,421],{"class":191,"line":215},[189,414,291],{"class":218},[189,416,222],{"class":294},[189,418,297],{"class":195},[189,420,300],{"class":278},[189,422,303],{"class":195},[189,424,425],{"class":191,"line":229},[189,426,232],{"class":195},[189,428,429,431,433],{"class":191,"line":235},[189,430,238],{"class":195},[189,432,241],{"class":278},[189,434,244],{"class":195},[189,436,437,439,441],{"class":191,"line":247},[189,438,250],{"class":195},[189,440,147],{"class":278},[189,442,203],{"class":195},[189,444,445,447,449],{"class":191,"line":257},[189,446,260],{"class":195},[189,448,200],{"class":278},[189,450,203],{"class":195},[180,452,456],{"className":453,"code":454,"language":455,"meta":185,"style":185},"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",[8,457,458,472,478,498,503,519,530,535,541],{"__ignoreMap":185},[189,459,460,463,466,469],{"class":191,"line":192},[189,461,462],{"class":294},"import",[189,464,465],{"class":195}," { createShader } ",[189,467,468],{"class":294},"from",[189,470,471],{"class":225}," 'shaders\u002Fjs'\n",[189,473,474],{"class":191,"line":206},[189,475,477],{"emptyLinePlaceholder":476},true,"\n",[189,479,480,483,486,489,492,495],{"class":191,"line":215},[189,481,482],{"class":294},"const",[189,484,485],{"class":278}," shader",[189,487,488],{"class":294}," =",[189,490,491],{"class":294}," await",[189,493,494],{"class":218}," createShader",[189,496,497],{"class":195},"(canvas, {\n",[189,499,500],{"class":191,"line":229},[189,501,502],{"class":195},"  components: [\n",[189,504,505,508,511,514,516],{"class":191,"line":235},[189,506,507],{"class":195},"    { type: ",[189,509,510],{"class":225},"'Sparkle'",[189,512,513],{"class":195},", props: { intensity: ",[189,515,300],{"class":278},[189,517,518],{"class":195}," }, children: [\n",[189,520,521,524,527],{"class":191,"line":247},[189,522,523],{"class":195},"      { type: ",[189,525,526],{"class":225},"'Circle'",[189,528,529],{"class":195},", props: {} }\n",[189,531,532],{"class":191,"line":257},[189,533,534],{"class":195},"    ]}\n",[189,536,538],{"class":191,"line":537},8,[189,539,540],{"class":195},"  ]\n",[189,542,544],{"class":191,"line":543},9,[189,545,546],{"class":195},"})\n",[548,549,550],"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":185,"searchDepth":206,"depth":206,"links":552},[553,554],{"id":165,"depth":206,"text":166},{"id":173,"depth":206,"text":174},"Stylize","Filter\u002FEffect","md",{},"\u002Fdocs\u002Fcomponents\u002Fsparkle",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fshaders\u002FSparkle\u002Findex.ts","docs\u002Fcomponents\u002FSparkle","5LDSeY_PNNdnhTxVnUa8S36lqEtJZAyvCKf-8JVakL8"]