1

GitHub - williamtroup/Observe.js: ⚡ A lightweight, and easy-to-use, JavaScript l...

 8 months ago
source link: https://github.com/williamtroup/Observe.js
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
neoserver,ios ssh client

Observe.js

A lightweight, and easy-to-use, JavaScript library for observing any kind of JS object, or HTML DOM element, to detect changes!

v0.4.0

What features does Observe.js have?

  • Zero-dependencies and extremely lightweight!
  • JS Object and HTML DOM Element watching!
  • Cancellation and Pausing support!
  • Full API available via public functions.
  • Fully configurable!
  • Fully configurable per watch!
  • Custom triggers for actions (when changes are detected, on cancellation, etc).

What browsers are supported?

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

What are the most recent changes?

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

How do I get started?

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

1. Prerequisites:

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

<!DOCTYPE html>

2. Include Files:

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

3. DOM Element Binding / Object Watching:

<div data-observe-watch-options="{ '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-watch-options", and "watch()", click here.

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

4. Finishing Up:

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

How do I go about customizing Observe.js?

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

1. Public Functions:

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

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.


report

Recommend

About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK