@micheldescoteaux/gquery
v1.0.8
Published
like jQuery but for Mathieu Gévry
Downloads
3
Readme
gevryQuery™
Similar to jQuery but for Mathieu Gévry. Also known as goutQuery™
Installation
Option 1 - Download the file directly
Download the file
curl -LJO https://raw.githubusercontent.com/MouseEatsCat/mat_test/main/dist/gQuery.min.js
And then include it using
<script type="module" src="path/to/gQuery.min.js"></script>
And then in your script:
import gQuery from "path/to/gQuery.min.js";
Option 2 - Using a bundler
npm install --save @micheldescoteaux/gquery
And then in your script
import gQuery from "@micheldescoteaux/gquery";
Usage
The following returns a gQueryElementList
object
gQuery(".classname")
Examples
Add a class to and element when clicked
gQuery(".gallery-filter").on('click', function (e) {
this.addClass('clicked');
});
Reference
gQueryElementList
The gQueryElementList
object has the following methods available:
| Method | Parameters | Description |
| --------------- | --------------------------------------------------------------------------- | -------------------------------------------------------------------- |
| on()
| event: stringquery: EventCallback | stringcallback?: EventCallback | Add an event handler to all queried elements |
| each()
| callback: ItemCallback | Run a callback for all queried elements |
| forEach()
| callback: ItemCallback | alias of .each()
|
| first()
| void | Get the first gQueryElement
of all queried elements |
| last()
| void | Get the last gQueryElement
of all queried elements |
| find()
| query: string | Find descendant elements of all queried elements(matching the query) |
| addClass()
| className: string | Add class to all queried elements |
| removeClass()
| className: string | Remove class from all queried elements |
| toggleClass()
| className: string | Toggle class from all queried elements |
| prepend()
| html: gQueryElement | HTMLElement | string | Prepend element or HTML to all queried elements |
| append()
| html: gQueryElement | HTMLElement | string | Append element or HTML to all queried elements |
gQueryElement
The gQueryElement
object has the following methods available:
| Method | Parameters | Description |
| --------------- | --------------------------------------------------------------------------- | ------------------------------------------------------- |
| on()
| event: stringquery: EventCallback | stringcallback?: EventCallback | Add an event handler to element |
| find()
| query: string | Find descendant elements of element(matching the query) |
| addClass()
| className: string | Add class to element |
| removeClass()
| className: string | Remove class from element |
| toggleClass()
| className: string | Toggle class from element |
| prepend()
| html: gQueryElement | HTMLElement | string | Prepend element or HTML to element |
| append()
| html: gQueryElement | HTMLElement | string | Append element or HTML to element |
| data()
| dataAttr: stringvalue?: any | Get or set a data attribute |
| attr()
| attribute: stringvalue?: any | Get or set an attribute |
| val()
| value?: any | Get or set an element's value attribute |
| html()
| html?: any | Get or set an element's innerHtml |