Skip to content

Commit 70c1972

Browse files
committed
Update doc and demo
1 parent e086bec commit 70c1972

20 files changed

+6046
-7
lines changed

docs/api/assets/css/main.css

Lines changed: 2660 additions & 0 deletions
Large diffs are not rendered by default.

docs/api/assets/images/icons.png

9.39 KB
Loading
27.5 KB
Loading

docs/api/assets/images/widgets.png

480 Bytes
Loading
855 Bytes
Loading

docs/api/assets/js/main.js

Lines changed: 248 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/api/assets/js/search.js

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/api/index.html

Lines changed: 1660 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 247 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,247 @@
1+
<!doctype html>
2+
<html class="default no-js">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<title>NiceModalAction | @ebay/nice-modal-react</title>
7+
<meta name="description" content="Documentation for @ebay/nice-modal-react">
8+
<meta name="viewport" content="width=device-width, initial-scale=1">
9+
<link rel="stylesheet" href="../assets/css/main.css">
10+
<script async src="../assets/js/search.js" id="search-script"></script>
11+
</head>
12+
<body>
13+
<header>
14+
<div class="tsd-page-toolbar">
15+
<div class="container">
16+
<div class="table-wrap">
17+
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18+
<div class="field">
19+
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20+
<input id="tsd-search-field" type="text" />
21+
</div>
22+
<ul class="results">
23+
<li class="state loading">Preparing search index...</li>
24+
<li class="state failure">The search index is not available</li>
25+
</ul>
26+
<a href="../index.html" class="title">@ebay/nice-modal-react</a>
27+
</div>
28+
<div class="table-cell" id="tsd-widgets">
29+
<div id="tsd-filter">
30+
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31+
<div class="tsd-filter-group">
32+
<div class="tsd-select" id="tsd-filter-visibility">
33+
<span class="tsd-select-label">All</span>
34+
<ul class="tsd-select-list">
35+
<li data-value="public">Public</li>
36+
<li data-value="protected">Public/Protected</li>
37+
<li data-value="private" class="selected">All</li>
38+
</ul>
39+
</div>
40+
<input type="checkbox" id="tsd-filter-inherited" checked />
41+
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42+
<input type="checkbox" id="tsd-filter-externals" checked />
43+
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44+
</div>
45+
</div>
46+
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47+
</div>
48+
</div>
49+
</div>
50+
</div>
51+
<div class="tsd-page-title">
52+
<div class="container">
53+
<ul class="tsd-breadcrumb">
54+
<li>
55+
<a href="../index.html">@ebay/nice-modal-react</a>
56+
</li>
57+
<li>
58+
<a href="NiceModalAction.html">NiceModalAction</a>
59+
</li>
60+
</ul>
61+
<h1>Interface NiceModalAction</h1>
62+
</div>
63+
</div>
64+
</header>
65+
<div class="container container-main">
66+
<div class="row">
67+
<div class="col-8 col-content">
68+
<section class="tsd-panel tsd-hierarchy">
69+
<h3>Hierarchy</h3>
70+
<ul class="tsd-hierarchy">
71+
<li>
72+
<span class="target">NiceModalAction</span>
73+
</li>
74+
</ul>
75+
</section>
76+
<section class="tsd-panel-group tsd-index-group">
77+
<h2>Index</h2>
78+
<section class="tsd-panel tsd-index-panel">
79+
<div class="tsd-index-content">
80+
<section class="tsd-index-section ">
81+
<h3>Properties</h3>
82+
<ul class="tsd-index-list">
83+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="NiceModalAction.html#payload" class="tsd-kind-icon">payload</a></li>
84+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="NiceModalAction.html#type" class="tsd-kind-icon">type</a></li>
85+
</ul>
86+
</section>
87+
</div>
88+
</section>
89+
</section>
90+
<section class="tsd-panel-group tsd-member-group ">
91+
<h2>Properties</h2>
92+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
93+
<a name="payload" class="tsd-anchor"></a>
94+
<h3>payload</h3>
95+
<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>
96+
<aside class="tsd-sources">
97+
<ul>
98+
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/e086bec/src/index.tsx#L30">index.tsx:30</a></li>
99+
</ul>
100+
</aside>
101+
<div class="tsd-type-declaration">
102+
<h4>Type declaration</h4>
103+
<ul class="tsd-parameters">
104+
<li class="tsd-parameter">
105+
<h5><span class="tsd-flag ts-flagOptional">Optional</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></h5>
106+
</li>
107+
<li class="tsd-parameter">
108+
<h5><span class="tsd-flag ts-flagOptional">Optional</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></h5>
109+
</li>
110+
<li class="tsd-parameter">
111+
<h5>modal<wbr>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
112+
</li>
113+
</ul>
114+
</div>
115+
</section>
116+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
117+
<a name="type" class="tsd-anchor"></a>
118+
<h3>type</h3>
119+
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
120+
<aside class="tsd-sources">
121+
<ul>
122+
<li>Defined in <a href="https://github.com/eBay/nice-modal-react/blob/e086bec/src/index.tsx#L29">index.tsx:29</a></li>
123+
</ul>
124+
</aside>
125+
</section>
126+
</section>
127+
</div>
128+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
129+
<nav class="tsd-navigation primary">
130+
<ul>
131+
<li class=" ">
132+
<a href="../index.html">Exports</a>
133+
</li>
134+
</ul>
135+
</nav>
136+
<nav class="tsd-navigation secondary menu-sticky">
137+
<ul class="before-current">
138+
</ul>
139+
<ul class="current">
140+
<li class="current tsd-kind-interface">
141+
<a href="NiceModalAction.html" class="tsd-kind-icon">Nice<wbr>Modal<wbr>Action</a>
142+
<ul>
143+
<li class=" tsd-kind-property tsd-parent-kind-interface">
144+
<a href="NiceModalAction.html#payload" class="tsd-kind-icon">payload</a>
145+
</li>
146+
<li class=" tsd-kind-property tsd-parent-kind-interface">
147+
<a href="NiceModalAction.html#type" class="tsd-kind-icon">type</a>
148+
</li>
149+
</ul>
150+
</li>
151+
</ul>
152+
<ul class="after-current">
153+
<li class=" tsd-kind-interface tsd-has-type-parameter">
154+
<a href="NiceModalHandler.html" class="tsd-kind-icon">Nice<wbr>Modal<wbr>Handler</a>
155+
</li>
156+
<li class=" tsd-kind-interface">
157+
<a href="NiceModalHocProps.html" class="tsd-kind-icon">Nice<wbr>Modal<wbr>Hoc<wbr>Props</a>
158+
</li>
159+
<li class=" tsd-kind-interface">
160+
<a href="NiceModalState.html" class="tsd-kind-icon">Nice<wbr>Modal<wbr>State</a>
161+
</li>
162+
<li class=" tsd-kind-interface">
163+
<a href="NiceModalStore.html" class="tsd-kind-icon">Nice<wbr>Modal<wbr>Store</a>
164+
</li>
165+
<li class=" tsd-kind-variable">
166+
<a href="../index.html#ModalDef" class="tsd-kind-icon">Modal<wbr>Def</a>
167+
</li>
168+
<li class=" tsd-kind-variable">
169+
<a href="../index.html#ModalHolder" class="tsd-kind-icon">Modal<wbr>Holder</a>
170+
</li>
171+
<li class=" tsd-kind-variable">
172+
<a href="../index.html#NiceModalContext" class="tsd-kind-icon">Nice<wbr>Modal<wbr>Context</a>
173+
</li>
174+
<li class=" tsd-kind-variable">
175+
<a href="../index.html#Provider" class="tsd-kind-icon">Provider</a>
176+
</li>
177+
<li class=" tsd-kind-variable">
178+
<a href="../index.html#default" class="tsd-kind-icon">default</a>
179+
</li>
180+
<li class=" tsd-kind-function">
181+
<a href="../index.html#antdDrawer" class="tsd-kind-icon">antd<wbr>Drawer</a>
182+
</li>
183+
<li class=" tsd-kind-function">
184+
<a href="../index.html#antdDrawerV5" class="tsd-kind-icon">antd<wbr>Drawer<wbr>V5</a>
185+
</li>
186+
<li class=" tsd-kind-function">
187+
<a href="../index.html#antdModal" class="tsd-kind-icon">antd<wbr>Modal</a>
188+
</li>
189+
<li class=" tsd-kind-function">
190+
<a href="../index.html#antdModalV5" class="tsd-kind-icon">antd<wbr>Modal<wbr>V5</a>
191+
</li>
192+
<li class=" tsd-kind-function">
193+
<a href="../index.html#bootstrapDialog" class="tsd-kind-icon">bootstrap<wbr>Dialog</a>
194+
</li>
195+
<li class=" tsd-kind-function tsd-has-type-parameter">
196+
<a href="../index.html#create" class="tsd-kind-icon">create</a>
197+
</li>
198+
<li class=" tsd-kind-function tsd-has-type-parameter">
199+
<a href="../index.html#hide" class="tsd-kind-icon">hide</a>
200+
</li>
201+
<li class=" tsd-kind-function">
202+
<a href="../index.html#muiDialog" class="tsd-kind-icon">mui<wbr>Dialog</a>
203+
</li>
204+
<li class=" tsd-kind-function">
205+
<a href="../index.html#muiDialogV5" class="tsd-kind-icon">mui<wbr>Dialog<wbr>V5</a>
206+
</li>
207+
<li class=" tsd-kind-function">
208+
<a href="../index.html#reducer" class="tsd-kind-icon">reducer</a>
209+
</li>
210+
<li class=" tsd-kind-function tsd-has-type-parameter">
211+
<a href="../index.html#register" class="tsd-kind-icon">register</a>
212+
</li>
213+
<li class=" tsd-kind-function">
214+
<a href="../index.html#remove" class="tsd-kind-icon">remove</a>
215+
</li>
216+
<li class=" tsd-kind-function tsd-has-type-parameter">
217+
<a href="../index.html#show" class="tsd-kind-icon">show</a>
218+
</li>
219+
<li class=" tsd-kind-function">
220+
<a href="../index.html#unregister" class="tsd-kind-icon">unregister</a>
221+
</li>
222+
<li class=" tsd-kind-function tsd-has-type-parameter">
223+
<a href="../index.html#useModal" class="tsd-kind-icon">use<wbr>Modal</a>
224+
</li>
225+
</ul>
226+
</nav>
227+
</div>
228+
</div>
229+
</div>
230+
<footer class="with-border-bottom">
231+
<div class="container">
232+
<h2>Legend</h2>
233+
<div class="tsd-legend-group">
234+
<ul class="tsd-legend">
235+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
236+
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
237+
</ul>
238+
</div>
239+
</div>
240+
</footer>
241+
<div class="container tsd-generator">
242+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
243+
</div>
244+
<div class="overlay"></div>
245+
<script src="../assets/js/main.js"></script>
246+
</body>
247+
</html>

0 commit comments

Comments
 (0)