Skip to content

Add a plugin system #114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
botandrose wants to merge 6 commits into
base: main
Choose a base branch
from
+662 −80
Open

Add a plugin system #114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e6e0d13
proof-of-concept for a plugin system.
botandrose-machine Feb 15, 2025
6a9e552
get the rest of the node callbacks working with the plugin system.
botandrose-machine Feb 16, 2025
2dca99c
add beforeAttributeUpdated callback to plugin system.
botandrose-machine Feb 16, 2025
6a0350e
refactor callbacks to reduce array allocations.
botandrose-machine Feb 16, 2025
0956efd
satisfy tsc.
botandrose-machine Feb 16, 2025
c812975
correct docs.
botandrose-machine Feb 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,24 @@ Idiomorph.morph(document.documentElement, newPageSource, {head:{style: 'morph'}}

The `head` object also offers callbacks for configuring head merging specifics.

### Plugins

Idiomorph supports a plugin system that allows you to extend the functionality of the library, by adding an object of callbacks:

```js
Idiomorph.addPlugin({
name: 'logger',
beforeNodeAdded: function(node) {
console.log('Node added:', node);
},
beforeNodeRemoved: function(node) {
console.log('Node removed:', node);
},
});
```

These callbacks will be called in addition to any other callbacks that are registered in `Idiomorph.morph`. Multiple plugins can be added.

### Setting Defaults

All the behaviors specified above can be set to a different default by mutating the `Idiomorph.defaults` object, including
Expand Down
Loading