Skip to content

Commit

Permalink
Publish 'site' to 'gh-pages' in 'ShellyDCMS/cypress-test-utils'
Browse files Browse the repository at this point in the history
  • Loading branch information
ShellyDCMS committed Oct 30, 2024
1 parent 39474fd commit 9eb7eab
Show file tree
Hide file tree
Showing 8 changed files with 37 additions and 25 deletions.
18 changes: 4 additions & 14 deletions classes/Assertable.html
Original file line number Diff line number Diff line change
Expand Up @@ -3592,7 +3592,7 @@



<p><a href="../index.html">@shellygo/cypress-test-utils - v3.1.3</a> / <a href="../modules.html">Modules</a> / Assertable</p>
<p><a href="../index.html">@shellygo/cypress-test-utils - v3.1.4</a> / <a href="../modules.html">Modules</a> / Assertable</p>
<h1 id="class-assertablet">Class: Assertable&lt;T&gt;</h1>
<p>Assertable wraps Cypress.Chainable so that your tests are as decoupled as possible from Cypress.
By using the Assertable class, you can use the same assertions in your tests, regardless of the testing framework you use.
Expand Down Expand Up @@ -3764,7 +3764,7 @@ <h4 id="returns">Returns</h4>
<p><code>Chainable</code>&lt;<code>T</code>&gt;</p>
<hr />
<h3 id="shouldbeaccessible">shouldBeAccessible</h3>
<p><strong>shouldBeAccessible</strong>(<code>options?</code>, <code>violationCallback?</code>, <code>skipFailures?</code>): <code>void</code></p>
<p><strong>shouldBeAccessible</strong>(<code>options?</code>): <code>void</code></p>
<p>Assert that there are no A11y violations.
This will run axe against the document at the point in which it is called.
This means you can call this after interacting with your page and uncover accessibility issues introduced as a result of rendering in response to user actions</p>
Expand All @@ -3780,18 +3780,8 @@ <h4 id="parameters_2">Parameters</h4>
<tbody>
<tr>
<td style="text-align: left;"><code>options</code></td>
<td style="text-align: left;"><code>Options</code></td>
<td style="text-align: left;">Set of options passed into rules or checks, temporarily modifying them. This contrasts with axe.configure, which is more permanent.</td>
</tr>
<tr>
<td style="text-align: left;"><code>violationCallback?</code></td>
<td style="text-align: left;">(<code>violations</code>: <code>Result</code>[]) =&gt; <code>void</code></td>
<td style="text-align: left;">Allows you to define a callback that receives the violations for custom side-effects, such as adding custom output to the terminal.</td>
</tr>
<tr>
<td style="text-align: left;"><code>skipFailures?</code></td>
<td style="text-align: left;"><code>boolean</code></td>
<td style="text-align: left;">Disables assertions based on violations and only logs violations to the console output. This enabled you to see violations while allowing your tests to pass. This should be used as a temporary measure while you address accessibility violations</td>
<td style="text-align: left;"><a href="../modules.html#a11yoptions"><code>A11yOptions</code></a></td>
<td style="text-align: left;">Set of options passed into rules or checks, temporarily modifying them. This enabled you to see violations while allowing your tests to pass. This should be used as a temporary measure while you address accessibility violations</td>
</tr>
</tbody>
</table>
Expand Down
2 changes: 1 addition & 1 deletion classes/CypressAngularComponentHelper.html
Original file line number Diff line number Diff line change
Expand Up @@ -874,7 +874,7 @@



<p><a href="../index.html">@shellygo/cypress-test-utils - v3.1.3</a> / <a href="../modules.html">Modules</a> / CypressAngularComponentHelper</p>
<p><a href="../index.html">@shellygo/cypress-test-utils - v3.1.4</a> / <a href="../modules.html">Modules</a> / CypressAngularComponentHelper</p>
<h1 id="class-cypressangularcomponenthelpert">Class: CypressAngularComponentHelper&lt;T&gt;</h1>
<p><strong><code>Classdes</code></strong></p>
<p>CypressAngularComponentHelper exposes the following public properties:</p>
Expand Down
6 changes: 3 additions & 3 deletions classes/CypressHelper.html
Original file line number Diff line number Diff line change
Expand Up @@ -1000,7 +1000,7 @@



