Skip to content

Commit

Permalink
Updated Plugin docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
gnat authored Feb 7, 2024
1 parent 7b6a3f3 commit 0f73cd5
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ Looking for [DOM Selectors](#selectors)?
Looking for stuff [we recommend doing in vanilla JS](#no-surreal)?
### 🧭 Legend
* 🔗 Chainable off `me()` and `any()`
* 🌐 Global convenience helper.
* 🌐 Global helper.
* ▶️ Runnable example.
* 🔌 Built-in Plugin
### 👁️ At a glance
Expand Down Expand Up @@ -265,6 +265,10 @@ Looking for stuff [we recommend doing in vanilla JS](#no-surreal)?
* Execute after the DOM is ready. Similar to jquery `ready()`
* Queues functions onto `window.onload`
* Why? So you don't overwrite `window.onload`, also predictable sequential loading!
* 🔌 `fadeOut`
* See below
* 🔌 `fadeIn`
* See below

### <a name="plugin-included"></a>🔌 Built-in Plugins

Expand Down Expand Up @@ -340,7 +344,7 @@ function pluginHello(e) {
e.hello = (name) => { return hello(e, name) }
}

$.plugins.push(pluginHello)
surreal.plugins.push(pluginHello)
```

You can now use it like: `me().hello("Internet")`
Expand Down

0 comments on commit 0f73cd5

Please sign in to comment.