Skip to content

Commit

Permalink
Update samples and api doc
Browse files Browse the repository at this point in the history
  • Loading branch information
supnate committed Sep 29, 2023
1 parent c796283 commit 162e8a4
Show file tree
Hide file tree
Showing 10 changed files with 96 additions and 114 deletions.
154 changes: 68 additions & 86 deletions docs/api/index.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/api/interfaces/NiceModalAction.html
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ <h3>payload</h3>
<div class="tsd-signature tsd-kind-icon">payload<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>args<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>flags<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>modalId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/e086bec/src/index.tsx#L30">index.tsx:30</a></li>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/c796283/src/index.tsx#L30">src/index.tsx:30</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
Expand All @@ -119,7 +119,7 @@ <h3>type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/e086bec/src/index.tsx#L29">index.tsx:29</a></li>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/c796283/src/index.tsx#L29">src/index.tsx:29</a></li>
</ul>
</aside>
</section>
Expand Down
22 changes: 11 additions & 11 deletions docs/api/interfaces/NiceModalHandler.html
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> args</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="NiceModalState.html">NiceModalState</a>.<a href="NiceModalState.html#args">args</a></p>
<ul>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/e086bec/src/index.tsx#L18">index.tsx:18</a></li>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/c796283/src/index.tsx#L18">src/index.tsx:18</a></li>
</ul>
</aside>
</section>
Expand All @@ -141,7 +141,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> delay<wbr>Visible</h3
<aside class="tsd-sources">
<p>Inherited from <a href="NiceModalState.html">NiceModalState</a>.<a href="NiceModalState.html#delayVisible">delayVisible</a></p>
<ul>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/e086bec/src/index.tsx#L20">index.tsx:20</a></li>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/c796283/src/index.tsx#L20">src/index.tsx:20</a></li>
</ul>
</aside>
</section>
Expand All @@ -152,7 +152,7 @@ <h3>id</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="NiceModalState.html">NiceModalState</a>.<a href="NiceModalState.html#id">id</a></p>
<ul>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/e086bec/src/index.tsx#L17">index.tsx:17</a></li>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/c796283/src/index.tsx#L17">src/index.tsx:17</a></li>
</ul>
</aside>
</section>
Expand All @@ -163,7 +163,7 @@ <h3>keep<wbr>Mounted</h3>
<aside class="tsd-sources">
<p>Overrides <a href="NiceModalState.html">NiceModalState</a>.<a href="NiceModalState.html#keepMounted">keepMounted</a></p>
<ul>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/e086bec/src/index.tsx#L55">index.tsx:55</a></li>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/c796283/src/index.tsx#L55">src/index.tsx:55</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -179,7 +179,7 @@ <h3>visible</h3>
<aside class="tsd-sources">
<p>Overrides <a href="NiceModalState.html">NiceModalState</a>.<a href="NiceModalState.html#visible">visible</a></p>
<ul>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/e086bec/src/index.tsx#L51">index.tsx:51</a></li>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/c796283/src/index.tsx#L51">src/index.tsx:51</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -201,7 +201,7 @@ <h3>hide</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/e086bec/src/index.tsx#L64">index.tsx:64</a></li>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/c796283/src/index.tsx#L64">src/index.tsx:64</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -223,7 +223,7 @@ <h3>reject</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/e086bec/src/index.tsx#L72">index.tsx:72</a></li>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/c796283/src/index.tsx#L72">src/index.tsx:72</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -251,7 +251,7 @@ <h3>remove</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/e086bec/src/index.tsx#L76">index.tsx:76</a></li>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/c796283/src/index.tsx#L76">src/index.tsx:76</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -273,7 +273,7 @@ <h3>resolve</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/e086bec/src/index.tsx#L68">index.tsx:68</a></li>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/c796283/src/index.tsx#L68">src/index.tsx:68</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -301,7 +301,7 @@ <h3>resolve<wbr>Hide</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/e086bec/src/index.tsx#L81">index.tsx:81</a></li>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/c796283/src/index.tsx#L81">src/index.tsx:81</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -329,7 +329,7 @@ <h3>show</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/e086bec/src/index.tsx#L60">index.tsx:60</a></li>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/c796283/src/index.tsx#L60">src/index.tsx:60</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
6 changes: 3 additions & 3 deletions docs/api/interfaces/NiceModalHocProps.html
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> default<wbr>Visible</
<div class="tsd-signature tsd-kind-icon">default<wbr>Visible<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/e086bec/src/index.tsx#L87">index.tsx:87</a></li>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/c796283/src/index.tsx#L87">src/index.tsx:87</a></li>
</ul>
</aside>
</section>
Expand All @@ -106,7 +106,7 @@ <h3>id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/e086bec/src/index.tsx#L86">index.tsx:86</a></li>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/c796283/src/index.tsx#L86">src/index.tsx:86</a></li>
</ul>
</aside>
</section>
Expand All @@ -116,7 +116,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> keep<wbr>Mounted</h3>
<div class="tsd-signature tsd-kind-icon">keep<wbr>Mounted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/e086bec/src/index.tsx#L88">index.tsx:88</a></li>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/c796283/src/index.tsx#L88">src/index.tsx:88</a></li>
</ul>
</aside>
</section>
Expand Down
10 changes: 5 additions & 5 deletions docs/api/interfaces/NiceModalState.html
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> args</h3>
<div class="tsd-signature tsd-kind-icon">args<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/e086bec/src/index.tsx#L18">index.tsx:18</a></li>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/c796283/src/index.tsx#L18">src/index.tsx:18</a></li>
</ul>
</aside>
</section>
Expand All @@ -113,7 +113,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> delay<wbr>Visible</h3
<div class="tsd-signature tsd-kind-icon">delay<wbr>Visible<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/e086bec/src/index.tsx#L20">index.tsx:20</a></li>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/c796283/src/index.tsx#L20">src/index.tsx:20</a></li>
</ul>
</aside>
</section>
Expand All @@ -123,7 +123,7 @@ <h3>id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/e086bec/src/index.tsx#L17">index.tsx:17</a></li>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/c796283/src/index.tsx#L17">src/index.tsx:17</a></li>
</ul>
</aside>
</section>
Expand All @@ -133,7 +133,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> keep<wbr>Mounted</h3>
<div class="tsd-signature tsd-kind-icon">keep<wbr>Mounted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/e086bec/src/index.tsx#L21">index.tsx:21</a></li>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/c796283/src/index.tsx#L21">src/index.tsx:21</a></li>
</ul>
</aside>
</section>
Expand All @@ -143,7 +143,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> visible</h3>
<div class="tsd-signature tsd-kind-icon">visible<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/e086bec/src/index.tsx#L19">index.tsx:19</a></li>
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/c796283/src/index.tsx#L19">src/index.tsx:19</a></li>
</ul>
</aside>
</section>
Expand Down
6 changes: 3 additions & 3 deletions docs/asset-manifest.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"files": {
"main.css": "./static/css/main.4fe4bbe5.chunk.css",
"main.js": "./static/js/main.896621f7.chunk.js",
"main.js.map": "./static/js/main.896621f7.chunk.js.map",
"main.js": "./static/js/main.6645edd4.chunk.js",
"main.js.map": "./static/js/main.6645edd4.chunk.js.map",
"runtime-main.js": "./static/js/runtime-main.3e6ba3ee.js",
"runtime-main.js.map": "./static/js/runtime-main.3e6ba3ee.js.map",
"static/css/2.9573e3cf.chunk.css": "./static/css/2.9573e3cf.chunk.css",
Expand All @@ -20,6 +20,6 @@
"static/css/2.9573e3cf.chunk.css",
"static/js/2.039ea410.chunk.js",
"static/css/main.4fe4bbe5.chunk.css",
"static/js/main.896621f7.chunk.js"
"static/js/main.6645edd4.chunk.js"
]
}
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!doctype html><html lang="en"><head><meta charset="utf-8"/><link rel="icon" href="./favicon.ico"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><link rel="stylesheet" href="./prism.css"><script src="./prism.js"></script><meta name="description" content="Examples for @ebay/nice-modal-react"/><link rel="apple-touch-icon" href="./logo192.png"/><link rel="manifest" href="./manifest.json"/><title>Nice Modal</title><link href="./static/css/2.9573e3cf.chunk.css" rel="stylesheet"><link href="./static/css/main.4fe4bbe5.chunk.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div><script>!function(e){function r(r){for(var n,a,i=r[0],c=r[1],l=r[2],p=0,s=[];p<i.length;p++)a=i[p],Object.prototype.hasOwnProperty.call(o,a)&&o[a]&&s.push(o[a][0]),o[a]=0;for(n in c)Object.prototype.hasOwnProperty.call(c,n)&&(e[n]=c[n]);for(f&&f(r);s.length;)s.shift()();return u.push.apply(u,l||[]),t()}function t(){for(var e,r=0;r<u.length;r++){for(var t=u[r],n=!0,i=1;i<t.length;i++){var c=t[i];0!==o[c]&&(n=!1)}n&&(u.splice(r--,1),e=a(a.s=t[0]))}return e}var n={},o={1:0},u=[];function a(r){if(n[r])return n[r].exports;var t=n[r]={i:r,l:!1,exports:{}};return e[r].call(t.exports,t,t.exports,a),t.l=!0,t.exports}a.e=function(e){var r=[],t=o[e];if(0!==t)if(t)r.push(t[2]);else{var n=new Promise((function(r,n){t=o[e]=[r,n]}));r.push(t[2]=n);var u,i=document.createElement("script");i.charset="utf-8",i.timeout=120,a.nc&&i.setAttribute("nonce",a.nc),i.src=function(e){return a.p+"static/js/"+({}[e]||e)+"."+{3:"016409b4"}[e]+".chunk.js"}(e);var c=new Error;u=function(r){i.onerror=i.onload=null,clearTimeout(l);var t=o[e];if(0!==t){if(t){var n=r&&("load"===r.type?"missing":r.type),u=r&&r.target&&r.target.src;c.message="Loading chunk "+e+" failed.\n("+n+": "+u+")",c.name="ChunkLoadError",c.type=n,c.request=u,t[1](c)}o[e]=void 0}};var l=setTimeout((function(){u({type:"timeout",target:i})}),12e4);i.onerror=i.onload=u,document.head.appendChild(i)}return Promise.all(r)},a.m=e,a.c=n,a.d=function(e,r,t){a.o(e,r)||Object.defineProperty(e,r,{enumerable:!0,get:t})},a.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},a.t=function(e,r){if(1&r&&(e=a(e)),8&r)return e;if(4&r&&"object"==typeof e&&e&&e.__esModule)return e;var t=Object.create(null);if(a.r(t),Object.defineProperty(t,"default",{enumerable:!0,value:e}),2&r&&"string"!=typeof e)for(var n in e)a.d(t,n,function(r){return e[r]}.bind(null,n));return t},a.n=function(e){var r=e&&e.__esModule?function(){return e.default}:function(){return e};return a.d(r,"a",r),r},a.o=function(e,r){return Object.prototype.hasOwnProperty.call(e,r)},a.p="./",a.oe=function(e){throw console.error(e),e};var i=this.webpackJsonpexample=this.webpackJsonpexample||[],c=i.push.bind(i);i.push=r,i=i.slice();for(var l=0;l<i.length;l++)r(i[l]);var f=c;t()}([])</script><script src="./static/js/2.039ea410.chunk.js"></script><script src="./static/js/main.896621f7.chunk.js"></script></body></html>
<!doctype html><html lang="en"><head><meta charset="utf-8"/><link rel="icon" href="./favicon.ico"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><link rel="stylesheet" href="./prism.css"><script src="./prism.js"></script><meta name="description" content="Examples for @ebay/nice-modal-react"/><link rel="apple-touch-icon" href="./logo192.png"/><link rel="manifest" href="./manifest.json"/><title>Nice Modal</title><link href="./static/css/2.9573e3cf.chunk.css" rel="stylesheet"><link href="./static/css/main.4fe4bbe5.chunk.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div><script>!function(e){function r(r){for(var n,a,i=r[0],c=r[1],l=r[2],p=0,s=[];p<i.length;p++)a=i[p],Object.prototype.hasOwnProperty.call(o,a)&&o[a]&&s.push(o[a][0]),o[a]=0;for(n in c)Object.prototype.hasOwnProperty.call(c,n)&&(e[n]=c[n]);for(f&&f(r);s.length;)s.shift()();return u.push.apply(u,l||[]),t()}function t(){for(var e,r=0;r<u.length;r++){for(var t=u[r],n=!0,i=1;i<t.length;i++){var c=t[i];0!==o[c]&&(n=!1)}n&&(u.splice(r--,1),e=a(a.s=t[0]))}return e}var n={},o={1:0},u=[];function a(r){if(n[r])return n[r].exports;var t=n[r]={i:r,l:!1,exports:{}};return e[r].call(t.exports,t,t.exports,a),t.l=!0,t.exports}a.e=function(e){var r=[],t=o[e];if(0!==t)if(t)r.push(t[2]);else{var n=new Promise((function(r,n){t=o[e]=[r,n]}));r.push(t[2]=n);var u,i=document.createElement("script");i.charset="utf-8",i.timeout=120,a.nc&&i.setAttribute("nonce",a.nc),i.src=function(e){return a.p+"static/js/"+({}[e]||e)+"."+{3:"016409b4"}[e]+".chunk.js"}(e);var c=new Error;u=function(r){i.onerror=i.onload=null,clearTimeout(l);var t=o[e];if(0!==t){if(t){var n=r&&("load"===r.type?"missing":r.type),u=r&&r.target&&r.target.src;c.message="Loading chunk "+e+" failed.\n("+n+": "+u+")",c.name="ChunkLoadError",c.type=n,c.request=u,t[1](c)}o[e]=void 0}};var l=setTimeout((function(){u({type:"timeout",target:i})}),12e4);i.onerror=i.onload=u,document.head.appendChild(i)}return Promise.all(r)},a.m=e,a.c=n,a.d=function(e,r,t){a.o(e,r)||Object.defineProperty(e,r,{enumerable:!0,get:t})},a.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},a.t=function(e,r){if(1&r&&(e=a(e)),8&r)return e;if(4&r&&"object"==typeof e&&e&&e.__esModule)return e;var t=Object.create(null);if(a.r(t),Object.defineProperty(t,"default",{enumerable:!0,value:e}),2&r&&"string"!=typeof e)for(var n in e)a.d(t,n,function(r){return e[r]}.bind(null,n));return t},a.n=function(e){var r=e&&e.__esModule?function(){return e.default}:function(){return e};return a.d(r,"a",r),r},a.o=function(e,r){return Object.prototype.hasOwnProperty.call(e,r)},a.p="./",a.oe=function(e){throw console.error(e),e};var i=this.webpackJsonpexample=this.webpackJsonpexample||[],c=i.push.bind(i);i.push=r,i=i.slice();for(var l=0;l<i.length;l++)r(i[l]);var f=c;t()}([])</script><script src="./static/js/2.039ea410.chunk.js"></script><script src="./static/js/main.6645edd4.chunk.js"></script></body></html>

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/static/js/main.6645edd4.chunk.js.map

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion docs/static/js/main.896621f7.chunk.js.map

This file was deleted.

0 comments on commit 162e8a4

Please sign in to comment.