[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Feffects-reveal\u002Freveal":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":422,"categorySlug":423,"categoryTitle":424,"curated":425,"description":426,"editUrl":9,"extension":427,"group":188,"groupTitle":428,"kind":429,"meta":430,"navigation":431,"path":432,"seo":433,"sourceUrl":434,"stem":435,"wordCount":9,"__hash__":436},"primitives\u002Fdocs\u002Fprimitives\u002F30.effects-reveal\u002F1.reveal.md","reveal",{"type":149,"value":150,"toc":415},"minimark",[151,154,162,183,198,209,214,251,255,320,333,337,360,364,411],[152,153,147],"h1",{"id":147},[155,156,157,158,161],"p",{},"Fade the child away in coverage order as ",[8,159,160],{},"progress"," goes from 0 to 1.",[163,164,169],"pre",{"className":165,"code":166,"language":167,"meta":168,"style":168},"language-ts shiki shiki-themes github-dark","reveal(slots: RevealSlots): PointwiseEffect\n","ts","",[8,170,171],{"__ignoreMap":168},[172,173,176,179],"span",{"class":174,"line":175},"line",1,[172,177,147],{"class":178},"svObZ",[172,180,182],{"class":181},"s95oV","(slots: RevealSlots): PointwiseEffect\n",[155,184,185,186,189,190,193,194,197],{},"Import ",[8,187,188],{},"effects"," from ",[8,191,192],{},"shaders\u002Fstd"," and use ",[8,195,196],{},"effects.reveal.reveal",".",[155,199,200,201,204,205,208],{},"At 0 the child is fully visible, at 1 it is gone, whatever ",[8,202,203],{},"feather"," is. Only the child's alpha changes; its colors stay put. Turning ",[8,206,207],{},"invert"," on reverses the order, so the last pixels go first.",[210,211,213],"h2",{"id":212},"parameters","Parameters",[215,216,217,233],"table",{},[218,219,220],"thead",{},[221,222,223,227,230],"tr",{},[224,225,226],"th",{},"Name",[224,228,229],{},"Type",[224,231,232],{},"Notes",[234,235,236],"tbody",{},[221,237,238,244,249],{},[239,240,241],"td",{},[8,242,243],{},"slots",[239,245,246],{},[8,247,248],{},"RevealSlots",[239,250],{},[210,252,254],{"id":253},"example","Example",[163,256,258],{"className":165,"code":257,"language":167,"meta":168,"style":168},"effect: reveal({coverage: coverage.directional(p('angle')), progress: p('progress'), feather: p('feather'), invert: p('invert')})\n",[8,259,260],{"__ignoreMap":168},[172,261,262,265,268,270,273,276,279,281,283,287,290,292,294,297,300,302,304,307,310,312,314,317],{"class":174,"line":175},[172,263,264],{"class":178},"effect",[172,266,267],{"class":181},": ",[172,269,147],{"class":178},[172,271,272],{"class":181},"({coverage: coverage.",[172,274,275],{"class":178},"directional",[172,277,278],{"class":181},"(",[172,280,155],{"class":178},[172,282,278],{"class":181},[172,284,286],{"class":285},"sU2Wk","'angle'",[172,288,289],{"class":181},")), progress: ",[172,291,155],{"class":178},[172,293,278],{"class":181},[172,295,296],{"class":285},"'progress'",[172,298,299],{"class":181},"), feather: ",[172,301,155],{"class":178},[172,303,278],{"class":181},[172,305,306],{"class":285},"'feather'",[172,308,309],{"class":181},"), invert: ",[172,311,155],{"class":178},[172,313,278],{"class":181},[172,315,316],{"class":285},"'invert'",[172,318,319],{"class":181},")})\n",[321,322,323],"blockquote",{},[155,324,325,329,330,332],{},[326,327,328],"strong",{},"Tip."," Animate ",[8,331,160],{}," from outside (a prop driven by scroll or a tween); the wipe itself has no clock.",[210,334,336],{"id":335},"see-also","See also",[338,339,340,351],"ul",{},[341,342,343,350],"li",{},[344,345,347],"a",{"href":346},"\u002Fdocs\u002Fprimitives\u002Feffects-reveal\u002Fcoverage",[8,348,349],{},"coverage"," — The orders a wipe can follow.",[341,352,353,359],{},[344,354,356],{"href":355},"\u002Fdocs\u002Fprimitives\u002Feffects-reveal\u002Fcoverage-class",[8,357,358],{},"Coverage"," — The order pixels disappear in: a number per pixel from 0 (goes first) to 1 (goes last).",[210,361,363],{"id":362},"used-by","Used by",[155,365,366,370,371,370,375,370,379,370,383,370,387,370,391,370,395,370,399,370,403,370,407],{},[344,367,369],{"href":368},"\u002Fdocs\u002Fcomponents\u002Fbarndoors","BarnDoors",", ",[344,372,374],{"href":373},"\u002Fdocs\u002Fcomponents\u002Fblockdissolve","BlockDissolve",[344,376,378],{"href":377},"\u002Fdocs\u002Fcomponents\u002Fcheckerwipe","CheckerWipe",[344,380,382],{"href":381},"\u002Fdocs\u002Fcomponents\u002Fdiamondwipe","DiamondWipe",[344,384,386],{"href":385},"\u002Fdocs\u002Fcomponents\u002Firiswipe","IrisWipe",[344,388,390],{"href":389},"\u002Fdocs\u002Fcomponents\u002Flinearwipe","LinearWipe",[344,392,394],{"href":393},"\u002Fdocs\u002Fcomponents\u002Fnoisedissolve","NoiseDissolve",[344,396,398],{"href":397},"\u002Fdocs\u002Fcomponents\u002Fradialwipe","RadialWipe",[344,400,402],{"href":401},"\u002Fdocs\u002Fcomponents\u002Frandombars","RandomBars",[344,404,406],{"href":405},"\u002Fdocs\u002Fcomponents\u002Fripplewipe","RippleWipe",[344,408,410],{"href":409},"\u002Fdocs\u002Fcomponents\u002Fvenetianblinds","VenetianBlinds",[412,413,414],"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 .sU2Wk, html code.shiki .sU2Wk{--shiki-default:#9ECBFF}",{"title":168,"searchDepth":416,"depth":416,"links":417},2,[418,419,420,421],{"id":212,"depth":416,"text":213},{"id":253,"depth":416,"text":254},{"id":335,"depth":416,"text":336},{"id":362,"depth":416,"text":363},"effects.reveal","effects-reveal","Reveals & wipes",false,"Fade the child away in coverage order as `progress` goes from 0 to 1.","md","Filters & effects","function",{},true,"\u002Fdocs\u002Fprimitives\u002Feffects-reveal\u002Freveal",{"title":147,"description":426},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Feffects\u002Freveal.ts#L273","docs\u002Fprimitives\u002F30.effects-reveal\u002F1.reveal","cO_tJjOm24qLPA3b5FkiLYc1WQH_Y0Z0ulVMQjIwgN8"]