<p><a href="../index.html">@shellygo/cypress-test-utils - v3.1.3</a> / <a href="../modules.html">Modules</a> / CypressHelper</p>
<p><a href="../index.html">@shellygo/cypress-test-utils - v3.1.4</a> / <a href="../modules.html">Modules</a> / CypressHelper</p>
<h1 id="class-cypresshelper">Class: CypressHelper</h1>
<p><strong><code>Classdes</code></strong></p>
<p>CypressHelper exposes the following public properties:</p>
Expand Down Expand Up @@ -1080,7 +1080,7 @@ <h4 id="type-declaration">Type declaration</h4>
</tr>
<tr>
<td style="text-align: left;"><code>elementByText</code></td>
<td style="text-align: left;">(<code>content</code>: <code>string</code> | <code>RegExp</code>, <code>index?</code>: <code>number</code>) =&gt; <code>Chainable</code>&lt;<code>undefined</code>&gt; | <code>Chainable</code>&lt;<code>JQuery</code>&lt;<code>HTMLElement</code>&gt;&gt;</td>
<td style="text-align: left;">(<code>content</code>: <code>string</code> | <code>RegExp</code>, <code>index?</code>: <code>number</code>) =&gt; <code>Chainable</code>&lt;<code>JQuery</code>&lt;<code>HTMLElement</code>&gt;&gt; | <code>Chainable</code>&lt;<code>undefined</code>&gt;</td>
</tr>
<tr>
<td style="text-align: left;"><code>elementComputedStyleProperty</code></td>
Expand Down Expand Up @@ -1236,7 +1236,7 @@ <h4 id="type-declaration">Type declaration</h4>
</span><span id="__span-6-3"><a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a><span class="w"> </span><span class="nx">helper</span><span class="p">.</span><span class="nx">get</span><span class="p">.</span><span class="nx">elementByTestId</span><span class="p">(</span><span class="s1">&#39;available-items&#39;</span><span class="p">)</span>
</span></code></pre></div>
<hr />
<p><strong>elementByText</strong>: (<code>content</code>: <code>string</code> | <code>RegExp</code>, <code>index?</code>: <code>number</code>) =&gt; <code>Chainable</code>&lt;<code>undefined</code>&gt; | <code>Chainable</code>&lt;<code>JQuery</code>&lt;<code>HTMLElement</code>&gt;&gt;</p>
<p><strong>elementByText</strong>: (<code>content</code>: <code>string</code> | <code>RegExp</code>, <code>index?</code>: <code>number</code>) =&gt; <code>Chainable</code>&lt;<code>JQuery</code>&lt;<code>HTMLElement</code>&gt;&gt; | <code>Chainable</code>&lt;<code>undefined</code>&gt;</p>
<p>Get the DOM element containing the text.
DOM elements can contain more than the desired text and still match.
Additionally, Cypress prefers some DOM elements over the deepest element found.
Expand Down
2 changes: 1 addition & 1 deletion classes/CypressHelperOptions.html
Original file line number Diff line number Diff line change
Expand Up @@ -820,7 +820,7 @@



<p><a href="../index.html">@shellygo/cypress-test-utils - v3.1.3</a> / <a href="../modules.html">Modules</a> / CypressHelperOptions</p>
<p><a href="../index.html">@shellygo/cypress-test-utils - v3.1.4</a> / <a href="../modules.html">Modules</a> / CypressHelperOptions</p>
<h1 id="class-cypresshelperoptions">Class: CypressHelperOptions</h1>
<h2 id="table-of-contents">Table of contents</h2>
<h3 id="constructors">Constructors</h3>
Expand Down
2 changes: 1 addition & 1 deletion classes/CypressLitComponentHelper.html
Original file line number Diff line number Diff line change
Expand Up @@ -814,7 +814,7 @@



<p><a href="../index.html">@shellygo/cypress-test-utils - v3.1.3</a> / <a href="../modules.html">Modules</a> / CypressLitComponentHelper</p>
<p><a href="../index.html">@shellygo/cypress-test-utils - v3.1.4</a> / <a href="../modules.html">Modules</a> / CypressLitComponentHelper</p>
<h1 id="class-cypresslitcomponenthelper">Class: CypressLitComponentHelper</h1>
<p><strong><code>Classdes</code></strong></p>
<p>CypressLitComponentHelper exposes the following public properties:</p>
Expand Down
2 changes: 1 addition & 1 deletion classes/CypressReactComponentHelper.html
Original file line number Diff line number Diff line change
Expand Up @@ -824,7 +824,7 @@



<p><a href="../index.html">@shellygo/cypress-test-utils - v3.1.3</a> / <a href="../modules.html">Modules</a> / CypressReactComponentHelper</p>
<p><a href="../index.html">@shellygo/cypress-test-utils - v3.1.4</a> / <a href="../modules.html">Modules</a> / CypressReactComponentHelper</p>
<h1 id="class-cypressreactcomponenthelper">Class: CypressReactComponentHelper</h1>
<p><strong><code>Classdes</code></strong></p>
<p>CypressReactComponentHelper exposes the following public properties:</p>
Expand Down
28 changes: 25 additions & 3 deletions modules.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
<div data-md-component="skip">


<a href="#shellygocypress-test-utils-v313" class="md-skip">
<a href="#shellygocypress-test-utils-v314" class="md-skip">
Skip to content
</a>

Expand Down Expand Up @@ -411,6 +411,15 @@
<nav class="md-nav" aria-label="Type Aliases">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#a11yoptions" class="md-nav__link">
<span class="md-ellipsis">
A11yOptions
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#snapshotoptions" class="md-nav__link">
<span class="md-ellipsis">
Expand Down Expand Up @@ -861,6 +870,15 @@
<nav class="md-nav" aria-label="Type Aliases">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#a11yoptions" class="md-nav__link">
<span class="md-ellipsis">
A11yOptions
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#snapshotoptions" class="md-nav__link">
<span class="md-ellipsis">
Expand Down Expand Up @@ -1067,8 +1085,8 @@



<p><a href="index.html">@shellygo/cypress-test-utils - v3.1.3</a> / Modules</p>
<h1 id="shellygocypress-test-utils-v313">@shellygo/cypress-test-utils - v3.1.3</h1>
<p><a href="index.html">@shellygo/cypress-test-utils - v3.1.4</a> / Modules</p>
<h1 id="shellygocypress-test-utils-v314">@shellygo/cypress-test-utils - v3.1.4</h1>
<h2 id="table-of-contents">Table of contents</h2>
<h3 id="classes">Classes</h3>
<ul>
Expand All @@ -1081,6 +1099,7 @@ <h3 id="classes">Classes</h3>
</ul>
<h3 id="type-aliases">Type Aliases</h3>
<ul>
<li><a href="modules.html#a11yoptions">A11yOptions</a></li>
<li><a href="modules.html#snapshotoptions">SnapshotOptions</a></li>
<li><a href="modules.html#stubbedinstance">StubbedInstance</a></li>
</ul>
Expand All @@ -1090,6 +1109,9 @@ <h3 id="functions">Functions</h3>
<li><a href="modules.html#then">then</a></li>
</ul>
<h2 id="type-aliases_1">Type Aliases</h2>
<h3 id="a11yoptions">A11yOptions</h3>
<p>Ƭ <strong>A11yOptions</strong>: { <code>skipFailures?</code>: <code>boolean</code> ; <code>violationCallback?</code>: (<code>violations</code>: <code>axe.Result</code>[]) =&gt; <code>void</code> } &amp; <code>AxeOptions</code></p>
<hr />
<h3 id="snapshotoptions">SnapshotOptions</h3>
<p>Ƭ <strong>SnapshotOptions</strong>: { <code>dataTestID?</code>: <code>string</code> ; <code>index?</code>: <code>number</code> } &amp; <code>CypressImageSnapshotOptions</code></p>
<hr />
Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

0 comments on commit 9eb7eab

Please sign in to comment.