@owowed/oxi
v1.1.1
Published
Userscript library
Downloads
9
Readme
Getting Started
To start using the oxi package, you need to include it in your userscript header.
The release build of the package is available in the dist
branch, which is updated automatically each time a new release is published.
To include this package, simply add the following lines to your userscript header:
// ==UserScript==
// ...
// @require https://github.com/owowed/oxi/raw/dist/oxi.umd.js
// ...
// ==/UserScript==
Usage
All methods are organized within oxi
namespace. Here is an example on how to use one of the oxi
methods:
const element = await oxi.waitForElement("div.hello-world");
const observer = oxi.makeMutationObserver(
{ target: element },
({ records }) => console.log("Mutation detected: ", records));
Docs
At the moment, documentation about these methods are available inside the source code in src
as JSDoc comments.
For upcoming release tag of this package, see the package
branch.
Contributing
If you have found a bug or a mistake on our project, please report it by submitting an issue!
If you have any ideas or suggestions for improvements, feel free to submit an issue!
If you want to contribute directly to our project, feel free fork this repository and submit a pull request! But before doing that, please read our Contributor Guidelines & Documentation.
For commit message, we follow very similiar style to Angular's Commit Message Format.
License
This project is licensed under GNU LGPL-3.0, a free and open-source license. For more information, please see the license file.