[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Feffects-instances\u002Fbymode":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,"categoryId":393,"categorySlug":394,"categoryTitle":395,"curated":396,"description":158,"editUrl":9,"extension":397,"group":192,"groupTitle":398,"kind":399,"meta":400,"navigation":401,"path":402,"seo":403,"sourceUrl":404,"stem":405,"wordCount":9,"__hash__":406},"primitives\u002Fdocs\u002Fprimitives\u002F31.effects-instances\u002F5.bymode.md","byMode",{"type":149,"value":150,"toc":386},"minimark",[151,155,159,187,202,220,225,275,279,339,343,372,376,382],[152,153,147],"h1",{"id":154},"bymode",[156,157,158],"p",{},"Lets one select prop switch between a grid, a radial and a linear layout.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","byMode(mode: PropRef, members: PlacementPick['members']): PlacementPick\n","ts","",[8,167,168],{"__ignoreMap":165},[169,170,173,176,180,184],"span",{"class":171,"line":172},"line",1,[169,174,147],{"class":175},"svObZ",[169,177,179],{"class":178},"s95oV","(mode: PropRef, members: PlacementPick[",[169,181,183],{"class":182},"sU2Wk","'members'",[169,185,186],{"class":178},"]): PlacementPick\n",[156,188,189,190,193,194,197,198,201],{},"Import ",[8,191,192],{},"effects"," from ",[8,195,196],{},"shaders\u002Fstd"," and use ",[8,199,200],{},"effects.instances.byMode",".",[156,203,204,207,208,211,212,215,216,219],{},[8,205,206],{},"mode"," is a compile-time select with the values ",[8,209,210],{},"'grid'",", ",[8,213,214],{},"'radial'"," and ",[8,217,218],{},"'linear'","; only the chosen layout is compiled in.",[221,222,224],"h2",{"id":223},"parameters","Parameters",[226,227,228,244],"table",{},[229,230,231],"thead",{},[232,233,234,238,241],"tr",{},[235,236,237],"th",{},"Name",[235,239,240],{},"Type",[235,242,243],{},"Notes",[245,246,247,261],"tbody",{},[232,248,249,254,259],{},[250,251,252],"td",{},[8,253,206],{},[250,255,256],{},[8,257,258],{},"PropRef",[250,260],{},[232,262,263,268,273],{},[250,264,265],{},[8,266,267],{},"members",[250,269,270],{},[8,271,272],{},"PlacementPick['members']",[250,274],{},[221,276,278],{"id":277},"example","Example",[160,280,282],{"className":162,"code":281,"language":164,"meta":165,"style":165},"placement: byMode(p('mode'), {grid: grid({...}), radial: radial({...}), linear: line({...})})\n",[8,283,284],{"__ignoreMap":165},[169,285,286,289,292,294,297,299,301,304,307,310,313,317,320,323,325,327,330,332,334,336],{"class":171,"line":172},[169,287,288],{"class":175},"placement",[169,290,291],{"class":178},": ",[169,293,147],{"class":175},[169,295,296],{"class":178},"(",[169,298,156],{"class":175},[169,300,296],{"class":178},[169,302,303],{"class":182},"'mode'",[169,305,306],{"class":178},"), {grid: ",[169,308,309],{"class":175},"grid",[169,311,312],{"class":178},"({",[169,314,316],{"class":315},"snl16","...",[169,318,319],{"class":178},"}), radial: ",[169,321,322],{"class":175},"radial",[169,324,312],{"class":178},[169,326,316],{"class":315},[169,328,329],{"class":178},"}), linear: ",[169,331,171],{"class":175},[169,333,312],{"class":178},[169,335,316],{"class":315},[169,337,338],{"class":178},"})})\n",[221,340,342],{"id":341},"see-also","See also",[344,345,346,356,364],"ul",{},[347,348,349,355],"li",{},[350,351,353],"a",{"href":352},"\u002Fdocs\u002Fprimitives\u002Feffects-instances\u002Fgrid",[8,354,309],{}," — Copies in rows and columns, filling this layer's bounding box.",[347,357,358,363],{},[350,359,361],{"href":360},"\u002Fdocs\u002Fprimitives\u002Feffects-instances\u002Fradial",[8,362,322],{}," — Copies around a circle centred on the layer inside.",[347,365,366,371],{},[350,367,369],{"href":368},"\u002Fdocs\u002Fprimitives\u002Feffects-instances\u002Fline",[8,370,171],{}," — Copies in a row, marching away from the layer inside in one direction.",[221,373,375],{"id":374},"used-by","Used by",[156,377,378],{},[350,379,381],{"href":380},"\u002Fdocs\u002Fcomponents\u002Frepeater","Repeater",[383,384,385],"style",{},"html pre.shiki code .svObZ, html code.shiki .svObZ{--shiki-default:#B392F0}html pre.shiki code .s95oV, html code.shiki .s95oV{--shiki-default:#E1E4E8}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 .snl16, html code.shiki .snl16{--shiki-default:#F97583}",{"title":165,"searchDepth":387,"depth":387,"links":388},2,[389,390,391,392],{"id":223,"depth":387,"text":224},{"id":277,"depth":387,"text":278},{"id":341,"depth":387,"text":342},{"id":374,"depth":387,"text":375},"effects.instances","effects-instances","Instances",false,"md","Filters & effects","function",{},true,"\u002Fdocs\u002Fprimitives\u002Feffects-instances\u002Fbymode",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Feffects\u002Finstances.ts#L124","docs\u002Fprimitives\u002F31.effects-instances\u002F5.bymode","XmsQV2vJp5PEvCUIuIDHdC_4dwyZwKXnE1nt-ms_Jgk"]