Skip to content

Commit ac61bd5

Browse files
jvanbrueggejvanbruegge
committed
Update documentation
1 parent e0525e5 commit ac61bd5

File tree

6 files changed

+23
-25
lines changed

6 files changed

+23
-25
lines changed

‎README.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
# cyclejs-modal
22
An easy way to open custom modals in a cyclejs app
33

4+
Documentation is hosted on [Github Pages](https://cyclejs-community.github.io/cyclejs-modal/index.html)
5+
46
## Use it
57
`npm install --save cyclejs-modal`
68

7-
## Caveats
8-
9-
`modalify` assumes that your DOM Driver is using the `DOM` property for sink and source.
10-
119
## Example
1210

1311
You can find the examples in the [examples/](https://github.com/cyclejs-community/cyclejs-modal/tree/master/examples) folder

‎docs/interfaces/_modalify_.close.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> count</h3>
9999
<div class="tsd-signature tsd-kind-icon">count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
100100
<aside class="tsd-sources">
101101
<ul>
102-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L18">modalify.ts:18</a></li>
102+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L18">modalify.ts:18</a></li>
103103
</ul>
104104
</aside>
105105
</section>
@@ -109,7 +109,7 @@ <h3>type</h3>
109109
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"close"</span></div>
110110
<aside class="tsd-sources">
111111
<ul>
112-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L17">modalify.ts:17</a></li>
112+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L17">modalify.ts:17</a></li>
113113
</ul>
114114
</aside>
115115
</section>

‎docs/interfaces/_modalify_.message.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ <h3>payload</h3>
9999
<div class="tsd-signature tsd-kind-icon">payload<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
100100
<aside class="tsd-sources">
101101
<ul>
102-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L22">modalify.ts:22</a></li>
102+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L22">modalify.ts:22</a></li>
103103
</ul>
104104
</aside>
105105
</section>
@@ -109,7 +109,7 @@ <h3>type</h3>
109109
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"message"</span></div>
110110
<aside class="tsd-sources">
111111
<ul>
112-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L21">modalify.ts:21</a></li>
112+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L21">modalify.ts:21</a></li>
113113
</ul>
114114
</aside>
115115
</section>

‎docs/interfaces/_modalify_.open.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ <h3>component</h3>
9999
<div class="tsd-signature tsd-kind-icon">component<span class="tsd-signature-symbol">:</span> <a href="../modules/_modalify_.html#component" class="tsd-signature-type">Component</a></div>
100100
<aside class="tsd-sources">
101101
<ul>
102-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L13">modalify.ts:13</a></li>
102+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L13">modalify.ts:13</a></li>
103103
</ul>
104104
</aside>
105105
</section>
@@ -109,7 +109,7 @@ <h3>type</h3>
109109
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"open"</span></div>
110110
<aside class="tsd-sources">
111111
<ul>
112-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L12">modalify.ts:12</a></li>
112+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L12">modalify.ts:12</a></li>
113113
</ul>
114114
</aside>
115115
</section>

‎docs/interfaces/_modalify_.options.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> DOMDriver<wbr>Key</h3
103103
<div class="tsd-signature tsd-kind-icon">DOMDriver<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
104104
<aside class="tsd-sources">
105105
<ul>
106-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L29">modalify.ts:29</a></li>
106+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L29">modalify.ts:29</a></li>
107107
</ul>
108108
</aside>
109109
</section>
@@ -113,7 +113,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> background</h3>
113113
<div class="tsd-signature tsd-kind-icon">background<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
114114
<aside class="tsd-sources">
115115
<ul>
116-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L32">modalify.ts:32</a></li>
116+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L32">modalify.ts:32</a></li>
117117
</ul>
118118
</aside>
119119
</section>
@@ -123,7 +123,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> center</h3>
123123
<div class="tsd-signature tsd-kind-icon">center<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
124124
<aside class="tsd-sources">
125125
<ul>
126-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L30">modalify.ts:30</a></li>
126+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L30">modalify.ts:30</a></li>
127127
</ul>
128128
</aside>
129129
</section>
@@ -133,7 +133,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> modal<wbr>Container<w
133133
<div class="tsd-signature tsd-kind-icon">modal<wbr>Container<wbr>Class<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
134134
<aside class="tsd-sources">
135135
<ul>
136-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L31">modalify.ts:31</a></li>
136+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L31">modalify.ts:31</a></li>
137137
</ul>
138138
</aside>
139139
</section>
@@ -143,7 +143,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> name</h3>
143143
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
144144
<aside class="tsd-sources">
145145
<ul>
146-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L28">modalify.ts:28</a></li>
146+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L28">modalify.ts:28</a></li>
147147
</ul>
148148
</aside>
149149
</section>
@@ -153,7 +153,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> z<wbr>Index</h3>
153153
<div class="tsd-signature tsd-kind-icon">z<wbr>Index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
154154
<aside class="tsd-sources">
155155
<ul>
156-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L33">modalify.ts:33</a></li>
156+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L33">modalify.ts:33</a></li>
157157
</ul>
158158
</aside>
159159
</section>

‎docs/modules/_modalify_.html‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ <h3>Component</h3>
109109
<div class="tsd-signature tsd-kind-icon">Component<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
110110
<aside class="tsd-sources">
111111
<ul>
112-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L9">modalify.ts:9</a></li>
112+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L9">modalify.ts:9</a></li>
113113
</ul>
114114
</aside>
115115
<div class="tsd-type-declaration">
@@ -140,7 +140,7 @@ <h3>Modal<wbr>Action</h3>
140140
<div class="tsd-signature tsd-kind-icon">Modal<wbr>Action<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_modalify_.open.html" class="tsd-signature-type">Open</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_modalify_.close.html" class="tsd-signature-type">Close</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_modalify_.message.html" class="tsd-signature-type">Message</a></div>
141141
<aside class="tsd-sources">
142142
<ul>
143-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L25">modalify.ts:25</a></li>
143+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L25">modalify.ts:25</a></li>
144144
</ul>
145145
</aside>
146146
</section>
@@ -150,7 +150,7 @@ <h3>Sinks</h3>
150150
<div class="tsd-signature tsd-kind-icon">Sinks<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
151151
<aside class="tsd-sources">
152152
<ul>
153-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L7">modalify.ts:7</a></li>
153+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L7">modalify.ts:7</a></li>
154154
</ul>
155155
</aside>
156156
</section>
@@ -160,7 +160,7 @@ <h3>Sources</h3>
160160
<div class="tsd-signature tsd-kind-icon">Sources<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
161161
<aside class="tsd-sources">
162162
<ul>
163-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L8">modalify.ts:8</a></li>
163+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L8">modalify.ts:8</a></li>
164164
</ul>
165165
</aside>
166166
</section>
@@ -177,7 +177,7 @@ <h3>add<wbr>Styles</h3>
177177
<li class="tsd-description">
178178
<aside class="tsd-sources">
179179
<ul>
180-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L183">modalify.ts:183</a></li>
180+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L183">modalify.ts:183</a></li>
181181
</ul>
182182
</aside>
183183
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -208,7 +208,7 @@ <h3>centerHTML</h3>
208208
<li class="tsd-description">
209209
<aside class="tsd-sources">
210210
<ul>
211-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L120">modalify.ts:120</a></li>
211+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L120">modalify.ts:120</a></li>
212212
</ul>
213213
</aside>
214214
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -231,7 +231,7 @@ <h3>display<wbr>Modals</h3>
231231
<li class="tsd-description">
232232
<aside class="tsd-sources">
233233
<ul>
234-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L142">modalify.ts:142</a></li>
234+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L142">modalify.ts:142</a></li>
235235
</ul>
236236
</aside>
237237
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -260,7 +260,7 @@ <h3>modalify</h3>
260260
<li class="tsd-description">
261261
<aside class="tsd-sources">
262262
<ul>
263-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L36">modalify.ts:36</a></li>
263+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L36">modalify.ts:36</a></li>
264264
</ul>
265265
</aside>
266266
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -306,7 +306,7 @@ <h3>wrap<wbr>Modals</h3>
306306
<li class="tsd-description">
307307
<aside class="tsd-sources">
308308
<ul>
309-
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L160">modalify.ts:160</a></li>
309+
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L160">modalify.ts:160</a></li>
310310
</ul>
311311
</aside>
312312
<h4 class="tsd-parameters-title">Parameters</h4>

0 commit comments

Comments
 (0)