Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@jvanbruegge
jvanbruegge committed Oct 25, 2017
1 parent e0525e5 commit ac61bd5
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 25 deletions.
6 changes: 2 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
# cyclejs-modal
An easy way to open custom modals in a cyclejs app

Documentation is hosted on [Github Pages](https://cyclejs-community.github.io/cyclejs-modal/index.html)

## Use it
`npm install --save cyclejs-modal`

## Caveats

`modalify` assumes that your DOM Driver is using the `DOM` property for sink and source.

## Example

You can find the examples in the [examples/](https://github.com/cyclejs-community/cyclejs-modal/tree/master/examples) folder
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/_modalify_.close.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> count</h3>
<div class="tsd-signature tsd-kind-icon">count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L18">modalify.ts:18</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L18">modalify.ts:18</a></li>
</ul>
</aside>
</section>
Expand All @@ -109,7 +109,7 @@ <h3>type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"close"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L17">modalify.ts:17</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L17">modalify.ts:17</a></li>
</ul>
</aside>
</section>
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/_modalify_.message.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ <h3>payload</h3>
<div class="tsd-signature tsd-kind-icon">payload<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L22">modalify.ts:22</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L22">modalify.ts:22</a></li>
</ul>
</aside>
</section>
Expand All @@ -109,7 +109,7 @@ <h3>type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"message"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L21">modalify.ts:21</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L21">modalify.ts:21</a></li>
</ul>
</aside>
</section>
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/_modalify_.open.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ <h3>component</h3>
<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>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L13">modalify.ts:13</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L13">modalify.ts:13</a></li>
</ul>
</aside>
</section>
Expand All @@ -109,7 +109,7 @@ <h3>type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"open"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L12">modalify.ts:12</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L12">modalify.ts:12</a></li>
</ul>
</aside>
</section>
Expand Down
12 changes: 6 additions & 6 deletions docs/interfaces/_modalify_.options.html
View file
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> DOMDriver<wbr>Key</h3
<div class="tsd-signature tsd-kind-icon">DOMDriver<wbr>Key<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/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L29">modalify.ts:29</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L29">modalify.ts:29</a></li>
</ul>
</aside>
</section>
Expand All @@ -113,7 +113,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> background</h3>
<div class="tsd-signature tsd-kind-icon">background<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/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L32">modalify.ts:32</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L32">modalify.ts:32</a></li>
</ul>
</aside>
</section>
Expand All @@ -123,7 +123,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> center</h3>
<div class="tsd-signature tsd-kind-icon">center<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/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L30">modalify.ts:30</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L30">modalify.ts:30</a></li>
</ul>
</aside>
</section>
Expand All @@ -133,7 +133,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> modal<wbr>Container<w
<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>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L31">modalify.ts:31</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L31">modalify.ts:31</a></li>
</ul>
</aside>
</section>
Expand All @@ -143,7 +143,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> name</h3>
<div class="tsd-signature tsd-kind-icon">name<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/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L28">modalify.ts:28</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L28">modalify.ts:28</a></li>
</ul>
</aside>
</section>
Expand All @@ -153,7 +153,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> z<wbr>Index</h3>
<div class="tsd-signature tsd-kind-icon">z<wbr>Index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L33">modalify.ts:33</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L33">modalify.ts:33</a></li>
</ul>
</aside>
</section>
Expand Down
18 changes: 9 additions & 9 deletions docs/modules/_modalify_.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ <h3>Component</h3>
<div class="tsd-signature tsd-kind-icon">Component<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L9">modalify.ts:9</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L9">modalify.ts:9</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
Expand Down Expand Up @@ -140,7 +140,7 @@ <h3>Modal<wbr>Action</h3>
<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>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L25">modalify.ts:25</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L25">modalify.ts:25</a></li>
</ul>
</aside>
</section>
Expand All @@ -150,7 +150,7 @@ <h3>Sinks</h3>
<div class="tsd-signature tsd-kind-icon">Sinks<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L7">modalify.ts:7</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L7">modalify.ts:7</a></li>
</ul>
</aside>
</section>
Expand All @@ -160,7 +160,7 @@ <h3>Sources</h3>
<div class="tsd-signature tsd-kind-icon">Sources<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L8">modalify.ts:8</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L8">modalify.ts:8</a></li>
</ul>
</aside>
</section>
Expand All @@ -177,7 +177,7 @@ <h3>add<wbr>Styles</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L183">modalify.ts:183</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L183">modalify.ts:183</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -208,7 +208,7 @@ <h3>centerHTML</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L120">modalify.ts:120</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L120">modalify.ts:120</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -231,7 +231,7 @@ <h3>display<wbr>Modals</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L142">modalify.ts:142</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L142">modalify.ts:142</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -260,7 +260,7 @@ <h3>modalify</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L36">modalify.ts:36</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L36">modalify.ts:36</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -306,7 +306,7 @@ <h3>wrap<wbr>Modals</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/469b273/src/modalify.ts#L160">modalify.ts:160</a></li>
<li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/e0525e5/src/modalify.ts#L160">modalify.ts:160</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down

0 comments on commit ac61bd5

Please sign in to comment.