scrawl-canvas
Version:
Version 8.9.4 - 19 Nov 2022
452 lines (308 loc) • 19.6 kB
HTML
<html>
<head>
<title>Demo Snippets 003</title>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<link rel="stylesheet" media="all" href="../../docco.css" />
</head>
<body>
<div id="container">
<div id="background"></div>
<ul id="jump_to">
<li>
<a class="large" href="javascript:void(0);">Jump To …</a>
<a class="small" href="javascript:void(0);">+</a>
<div id="jump_wrapper">
<div id="jump_page_wrapper">
<div id="jump_page">
<a class="source" href="../modules/canvas-minimap.html">
./demo/modules/canvas-minimap.js
</a>
<a class="source" href="../modules/canvas-scene-editor.html">
./demo/modules/canvas-scene-editor.js
</a>
<a class="source" href="../modules/dom-entity-editor.html">
./demo/modules/dom-entity-editor.js
</a>
<a class="source" href="../modules/entity-copy-paste.html">
./demo/modules/entity-copy-paste.js
</a>
<a class="source" href="../modules/entity-manipulation-gui.html">
./demo/modules/entity-manipulation-gui.js
</a>
<a class="source" href="../modules/entity-navigation.html">
./demo/modules/entity-navigation.js
</a>
<a class="source" href="../modules/entity-ring-builder.html">
./demo/modules/entity-ring-builder.js
</a>
<a class="source" href="../modules/london-crime-graphic.html">
./demo/modules/london-crime-graphic.js
</a>
<a class="source" href="../modules/london-crime-lines.html">
./demo/modules/london-crime-lines.js
</a>
<a class="source" href="../modules/london-crime-stacked-bars.html">
./demo/modules/london-crime-stacked-bars.js
</a>
<a class="source" href="../modules/lottie-loader.html">
./demo/modules/lottie-loader.js
</a>
<a class="source" href="../modules/simple-chart-frame-tests.html">
./demo/modules/simple-chart-frame-tests.js
</a>
<a class="source" href="../modules/simple-chart-frame.html">
./demo/modules/simple-chart-frame.js
</a>
<a class="source" href="../modules/simple-graph-lines.html">
./demo/modules/simple-graph-lines.js
</a>
<a class="source" href="../modules/simple-graph-stacked-bars.html">
./demo/modules/simple-graph-stacked-bars.js
</a>
<a class="source" href="../modules/wikipedia-views-spiral-chart.html">
./demo/modules/wikipedia-views-spiral-chart.js
</a>
<a class="source" href="animated-highlight-gradient-text-snippet.html">
./demo/snippets/animated-highlight-gradient-text-snippet.js
</a>
<a class="source" href="animated-hover-gradient-snippet.html">
./demo/snippets/animated-hover-gradient-snippet.js
</a>
<a class="source" href="animated-word-gradient-snippet.html">
./demo/snippets/animated-word-gradient-snippet.js
</a>
<a class="source" href="before-after-slider-infographic.html">
./demo/snippets/before-after-slider-infographic.js
</a>
<a class="source" href="bubbles-text-snippet.html">
./demo/snippets/bubbles-text-snippet.js
</a>
<a class="source" href="green-box-snippet.html">
./demo/snippets/green-box-snippet.js
</a>
<a class="source" href="jazzy-button-snippet.html">
./demo/snippets/jazzy-button-snippet.js
</a>
<a class="source" href="page-performance-snippet-test.html">
./demo/snippets/page-performance-snippet-test.js
</a>
<a class="source" href="page-performance-snippet.html">
./demo/snippets/page-performance-snippet.js
</a>
<a class="source" href="pan-image-snippet.html">
./demo/snippets/pan-image-snippet.js
</a>
<a class="source" href="placeholder-effect-snippet.html">
./demo/snippets/placeholder-effect-snippet.js
</a>
<a class="source" href="ripple-effect-snippet.html">
./demo/snippets/ripple-effect-snippet.js
</a>
<a class="source" href="risograph-text-gradient-snippet.html">
./demo/snippets/risograph-text-gradient-snippet.js
</a>
<a class="source" href="spotlight-text-snippet-test.html">
./demo/snippets/spotlight-text-snippet-test.js
</a>
<a class="source" href="spotlight-text-snippet.html">
./demo/snippets/spotlight-text-snippet.js
</a>
<a class="source" href="swirling-stripes-text-snippet.html">
./demo/snippets/swirling-stripes-text-snippet.js
</a>
<a class="source" href="text-snippet-helper.html">
./demo/snippets/text-snippet-helper.js
</a>
<a class="source" href="word-highlighter-snippet.html">
./demo/snippets/word-highlighter-snippet.js
</a>
<a class="source" href="worley-text-gradient-snippet.html">
./demo/snippets/worley-text-gradient-snippet.js
</a>
</div>
</div>
</li>
</ul>
<ul class="sections">
<li id="section-1">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-1">§</a>
</div>
<h1 id="demo-snippets-003">Demo Snippets 003</h1>
<p>DOM element snippet - test canvas adaption to local element variations</p>
<p>Related files:</p>
<ul>
<li><a href="../snippets-003.html">DOM element snippets - main module</a></li>
</ul>
<h3 id="ripple-effect-snippet">‘Ripple effect’ snippet</h3>
<p><strong>Purpose:</strong> replicate the Material design ‘ripple effect’ when user clicks on an element decorated with this snippet.
<strong>Function input:</strong> </p>
<ul>
<li>the DOM element, or a handle to it, as the first argument.</li>
<li>an optional key:value Object as the second argument</li>
</ul>
<p><strong>Function output:</strong> </p>
<pre><code>{
element <span class="hljs-comment">// wrapper</span>
canvas <span class="hljs-comment">// wrapper</span>
animation <span class="hljs-comment">// object</span>
demolish <span class="hljs-comment">// function</span>
}
</code></pre>
<h5 id="usage-example">Usage example:</h5>
<pre><code><span class="hljs-keyword">import</span> ripples <span class="hljs-keyword">from</span> <span class="hljs-string">'./relative/or/absolute/path/to/this/file.js'</span>;
<span class="hljs-keyword">let</span> myElements = <span class="hljs-variable language_">document</span>.<span class="hljs-title function_">querySelectorAll</span>(<span class="hljs-string">'.some-class'</span>);
myElements.<span class="hljs-title function_">forEach</span>(<span class="hljs-function"><span class="hljs-params">el</span> =></span> <span class="hljs-title function_">ripples</span>(el, {
<span class="hljs-attr">backgroundColor</span>: <span class="hljs-string">'red'</span>,
<span class="hljs-attr">rippleColor</span>: <span class="hljs-string">'pink'</span>,
}));
</code></pre>
</div>
</li>
<li id="section-2">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-2">§</a>
</div>
<p>Import the Scrawl-canvas object </p>
<ul>
<li>there’s various ways to do this. See <a href="../dom-001.html">Demo DOM-001</a> for more details</li>
</ul>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-keyword">import</span> * <span class="hljs-keyword">as</span> scrawl <span class="hljs-keyword">from</span> <span class="hljs-string">'../../source/scrawl.js'</span>;</pre></div></div>
</li>
<li id="section-3">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-3">§</a>
</div>
<p><strong>Effects on the element:</strong> </p>
<ul>
<li>The DOM element’s background color will be brought into the canvas, with the element’s backgroundColor set to <code>transparent</code> - any background image, gradient, etc will be hidden by the snippet effect</li>
</ul>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-keyword">export</span> <span class="hljs-keyword">default</span> <span class="hljs-keyword">function</span> (<span class="hljs-params">el, args = {}</span>) {</pre></div></div>
</li>
<li id="section-4">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-4">§</a>
</div>
<p>The snippet will accept an optional key:value Object as the second argument</p>
<ul>
<li><strong>rippleColor</strong> - default: <code>white</code></li>
<li><strong>backgroundColor</strong> - default: false (will use the DOM element’s background-color style)</li>
</ul>
</div>
<div class="content"><div class='highlight'><pre> <span class="hljs-keyword">let</span> backgroundColor = args.<span class="hljs-property">backgroundColor</span> || <span class="hljs-literal">false</span>,
rippleColor = args.<span class="hljs-property">rippleColor</span> || <span class="hljs-string">'white'</span>;</pre></div></div>
</li>
<li id="section-5">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-5">§</a>
</div>
<p>Apply the snippet to the DOM element</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="hljs-keyword">let</span> snippet = scrawl.<span class="hljs-title function_">makeSnippet</span>({
<span class="hljs-attr">domElement</span>: el,
});
<span class="hljs-keyword">if</span> (snippet) {</pre></div></div>
</li>
<li id="section-6">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-6">§</a>
</div>
<p>Set some convenience variables</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="hljs-keyword">let</span> canvas = snippet.<span class="hljs-property">canvas</span>,
wrapper = snippet.<span class="hljs-property">element</span>,
styles = wrapper.<span class="hljs-property">elementComputedStyles</span>,
name = wrapper.<span class="hljs-property">name</span>;</pre></div></div>
</li>
<li id="section-7">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-7">§</a>
</div>
<p>Transfer the DOM element’s current background-color style over to the canvas</p>
<ul>
<li>This does not handle situations where the DOM element has a gradient assigned to it</li>
<li>if the function is invoked with the backgroundColor attribute set in the args Object, that color will replace the DOM element’s current background color</li>
</ul>
</div>
<div class="content"><div class='highlight'><pre> <span class="hljs-keyword">if</span> (!backgroundColor) backgroundColor = styles.<span class="hljs-property">backgroundColor</span>;</pre></div></div>
</li>
<li id="section-8">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-8">§</a>
</div>
<p>We don’t want a transparent background - default to beige!</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="hljs-keyword">if</span> (<span class="hljs-string">'rgba(0, 0, 0, 0)'</span> === backgroundColor || <span class="hljs-string">'transparent'</span> === backgroundColor || <span class="hljs-string">'#00000000'</span> === backgroundColor || <span class="hljs-string">'#0000'</span> === backgroundColor) backgroundColor = <span class="hljs-string">'beige'</span>;
canvas.<span class="hljs-title function_">set</span>({
backgroundColor,
})
wrapper.<span class="hljs-property">domElement</span>.<span class="hljs-property">style</span>.<span class="hljs-property">backgroundColor</span> = <span class="hljs-string">'transparent'</span>;</pre></div></div>
</li>
<li id="section-9">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-9">§</a>
</div>
<p>We add an event listener to the DOM element</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="hljs-keyword">let</span> <span class="hljs-title function_">clickAction</span> = (<span class="hljs-params">e</span>) => {
<span class="hljs-keyword">let</span> {x, y, active} = canvas.<span class="hljs-property">here</span>;
<span class="hljs-keyword">if</span> (active) {</pre></div></div>
</li>
<li id="section-10">
<div class="annotation">
<div class="sswrap ">
<a class="ss" href="#section-10">§</a>
</div>
<p>Implement the ripple effect using a run-once-and-die tween operating on a create-and-destroy Wheel entity</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="hljs-keyword">let</span> r = scrawl.<span class="hljs-title function_">makeWheel</span>({
<span class="hljs-attr">name</span>: <span class="hljs-string">`<span class="hljs-subst">${name}</span>-ripple`</span>,
<span class="hljs-attr">start</span>: [x, y],
<span class="hljs-attr">group</span>: canvas.<span class="hljs-property">base</span>.<span class="hljs-property">name</span>,
<span class="hljs-attr">handle</span>: [<span class="hljs-string">'center'</span>, <span class="hljs-string">'center'</span>],
<span class="hljs-attr">radius</span>: <span class="hljs-string">'100%'</span>,
<span class="hljs-attr">fillStyle</span>: rippleColor,
});
scrawl.<span class="hljs-title function_">makeTween</span>({
<span class="hljs-attr">name</span>: <span class="hljs-string">`<span class="hljs-subst">${name}</span>-tween`</span>,
<span class="hljs-attr">targets</span>: r,
<span class="hljs-attr">duration</span>: <span class="hljs-number">1000</span>,
<span class="hljs-attr">completeAction</span>: <span class="hljs-function">() =></span> r.<span class="hljs-title function_">kill</span>(),
<span class="hljs-attr">killOnComplete</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">definitions</span>: [
{
<span class="hljs-attr">attribute</span>: <span class="hljs-string">'scale'</span>,
<span class="hljs-attr">start</span>: <span class="hljs-number">0</span>,
<span class="hljs-attr">end</span>: <span class="hljs-number">1</span>,
}, {
<span class="hljs-attr">attribute</span>: <span class="hljs-string">'globalAlpha'</span>,
<span class="hljs-attr">start</span>: <span class="hljs-number">1</span>,
<span class="hljs-attr">end</span>: <span class="hljs-number">0</span>,
}
],
}).<span class="hljs-title function_">run</span>();
}
};
scrawl.<span class="hljs-title function_">addNativeListener</span>([<span class="hljs-string">'click'</span>, <span class="hljs-string">'touchend'</span>], clickAction, el);
}
<span class="hljs-keyword">return</span> snippet;
};
<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(scrawl.<span class="hljs-property">library</span>);</pre></div></div>
</li>
</ul>
</div>
</body>
</html>