Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/williamtroup/Observe.js
⚡ A lightweight JavaScript library that allows developers to keep track of changes to JavaScript objects and/or DOM elements.
https://github.com/williamtroup/Observe.js
angular html javascript object-changes observable observe observer react typescript vanilla-javascript watcher
Last synced: 3 days ago
JSON representation
⚡ A lightweight JavaScript library that allows developers to keep track of changes to JavaScript objects and/or DOM elements.
- Host: GitHub
- URL: https://github.com/williamtroup/Observe.js
- Owner: williamtroup
- License: mit
- Created: 2023-12-30T20:04:44.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-09-11T13:37:04.000Z (about 2 months ago)
- Last Synced: 2024-10-19T09:04:15.497Z (16 days ago)
- Topics: angular, html, javascript, object-changes, observable, observe, observer, react, typescript, vanilla-javascript, watcher
- Language: TypeScript
- Homepage: https://william-troup.com/observe-js
- Size: 509 KB
- Stars: 34
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- my-awesome-list - Observe.js
README
Observe.js
[](https://twitter.com/intent/tweet?text=Observe.js%2C%20a%20free%20JavaScript%observe%builder&url=https://github.com/williamtroup/Observe.js&hashtags=javascript,html,observe)
[](https://www.npmjs.com/package/jobserve.js)
[](https://www.nuget.org/packages/jObserve.js/)
[](https://github.com/williamtroup/Observe.js/blob/main/LICENSE.txt)
[](https://github.com/williamtroup/Observe.js/discussions)
[](https://www.william-troup.com/)
>
A lightweight JavaScript library that allows developers to keep track of changes to JavaScript objects and/or DOM elements.
> v1.1.0
What features does Observe.js have?
- 😏 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).
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](docs/CHANGE_LOG.md).
How do I install Observe.js?
You can install the library with npm into your local modules directory using the following command:
```markdown
npm install jobserve.js
```
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:
```markdown
```
### 2. Include Files:
```markdown
```
### 3. DOM Element Binding / Object Watching:
```markdown
Your HTML.
```
```markdown
var id = $observe.watch( yourObject, {
onChange: yourCustomJsFunction
} );
```
To see a list of all the available binding options you can use for "data-observe-js", and "watch()", click [here](docs/binding/options/OPTIONS.md).
To see a list of all the available custom triggers you can use for "data-observe-js", and "watch()", click [here](docs/binding/options/CUSTOM_TRIGGERS.md).
### 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](docs/PUBLIC_FUNCTIONS.md).
### 2. Configuration:
Configuration options allow you to customize how Observe.js will function. You can set them as follows:
```markdown
$observe.setConfiguration( {
safeMode: false
} );
```
To see a list of all the available configuration options you can use, click [here](docs/configuration/OPTIONS.md).