mirror of
https://github.com/tenrok/maska.git
synced 2026-06-17 19:21:21 +03:00
docs: updated docs for v3
This commit is contained in:
@@ -0,0 +1,23 @@
|
||||
<object data="../maska.svg" type="image/svg+xml" style="max-width: 90%"></object>
|
||||
|
||||
---
|
||||
|
||||
**Maska** is a simple zero-dependency input mask library.
|
||||
|
||||
You can use it with vanilla javascript or with your favorite framework. Out of the box there is integration with Vue 2/3, Svelte and Alpine.js, but you can integrate it into any framework.
|
||||
|
||||
> ❤️ [Please support](https://boosty.to/beholdr) Maska future development!
|
||||
|
||||
## Main components
|
||||
|
||||
- `Mask` — class for mask processing (can be used to mask any string)
|
||||
- `MaskInput` — handles interaction with the `<input>` element
|
||||
- Directives `vMaska` for Vue, `xMaska` for Alpine.js and `maska` action for Svelte
|
||||
|
||||
## Live Demo
|
||||
|
||||
<iframe height="300" style="width: 100%;" scrolling="no" title="Maska demo" src="https://codepen.io/beholdr/embed/QWREEMY?default-tab=html%2Cresult&editable=true" frameborder="no" loading="lazy" allowtransparency="true" allowfullscreen="true">
|
||||
See the Pen <a href="https://codepen.io/beholdr/pen/QWREEMY">
|
||||
Maska demo</a> by Alexander (<a href="https://codepen.io/beholdr">@beholdr</a>)
|
||||
on <a href="https://codepen.io">CodePen</a>.
|
||||
</iframe>
|
||||
Reference in New Issue
Block a user