-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add project reactivity system. Add initial directives: if, hide and text. Add package build proecss. Add readme and license information. Add basic documentation.
- Loading branch information
0 parents
commit ed786f1
Showing
9 changed files
with
1,309 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
node_modules | ||
dist | ||
.cache | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2021 Campiglia Tech | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
# Kuva | ||
Aims to be a lighweight and straightforward reactive front-end library. | ||
Always basic and easy to read. | ||
|
||
# Installation | ||
```shell | ||
npm i kuva | ||
``` | ||
|
||
# Usage | ||
Your script | ||
```js | ||
import Kuva from 'kuva'; | ||
|
||
const app = Kuva({ | ||
name: 'John', | ||
lastName: 'Snow', | ||
fullName () { | ||
return `${this.name} ${this.lastName}` | ||
}, | ||
canShowFullName: false | ||
}) | ||
|
||
setTimeout(() => app.canShowFullName = true) | ||
|
||
``` | ||
Your HTML | ||
```html | ||
<p k-text="name"></p> | ||
<p k-text="lastName"></p> | ||
<p k-if="canShowFullName" k-text="fullName"></p> | ||
``` | ||
|
||
# Directives | ||
Every Kuva directive, starts with a k- prefix. | ||
The available ones are: | ||
|
||
* k-text: | ||
Shows the text of the received reference. | ||
* k-if: | ||
Shows the element if the received value is reference. | ||
* k-model: | ||
Adds two way data binding to an input with the received reference. | ||
|
||
# Docs | ||
Soon | ||
|
||
# Version | ||
0.0.1, not stable nor production ready, use with caution |
Oops, something went wrong.