SkillAgentSearch skills...

Observe.js

⚡ A lightweight JavaScript library that allows developers to keep track of changes to JavaScript objects and/or DOM elements.

Install / Use

/learn @williamtroup/Observe.js

README

<h1 align="center"> Observe.js

Tweet npm nuget license discussions Welcome coded by William Troup

</h1>
<p align="center">A lightweight JavaScript library that allows developers to keep track of changes to JavaScript objects and/or DOM elements.</p> <p align="center">v1.1.0</p>
<br /> <br> <h1>What features does Observe.js have?</h1>
  • 😏 Zero-dependencies and extremely lightweight!
  • 🦾 Written in TypeScript, allowing greater support for React, Angular, and other libraries!
  • 💻 Full API available via public functions.
  • 🎥 JS Object and HTML DOM Element watching!
  • 🔍 Watch for specific property changes!
  • 🚀 Cancel, Pause, and Resume support!
  • ☑️ Fully configurable!
  • ☑️ Fully configurable per watch!
  • ❓ Custom triggers for actions (when changes are detected, on cancellation, etc). <br />
<br /> <h1>What browsers are supported?</h1>

All modern browsers (such as Google Chrome, FireFox, and Opera) are fully supported. <br> <br>

<h1>What are the most recent changes?</h1>

To see a list of all the most recent changes, click here. <br> <br>

<h1>How do I install Observe.js?</h1>

You can install the library with npm into your local modules directory using the following command:

npm install jobserve.js
<br> <br> <h1>How do I get started?</h1>

To get started using Observe.js, do the following steps: <br> <br>

1. Prerequisites:

Make sure you include the "DOCTYPE html" tag at the top of your HTML, as follows:

<!DOCTYPE html>
<br>

2. Include Files:

<script src="dist/observe.js"></script>
<br>

3. DOM Element Binding / Object Watching:

<div data-observe-js="{ 'onChange': yourCustomJsFunction }">
    Your HTML.
</div>
<script> 
    var id = $observe.watch( yourObject, {
        onChange: yourCustomJsFunction
    } );
</script>

To see a list of all the available binding options you can use for "data-observe-js", and "watch()", click here.

To see a list of all the available custom triggers you can use for "data-observe-js", and "watch()", click here.

<br>

4. Finishing Up:

That's it! Nice and simple. Please refer to the code if you need more help (fully documented). <br> <br>

<h1>How do I go about customizing Observe.js?</h1>

To customize, and get more out of Observe.js, please read through the following documentation. <br> <br>

1. Public Functions:

To see a list of all the public functions available, click here. <br> <br>

2. Configuration:

Configuration options allow you to customize how Observe.js will function. You can set them as follows:

<script> 
  $observe.setConfiguration( {
      safeMode: false
  } );
</script>

To see a list of all the available configuration options you can use, click here.

View on GitHub
GitHub Stars36
CategoryDevelopment
Updated1y ago
Forks1

Languages

TypeScript

Security Score

80/100

Audited on Mar 26, 2025

No findings