andros/FFNM
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Andros Fenollosa 2020-07-05 10:44:00 +02:00 committed by GitHub
parent 21f73ea37f
commit 2952077c87
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 56 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
README.md
View File

@ -1,6 +1,6 @@
# FFNM (Front-End for the next master)
Simple plugin to avoid writing Javascript in trivial tasks.
Simple utility to avoid writing Javascript when working with classes.
## Documentation
@ -9,6 +9,60 @@ Simple plugin to avoid writing Javascript in trivial tasks.
---
## English
### Install
Add to your `<head>` the following tag.
```html
<script src="https://cdn.jsdelivr.net/gh/tanrax/FFNM@v1.0.0/ffnm.min.js"></script>
```
### Examples
#### Click
##### Add the class `show` to the `#nav` selector when the button is pressed.
```html
<button i-click="class:add('show', '#nav')">open</button>
```
##### Remove the `show` class from the `#nav` selector when the button is pressed.
```html
<button i-click="class:remove('show', '#nav')">close</button>
```
##### Switch the `show` class to the `#nav` selector when the button is pressed.
```html
<button i-click="class:toggle('show', '#nav')">view</button>
```
#### Classes without events
##### Add the class `show` to the `#nav` selector
```javascript
class:add('show', '#nav')
```
##### Remove the `show` class from the `#nav` selector
```javascript
class:remove('show', '#nav')
```
##### Switch the class `show` to the `#nav` selector
```javascript
class:toggle('show', '#nav')
```
---
## Spanish/Español
### Instalar
@ -60,6 +114,7 @@ class:remove('show', '#menu')
```javascript
class:toggle('show', '#menu')
```
---
## Development