@tigerface/lwc-test-utils

Version:

A collection of helpful utility functions for unit testing LWC components with Jest.

26 lines (20 loc) • 8.46 kB

HTML

<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@tigerface/lwc-test-utils</title><meta name="description" content="Documentation for @tigerface/lwc-test-utils"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">@tigerface/lwc-test-utils</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>@tigerface/lwc-test-utils</h1></div><div class="tsd-panel tsd-typography"><h1 id="lwc-test-utils" class="tsd-anchor-link">LWC Test Utils<a href="#lwc-test-utils" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p>A collection of test utilities for unit testing LWC components with Jest.</p> <p>Docs: <a href="https://edodso2.github.io/lwc-test-utils/">https://edodso2.github.io/lwc-test-utils/</a></p> <p>Turn repetitive code like this:</p> <pre><code class="JavaScript"><span class="hl-0">// update the inputs value</span><br/><span class="hl-1">inputEl</span><span class="hl-2">.</span><span class="hl-1">value</span><span class="hl-2"> = </span><span class="hl-1">value</span><span class="hl-2">;</span><br/><br/><span class="hl-0">// fire change event</span><br/><span class="hl-3">const</span><span class="hl-2"> </span><span class="hl-4">changeEvent</span><span class="hl-2"> = </span><span class="hl-3">new</span><span class="hl-2"> </span><span class="hl-5">CustomEvent</span><span class="hl-2">(</span><span class="hl-6">'change'</span><span class="hl-2">);</span><br/><span class="hl-1">inputEl</span><span class="hl-2">.</span><span class="hl-5">dispatchEvent</span><span class="hl-2">(</span><span class="hl-1">changeEvent</span><span class="hl-2">);</span> </code><button type="button">Copy</button></pre> <p>Into clean declarative code like this:</p> <pre><code class="JavaScript"><span class="hl-1">Simulate</span><span class="hl-2">.</span><span class="hl-5">inputChange</span><span class="hl-2">(</span><span class="hl-1">lightningInputEl</span><span class="hl-2">, </span><span class="hl-4">NEW_VALUE</span><span class="hl-2">);</span> </code><button type="button">Copy</button></pre> <h3 id="getting-started" class="tsd-anchor-link">Getting Started<a href="#getting-started" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Install the package:</p> <pre><code><span class="hl-1">npm</span><span class="hl-2"> </span><span class="hl-1">install</span><span class="hl-2"> -</span><span class="hl-4">D</span><span class="hl-2"> @</span><span class="hl-1">tigerface</span><span class="hl-2">/</span><span class="hl-1">lwc</span><span class="hl-2">-</span><span class="hl-1">test</span><span class="hl-2">-</span><span class="hl-1">utils</span> </code><button>Copy</button></pre> <p>Import the Simulate class:</p> <pre><code class="JavaScript"><span class="hl-7">import</span><span class="hl-2"> { </span><span class="hl-1">Simulate</span><span class="hl-2"> } </span><span class="hl-7">from</span><span class="hl-2"> </span><span class="hl-6">'@tigerface/lwc-test-utils'</span><span class="hl-2">;</span> </code><button type="button">Copy</button></pre> <p>Simulate!</p> <pre><code class="JavaScript"><span class="hl-1">Simulate</span><span class="hl-2">.</span><span class="hl-5">inputChange</span><span class="hl-2">(</span><span class="hl-1">lightningInputEl</span><span class="hl-2">, </span><span class="hl-4">NEW_VALUE</span><span class="hl-2">);</span> </code><button type="button">Copy</button></pre> <hr> <p>Contributions are welcome.</p> </div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#lwc-test-utils"><span>LWC <wbr/>Test <wbr/>Utils</span></a><ul><li><a href="#getting-started"><span>Getting <wbr/>Started</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html">@tigerface/lwc-test-utils</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>