Update README.md
This commit is contained in:
parent
81cfaacbbd
commit
7fcdffce42
80
README.md
80
README.md
@ -1,2 +1,78 @@
|
|||||||
# FFNM
|
# FFNM (Front-End for the next master)
|
||||||
Front-End for the next master
|
|
||||||
|
Simple plugin to avoid writing Javascript in trivial tasks.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Spanish/Español
|
||||||
|
|
||||||
|
### Instalar
|
||||||
|
|
||||||
|
Añade a tu `<head>` la siguiente etiqueta.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<script defer src="https://cdn.jsdelivr.net/gh/tanrax/FFNM@v1.0.0/ffnm.min.js"></script>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Ejemplos de uso
|
||||||
|
|
||||||
|
#### Clic
|
||||||
|
|
||||||
|
##### Añadir la clase `show` al selector `#menu` cuando sea pulsado el botón.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<button i-click="class:add('show', '#menu')">abrir</button>
|
||||||
|
```
|
||||||
|
|
||||||
|
##### Quitar la clase `show` al selector `#menu` cuando sea pulsado el botón.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<button i-click="class:remove('show', '#menu')">cerrar</button>
|
||||||
|
```
|
||||||
|
|
||||||
|
##### Intercambiar la clase `show` al selector `#menu` cuando sea pulsado el botón.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<button i-click="class:toggle('show', '#menu')">ver</button>
|
||||||
|
```
|
||||||
|
#### Scroll
|
||||||
|
|
||||||
|
##### Añadir la clase `down` al `nav` cuando el usuario haga scroll hacia abajo.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<nav i-scroll-down="class:add('down', this)"></nav>
|
||||||
|
```
|
||||||
|
|
||||||
|
##### Quitar la clase `down` al `nav` cuando el usuario haga scroll hacia arriba.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<nav i-scroll-up="class:remove('down', this)"></nav>
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Hover
|
||||||
|
|
||||||
|
##### Añadir la clase `tadam` al selector `#menu` cuando el usuario haga `hover` sobre el botón.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<button i-hover="class:toggle('tadam', '#menu')">sorpresa!</button>
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Clases sin eventos
|
||||||
|
|
||||||
|
##### Añadir la clase `show` al selector `#menu`
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
class:add('show', '#menu')
|
||||||
|
```
|
||||||
|
|
||||||
|
##### Quitar la clase `show` al selector `#menu`
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
class:remove('show', '#menu')
|
||||||
|
```
|
||||||
|
|
||||||
|
##### Intercambiar la clase `show` al selector `#menu`
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
class:toggle('show', '#menu')
|
||||||
|
```
|
||||||
|
Loading…
Reference in New Issue
Block a user