Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Kryazhev Alexey committed Jun 1, 2018
1 parent 668c447 commit 700e0f0
Show file tree
Hide file tree
Showing 8 changed files with 177 additions and 114 deletions.
6 changes: 3 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ vanilla javascript input mask
- optional input parts (greedy)
- custom definitions
- reusable groups
* [React](https://github.com/uNmAnNeR/imaskjs/tree/master/packages/react-imask)/[Angular](https://github.com/uNmAnNeR/imaskjs/tree/master/packages/angular-imask)/[Vue](https://github.com/uNmAnNeR/imaskjs/tree/master/packages/vue-imask) plugins
* [React](https://github.com/uNmAnNeR/imaskjs/tree/master/packages/react-imask)/[React Native<sup>beta</sup>](https://github.com/uNmAnNeR/imaskjs/tree/master/packages/react-native-imask)/[Angular](https://github.com/uNmAnNeR/imaskjs/tree/master/packages/angular-imask)/[Vue](https://github.com/uNmAnNeR/imaskjs/tree/master/packages/vue-imask) plugins

## Further Plans
* [React Native plugin](https://github.com/uNmAnNeR/imaskjs/issues/12)
* [Dynamic pattern groups](https://github.com/uNmAnNeR/imaskjs/issues/52)
* [DefinitelyTyped typings](https://github.com/uNmAnNeR/imaskjs/issues/17)
* [Improved API docs](https://github.com/uNmAnNeR/imaskjs/issues/9)
* [More unit tests](https://github.com/uNmAnNeR/imaskjs/issues/51)
* [React Native plugin (development frozen)](https://github.com/uNmAnNeR/imaskjs/issues/12)

## Install
`npm install imask` and `import IMask from 'imask';`
Expand All @@ -51,5 +51,5 @@ Supports all major browsers and IE11+ [need to support older?](https://unmanner.

[@Alexander Kiselev](https://github.com/MaaKut)

## Support development
## Support Development
[https://www.paypal.me/alexeykryazhev](https://www.paypal.me/alexeykryazhev)
269 changes: 166 additions & 103 deletions docs/api/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,18 @@ <h3 class='mb0 no-anchor'></h3>
.createMask
</a></li>

<li><a
href='#imaskmaskelement'
class='regular pre-open'>
.MaskElement
</a></li>

<li><a
href='#imaskhtmlmaskelement'
class='regular pre-open'>
.HTMLMaskElement
</a></li>

</ul>


Expand Down Expand Up @@ -170,16 +182,6 @@ <h3 class='mb0 no-anchor'></h3>
</li>


<li><a
href='#uielement'
class="">
UIElement

</a>

</li>


<li><a
href='#inputmask'
class=" toggle-sibling">
Expand Down Expand Up @@ -1667,6 +1669,16 @@ <h3 class='mb0 no-anchor'></h3>

</li>


<li><a
href='#maskelement'
class="">
MaskElement

</a>

</li>

</ul>
</div>
<div class='mt1 h6 quiet'>
Expand All @@ -1693,7 +1705,7 @@ <h3 class='fl m0' id='imask'>
<p>Applies mask on element.</p>


<div class='pre p1 fill-light mt0'>new IMask(el: (HTMLInput | <a href="#uielement">UIElement</a>), opts: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>): <a href="#inputmask">InputMask</a></div>
<div class='pre p1 fill-light mt0'>new IMask(el: (<a href="https://developer.mozilla.org/docs/Web/API/HTMLInputElement">HTMLInputElement</a> | <a href="https://developer.mozilla.org/docs/Web/API/HTMLTextAreaElement">HTMLTextAreaElement</a> | <a href="#maskelement">MaskElement</a>), opts: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>): <a href="#inputmask">InputMask</a></div>



Expand All @@ -1710,7 +1722,7 @@ <h3 class='fl m0' id='imask'>

<div class='space-bottom0'>
<div>
<span class='code bold'>el</span> <code class='quiet'>((HTMLInput | <a href="#uielement">UIElement</a>))</code>
<span class='code bold'>el</span> <code class='quiet'>((<a href="https://developer.mozilla.org/docs/Web/API/HTMLInputElement">HTMLInputElement</a> | <a href="https://developer.mozilla.org/docs/Web/API/HTMLTextAreaElement">HTMLTextAreaElement</a> | <a href="#maskelement">MaskElement</a>))</code>
Element to apply mask

</div>
Expand Down Expand Up @@ -2154,6 +2166,98 @@ <h3 class='fl m0' id='imask'>








</section>

</div>
</div>

<div class='border-bottom' id='imaskmaskelement'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>MaskElement</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>



<p><a href="#maskelement">MaskElement</a></p>


<div class='pre p1 fill-light mt0'>MaskElement</div>

























</section>

</div>
</div>

<div class='border-bottom' id='imaskhtmlmaskelement'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>HTMLMaskElement</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>



<p><a href="HTMLMaskElement">HTMLMaskElement</a></p>


<div class='pre p1 fill-light mt0'>HTMLMaskElement</div>























Expand Down Expand Up @@ -2642,94 +2746,6 @@ <h3 class='fl m0' id='selection'>



</section>




<section class='p2 mb2 clearfix bg-white minishadow'>


<div class='clearfix'>

<h3 class='fl m0' id='uielement'>
UIElement
</h3>


</div>


<p>Generic element API to use with mask</p>


<div class='pre p1 fill-light mt0'>UIElement</div>













<div class='py1 quiet mt1 prose-big'>Properties</div>
<div>

<div class='space-bottom0'>
<span class='code bold'>value</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>


</div>

<div class='space-bottom0'>
<span class='code bold'>selectionStart</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</code>


</div>

<div class='space-bottom0'>
<span class='code bold'>selectionEnd</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</code>


</div>

<div class='space-bottom0'>
<span class='code bold'>setSelectionRange</span> <code class='quiet'>(function (<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>, <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>): void)</code>


</div>

<div class='space-bottom0'>
<span class='code bold'>addEventListener</span> <code class='quiet'>(function (<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function">Function</a>): void)</code>


</div>

<div class='space-bottom0'>
<span class='code bold'>removeEventListener</span> <code class='quiet'>(function (<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function">Function</a>): void)</code>


</div>

</div>













</section>


Expand All @@ -2751,7 +2767,7 @@ <h3 class='fl m0' id='inputmask'>
<p>Listens to element events and controls changes between element and <a href="#masked">Masked</a></p>


<div class='pre p1 fill-light mt0'>new InputMask(el: <a href="#uielement">UIElement</a>, opts: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>)</div>
<div class='pre p1 fill-light mt0'>new InputMask(el: (<a href="#maskelement">MaskElement</a> | <a href="https://developer.mozilla.org/docs/Web/API/HTMLInputElement">HTMLInputElement</a> | <a href="https://developer.mozilla.org/docs/Web/API/HTMLTextAreaElement">HTMLTextAreaElement</a>), opts: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>)</div>



Expand All @@ -2768,7 +2784,7 @@ <h3 class='fl m0' id='inputmask'>

<div class='space-bottom0'>
<div>
<span class='code bold'>el</span> <code class='quiet'>(<a href="#uielement">UIElement</a>)</code>
<span class='code bold'>el</span> <code class='quiet'>((<a href="#maskelement">MaskElement</a> | <a href="https://developer.mozilla.org/docs/Web/API/HTMLInputElement">HTMLInputElement</a> | <a href="https://developer.mozilla.org/docs/Web/API/HTMLTextAreaElement">HTMLTextAreaElement</a>))</code>

</div>

Expand Down Expand Up @@ -2818,7 +2834,7 @@ <h3 class='fl m0' id='inputmask'>

<p>
Type:
<a href="#uielement">UIElement</a>
<a href="#maskelement">MaskElement</a>
</p>


Expand Down Expand Up @@ -14499,6 +14515,53 @@ <h3 class='fl m0' id='createmask'>








</section>




<section class='p2 mb2 clearfix bg-white minishadow'>


<div class='clearfix'>

<h3 class='fl m0' id='maskelement'>
MaskElement
</h3>


</div>


<p>Generic element API to use with mask</p>


<div class='pre p1 fill-light mt0'>new MaskElement()</div>























Expand Down
6 changes: 3 additions & 3 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ <h4>Features</h4>
<li>custom definitions</li>
<li>reusable groups</li>
</ul>
<li><a href="{{ site.repository }}/tree/master/packages/react-imask">React</a>/<a href="{{ site.repository }}/tree/master/packages/angular-imask">Angular</a>/<a href="{{ site.repository }}/tree/master/packages/vue-imask">Vue</a> plugins</li>
<li><a href="{{ site.repository }}/tree/master/packages/react-imask">React</a>/<a href="{{ site.repository }}/tree/master/packages/react-native-imask">React Native<sup>beta</sup></a>/<a href="{{ site.repository }}/tree/master/packages/angular-imask">Angular</a>/<a href="{{ site.repository }}/tree/master/packages/vue-imask">Vue</a> plugins</li>
</ul>
</div>

Expand Down Expand Up @@ -138,11 +138,10 @@ <h4>Features</h4>

<div class="appeal">
<p>I'm happy to present you one of the best JS libraries for the user input formatting. My goal is to create the most simple, convenient and yet extensible API, which I think I achieved as possible. Also with a great support of the community plugins for the major JS frameworks were created.</p>
<p>I've been working on my own enthusiasm for more than a year, not receiving any payment for my work. I've been thanked by about 5 people and even one man made a donation. This support is very important for me. Thank you.</p>
<p>I've been working on my own enthusiasm for more than a year, not receiving any payment for my work. Nevertheless one good man made a donation. This support is very important for me. Thank you.</p>
<p>Right now I would like to proceed with several new features, but I would like to get some feedback from the community. Please vote on issue which is important to you and you can always support and speed up the development process by making a donation - this way I will be sure that my work matters to someone.</p>
<h5>Further Plans</h5>
<ul>
<li><a href="{{ site.github.issues_url }}/12">React Native plugin</a></li>
<li>
<a href="{{ site.github.issues_url }}/52">Dynamic pattern groups</a>
<div class="toggle-panel">
Expand All @@ -163,6 +162,7 @@ <h5>Further Plans</h5>
<li><a href="{{ site.github.issues_url }}/17">DefinitelyTyped typings</a></li>
<li><a href="{{ site.github.issues_url }}/9">Improved API docs</a></li>
<li><a href="{{ site.github.issues_url }}/51">More unit tests</a></li>
<li><a href="{{ site.github.issues_url }}/12">React Native plugin (development frozen)</a></li>
</ul>
<p>In any case, I'm going to continue fixing bugs, updating the dependencies and maintaining the repo in general.</p>
</div>
Expand Down
Loading

0 comments on commit 700e0f0

Please sign in to comment.