[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Feffects-blurs\u002Fpeelframe":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":409,"categorySlug":410,"categoryTitle":411,"curated":412,"description":158,"editUrl":9,"extension":413,"group":185,"groupTitle":414,"kind":415,"meta":416,"navigation":417,"path":418,"seo":419,"sourceUrl":420,"stem":421,"wordCount":9,"__hash__":422},"primitives\u002Fdocs\u002Fprimitives\u002F27.effects-blurs\u002F36.peelframe.md","peelFrame",{"type":149,"value":150,"toc":402},"minimark",[151,155,159,180,195,216,221,258,262,318,335,339,388,392,398],[152,153,147],"h1",{"id":154},"peelframe",[156,157,158],"p",{},"The geometry of a page curling up from one corner: where the curl reads the child from, how far it has turned, and how far each pixel is from the crease.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","peelFrame(opts: {corner: PropRef; amount: ArgSpec; radius: ArgSpec}): GatherFrame\n","ts","",[8,167,168],{"__ignoreMap":165},[169,170,173,176],"span",{"class":171,"line":172},"line",1,[169,174,147],{"class":175},"svObZ",[169,177,179],{"class":178},"s95oV","(opts: {corner: PropRef; amount: ArgSpec; radius: ArgSpec}): GatherFrame\n",[156,181,182,183,186,187,190,191,194],{},"Import ",[8,184,185],{},"effects"," from ",[8,188,189],{},"shaders\u002Fstd"," and use ",[8,192,193],{},"effects.blurs.peelFrame",".",[156,196,197,200,201,204,205,208,209,212,213,194],{},[8,198,199],{},"corner"," is a ",[8,202,203],{},"compileTime"," string prop ('top-left' | 'top-right' | 'bottom-left' | 'bottom-right') with no transform. ",[8,206,207],{},"amount"," (0–1) is how far the peel has progressed, 0 flat and 1 fully peeled. ",[8,210,211],{},"radius"," is the tightness of the curl as a fraction of the page diagonal (0.02–0.4). Keep the frame in a module constant and pass it to the peel shading words and ",[8,214,215],{},"peelCompose",[217,218,220],"h2",{"id":219},"parameters","Parameters",[222,223,224,240],"table",{},[225,226,227],"thead",{},[228,229,230,234,237],"tr",{},[231,232,233],"th",{},"Name",[231,235,236],{},"Type",[231,238,239],{},"Notes",[241,242,243],"tbody",{},[228,244,245,251,256],{},[246,247,248],"td",{},[8,249,250],{},"opts",[246,252,253],{},[8,254,255],{},"{corner: PropRef; amount: ArgSpec; radius: ArgSpec}",[246,257],{},[217,259,261],{"id":260},"example","Example",[160,263,265],{"className":162,"code":264,"language":164,"meta":165,"style":165},"const peel = peelFrame({corner: p('corner'), amount: p('amount'), radius: p('radius')})\n",[8,266,267],{"__ignoreMap":165},[169,268,269,273,277,280,283,286,288,291,295,298,300,302,305,308,310,312,315],{"class":171,"line":172},[169,270,272],{"class":271},"snl16","const",[169,274,276],{"class":275},"sDLfK"," peel",[169,278,279],{"class":271}," =",[169,281,282],{"class":175}," peelFrame",[169,284,285],{"class":178},"({corner: ",[169,287,156],{"class":175},[169,289,290],{"class":178},"(",[169,292,294],{"class":293},"sU2Wk","'corner'",[169,296,297],{"class":178},"), amount: ",[169,299,156],{"class":175},[169,301,290],{"class":178},[169,303,304],{"class":293},"'amount'",[169,306,307],{"class":178},"), radius: ",[169,309,156],{"class":175},[169,311,290],{"class":178},[169,313,314],{"class":293},"'radius'",[169,316,317],{"class":178},")})\n",[319,320,321],"blockquote",{},[156,322,323,327,328,330,331,334],{},[324,325,326],"strong",{},"Tip."," Leave the ",[8,329,199],{}," prop without a ",[8,332,333],{},"transform",": it must stay a string for the frame to read.",[217,336,338],{"id":337},"see-also","See also",[340,341,342,352,361,370,379],"ul",{},[343,344,345,351],"li",{},[346,347,349],"a",{"href":348},"\u002Fdocs\u002Fprimitives\u002Feffects-blurs\u002Fpeelcompose",[8,350,215],{}," — A finished page peel: the cast shadows, the flat page and the lit curl, layered back to front.",[343,353,354,360],{},[346,355,357],{"href":356},"\u002Fdocs\u002Fprimitives\u002Feffects-blurs\u002Fcurlshading",[8,358,359],{},"curlShading"," — The darkening in the crook of a curl, easing to full brightness at the lip.",[343,362,363,369],{},[346,364,366],{"href":365},"\u002Fdocs\u002Fprimitives\u002Feffects-blurs\u002Fcurlsheen",[8,367,368],{},"curlSheen"," — The band of light running up a curl.",[343,371,372,378],{},[346,373,375],{"href":374},"\u002Fdocs\u002Fprimitives\u002Feffects-blurs\u002Foverhangshadow",[8,376,377],{},"overhangShadow"," — The shadow a lifted curl casts on the flat page just past the crease.",[343,380,381,387],{},[346,382,384],{"href":383},"\u002Fdocs\u002Fprimitives\u002Feffects-blurs\u002Frevealshadow",[8,385,386],{},"revealShadow"," — The shadow on the surface a peel reveals, just inside the crease.",[217,389,391],{"id":390},"used-by","Used by",[156,393,394],{},[346,395,397],{"href":396},"\u002Fdocs\u002Fcomponents\u002Fpagepeel","PagePeel",[399,400,401],"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 .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}html pre.shiki code .sDLfK, html code.shiki .sDLfK{--shiki-default:#79B8FF}html pre.shiki code .sU2Wk, html code.shiki .sU2Wk{--shiki-default:#9ECBFF}",{"title":165,"searchDepth":403,"depth":403,"links":404},2,[405,406,407,408],{"id":219,"depth":403,"text":220},{"id":260,"depth":403,"text":261},{"id":337,"depth":403,"text":338},{"id":390,"depth":403,"text":391},"effects.blurs","effects-blurs","Blurs, glows & screens",false,"md","Filters & effects","function",{},true,"\u002Fdocs\u002Fprimitives\u002Feffects-blurs\u002Fpeelframe",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Feffects\u002Fblurs.ts#L1233","docs\u002Fprimitives\u002F27.effects-blurs\u002F36.peelframe","ZeV99zmluZrKaMBocaRa-bWbdLTt3mw9TOB99YObsEI"]