Az mdui beépített egy könnyű JavaScript eszközfüggvény-tárral rendelkezik, amely a jQuery-hez hasonló API-val és láncolt hívási stílussal bír, de mérete mindössze a jQuery hatoda.
A könyvtárat a mdui.$ híváson keresztül érheti el, de célszerű a mdui.$-t egy rövid változóban tárolni a könnyebb használat érdekében, például:
var $ = mdui.$;A dokumentáció további részében a $ jelet használjuk a mdui.$ jelölésére.
$() | Ennek a módszernek több felhasználási módja is van: Átadhat egy CSS szelektort paraméterként, amely egy a találati elemeket tartalmazó JQ objektumot ad vissza. Ez a módszer a Átadhat DOM elemet, bármilyen tömböt, NodeList-et vagy JQ objektumot, és a megadott elemeket tartalmazó JQ objektumot kapja vissza. Átadhat HTML karakterláncot, amely a HTML alapján létrehozott DOM-ot tartalmazó JQ objektumot ad vissza. Átadhat egy függvényt, amely a DOM betöltődése után hívódik meg. |
$.extend() | Ha csak egy objektumot ad át, annak tulajdonságai beolvadnak a JQ objektumba, így új funkciókat adhat hozzá a JQ névteréhez. Ha két vagy több objektumot ad át, az összes objektum tulajdonságai az első objektumhoz adódnak hozzá, és a módszer az összevont objektumot adja vissza. |
$.fn.extend() | Módszerek kiterjesztése a JQ prototípus-láncán. |
$.param() | Szerializál egy objektumot vagy tömböt egy olyan karakterlánccá, amely használható URL paraméterként. Ha a megadott paraméter egy tömb, annak formátumának meg kell egyeznie a |
$.each() | Végigiterál egy tömbön vagy objektumon. Visszatérési értéke az első paraméter, vagyis az iterált tömb vagy objektum. A függvény első paramétere a tömbindex vagy az objektumkulcs; a második paraméter pedig a tömb vagy objektum megfelelő pozíciójában lévő érték. A visszahívási függvényben a |
$.merge() | Hozzáfűzi a második tömb elemeit az első tömbhöz, és az összevont tömböt adja vissza. |
$.unique() | Kiszűri az ismétlődő elemeket a tömbből. |
$.map() | Végigiterál egy tömbön vagy objektumon, és visszaad egy új tömböt, amely a függvény visszatérési értékeiből áll. A függvény első paramétere a tömb vagy objektum megfelelő pozíciójában lévő érték, a második paraméter pedig a tömbindex vagy az objektumkulcs. A függvény bármilyen értéket visszaadhat; ha a függvény tömböt ad vissza, az kibontásra kerül; ha |
$.contains() | Meghatározza, hogy a szülőcsomópont tartalmazza-e a gyermekcsomópontot; logikai értéket ad vissza. |
.is() | Ha a gyűjteményben legalább egy elem illeszkedik a paraméterre, A paraméter lehet CSS szelektor, DOM elem, DOM elemek tömbje, JQ objektum vagy visszahívási függvény. Ha a paraméter visszahívási függvény, annak első paramétere az index, a második paramétere az aktuális elem, és a |
.length | Visszaadja az aktuális gyűjteményben lévő elemek számát. |
.each() | Végigiterál az aktuális gyűjteményen, és minden elemre végrehajt egy függvényt. Ha a függvény A függvény első paramétere az elem indexe, a második pedig az aktuális elem. A függvényben a |
.map() | Végigiterál az aktuális gyűjteményen, és minden elemre végrehajt egy függvényt, majd visszaad egy új gyűjteményt, amely a függvény visszatérési értékeiből áll. A A függvény első paramétere az elem indexe, a második pedig az aktuális elem. A függvényben a |
.eq() | Csak a megadott indexű elemet tartalmazó gyűjteményt adja vissza. |
.first() | Visszaad egy gyűjteményt, amely csak az első elemet tartalmazza. |
.last() | Visszaad egy gyűjteményt, amely csak az utolsó elemet tartalmazza. |
.get() | Visszatér a megadott indexű elemmel. Ha nem ad meg paramétert, a gyűjtemény összes eleméből álló tömböt adja vissza. |
.index() | Ha nem ad meg paramétert, visszaadja a gyűjtemény első elemének indexét a testvérelemeihez képest. Ha egy CSS szelektort ad meg paraméterként, visszaadja a gyűjtemény első elemének indexét a szelektorral jelölt elemekhez képest. Ha egy DOM elemet ad meg, visszaadja annak az elemnek az indexét a gyűjteményben. Ha egy JQ objektumot ad meg, visszaadja annak első elemének indexét az aktuális gyűjteményben. |
.slice() | Visszaadja az aktuális gyűjtemény egy részhalmazát. Az első paraméter a részhalmaz kezdőpozíciója, a második pedig a vége; ha a másodikat elhagyja, a kezdőpozíciótól a végéig tartó összes elemet tartalmazza. |
.filter() | Kiszűri az aktuális gyűjteményből a megadott kifejezésnek megfelelő elemet. A paraméter lehet CSS szelektor, DOM elem, DOM elemek tömbje vagy visszahívási függvény. Ha a paraméter függvény, annak első paramétere az index, a második az aktuális elem, és a |
.not() | Kiszűri az aktuális gyűjteményből azokat az elemeket, amelyek NEM felelnek meg a megadott kifejezésnek. A paraméter lehet CSS szelektor, DOM elem, DOM elemek tömbje vagy visszahívási függvény. Ha a paraméter függvény, annak első paramétere az index, a második az aktuális elem, és a |
.hasClass() | Meghatározza, hogy a gyűjtemény első eleme rendelkezik-e a megadott CSS osztállyal. |
.addClass() | Hozzáadja a megadott CSS osztályokat a gyűjtemény összes eleméhez; több osztály szóközökkel elválasztva is megadható. Átadhat egy visszahívási függvényt is, amely visszaadja a CSS osztályneveket. A függvény első paramétere az index, a második az elem eredeti CSS osztályneve, a |
.removeClass() | Eltávolítja a CSS osztályokat a gyűjtemény elemeiről; több név szóközökkel választható el. Átadhat egy visszahívási függvényt is, amely visszaadja a CSS osztályneveket. A függvény első paramétere az index, a második az elem eredeti CSS osztályneve, a Ha nem ad meg paramétert, közvetlenül eltávolítja az elem |
.toggleClass() | Váltja (toggle) a CSS osztályokat az elemeken: ha van, törli, ha nincs, hozzáadja. Több név szóközökkel választható el. Átadhat egy visszahívási függvényt is, amely visszaadja a CSS osztályneveket. A függvény első paramétere az index, a második az elem eredeti CSS osztályneve, a |
.prop() | Lekéri a gyűjtemény első elemének attribútum-értékét. Be is állíthatja vele a gyűjtemény összes elemének attribútumát. A beállítandó érték lehet visszahívási függvény visszatérési értéke is. A függvény első paramétere az index, a második az eredeti attribútum-érték, a Ha az érték vagy a visszahívási függvény visszatérési értéke Több attribútumot is beállíthat egyszerre egy objektum átadásával. |
.removeProp() | Eltávolítja a megadott attribútumokat a gyűjtemény összes eleméről. |
.attr() | Lekéri a gyűjtemény első elemének tulajdonságát (property). Be is állíthatja vele a gyűjtemény összes elemének tulajdonságát. A beállítandó érték lehet visszahívási függvény visszatérési értéke is. A függvény első paramétere az index, a második az eredeti tulajdonság-érték, a Ha az érték vagy a visszahívási függvény visszatérési értéke Több tulajdonságot is beállíthat egyszerre egy objektum átadásával. |
.removeAttr() | Eltávolítja a megadott tulajdonságokat a gyűjtemény összes eleméről; több név szóközökkel választható el. |
.val() | Lekéri a gyűjtemény első elemének értékét. Ha az elem egy Be is állíthatja vele a gyűjtemény összes elemének értékét. Az érték lehet karakterlánc, szám, karakterláncok tömbje vagy visszahívási függvény. Ha visszahívási függvényt használ, az első paraméter az index, a második az elem eredeti értéke, a Ha az elem Ha az érték vagy a függvény visszatérési értéke |
.text() | Lekéri a gyűjtemény összes elemének szöveges tartalmát (beleértve azok utódait is). Be is állíthatja vele a gyűjtemény összes elemének szövegét. Az érték lehet karakterlánc, szám, logikai érték vagy visszahívási függvény. Visszahívási függvény esetén az első paraméter az index, a második az eredeti szöveges tartalom, a Ha az érték vagy a visszatérési érték |
.html() | Lekéri a gyűjtemény első elemének HTML tartalmát. Be is állíthatja vele a gyűjtemény összes elemének HTML tartalmát. Az érték lehet HTML karakterlánc, DOM elem vagy visszahívási függvény. Visszahívási függvény esetén az első paraméter az index, a második az eredeti HTML tartalom, a Ha az érték vagy a visszatérési érték |
$.data() | Adatokat tárol vagy olvas be egy megadott elemen. Adattároláskor, ha az érték Megjegyzés: Ez a módszer nem keresi az elemen lévő |
$.removeData() | Eltávolítja a megadott elemen tárolt adatokat. Több kulcsnév szóközökkel elválasztva vagy tömbként is megadható. Ha nincs megadva kulcsnév, az összes tárolt adat törlődik az elemről. |
.data() | Adatokat tárol vagy olvas be az aktuális gyűjtemény elemein. Adattároláskor, ha az érték Megjegyzés: Ez a módszer beolvassa az elemen lévő |
.removeData() | Eltávolítja az aktuális gyűjtemény elemein tárolt adatokat. Több kulcsnév szóközökkel elválasztva vagy tömbként is megadható. Ha nincs megadva kulcsnév, az összes tárolt adat törlődik. Megjegyzés: Ez a módszer csak a |
.css() | Lekéri a gyűjtemény első elemének CSS tulajdonságát. Be is állíthatja vele a gyűjtemény összes elemének CSS tulajdonságait. Az érték lehet karakterlánc, szám, vagy egy függvény, amely ezek valamelyikét adja vissza. Ha visszahívási függvényt használ, az első paraméter az index, a második az eredeti CSS érték, a Ha az érték vagy a függvény Ha az érték vagy a függvény számot ad vissza, a Több CSS tulajdonságot is beállíthat egyszerre kulcs-érték párokat tartalmazó objektummal. |
.width() | Lekéri a gyűjtemény első elemének szélességét (pixelben), a Be is állíthatja a gyűjtemény elemeinek szélességét (nem számítva a Az érték lehet mértékegységgel ellátott karakterlánc, szám, vagy visszahívási függvény. A visszahívási függvény első paramétere az index, a második az eredeti szélesség, a Numerikus érték esetén a Ha az érték |
.height() | Lekéri a gyűjtemény első elemének magasságát (pixelben), a Be is állíthatja a gyűjtemény elemeinek magasságát (nem számítva a Az érték lehet mértékegységgel ellátott karakterlánc, szám, vagy visszahívási függvény. A visszahívási függvény első paramétere az index, a második az eredeti magasság, a Numerikus érték esetén a Ha az érték |
.innerWidth() | Lekéri a gyűjtemény első elemének szélességét (pixelben), beleértve a Be is állíthatja a gyűjtemény elemeinek szélességét (belértve a Az érték lehet mértékegységgel ellátott karakterlánc, szám, vagy visszahívási függvény. A visszahívási függvény első paramétere az index, a második az eredeti szélesség, a Numerikus érték esetén a Ha az érték |
.innerHeight() | Lekéri a gyűjtemény első elemének magasságát (pixelben), beleértve a Be is állíthatja a gyűjtemény elemeinek magasságát (belértve a Az érték lehet mértékegységgel ellátott karakterlánc, szám, vagy visszahívási függvény. A visszahívási függvény első paramétere az index, a második az eredeti magasság, a Numerikus érték esetén a Ha az érték |
.outerWidth() | Lekéri a gyűjtemény első elemének szélességét (pixelben), beleértve a Be is állíthatja vele az összes elem szélességét (beleértve a Az első paraméter lehet mértékegységgel ellátott karakterlánc, szám, vagy visszahívási függvény. A visszahívási függvény első paramétere az elem indexe, a második pedig az eredeti szélesség; a Számérték esetén a Ha az érték |
.outerHeight() | Lekéri a gyűjtemény első elemének magasságát (pixelben), beleértve a Be is állíthatja vele az összes elem magasságát (beleértve a Az első paraméter lehet mértékegységgel ellátott karakterlánc, szám, vagy visszahívási függvény. A visszahívási függvény első paramétere az elem indexe, a második pedig az eredeti magasság; a Számérték esetén a Ha az érték |
.hide() | Elrejti a gyűjtemény minden elemét. |
.show() | Megjeleníti a gyűjtemény minden elemét. |
.toggle() | Váltja (toggle) az elemek láthatóságát. |
.offset() | Lekéri a gyűjtemény első elemének koordinátáit a Be is állíthatja az összes elem koordinátáit a A paraméter egy Függvény esetén az első paraméter az index, a második az eredeti koordináta, a Ha a |
.offsetParent() | Visszaadja a gyűjtemény első elemének pozicionálási szülőjét (az első olyan szülő, aminek a |
.position() | Lekéri a gyűjtemény első elemének eltolását (offset) a szülőeleméhez képest. |
.find() | Keresi a megadott szelektorral rendelkező utódcsomópontokat a gyűjtemény minden elemében. |
.children() | Lekéri az aktuális gyűjtemény elemeinek közvetlen gyermekelemeit. Átadhat egy CSS szelektort a gyermekelemek szűréséhez. |
.has() | Kiválogatja azokat az elemeket, amelyek tartalmazzák a megadott utódelemet. A paraméter lehet CSS szelektor vagy DOM elem. |
.parent() | Lekéri az aktuális gyűjtemény minden elemének közvetlen szülőit. CSS szelektorral szűrheti, hogy melyik szülőelemek kerüljenek visszaadásra. |
.parents() | Lekéri az aktuális gyűjtemény minden elemének összes ősét. CSS szelektorral szűrheti, hogy melyik ősök kerüljenek visszaadásra. |
.parentsUntil() | Lekéri minden elem minden szülőjét addig, amíg az első paraméternek megfelelő elemet el nem éri (azt nem tartalmazza). Az első paraméter lehet CSS szelektor, DOM elem vagy JQ objektum. A második paraméter (ha van) egy CSS szelektor, amellyel tovább szűrhető a végeredmény. Paraméter nélkül az összes ős visszakerül, ahogy a |
.prev() | Lekéri az aktuális gyűjtemény minden elemének közvetlen megelőző szomszédját. CSS szelektorral szűrheti a megelőző szomszédokat. |
.prevAll() | Lekéri az aktuális gyűjtemény minden eleme előtti összes szomszédos elemet. CSS szelektorral szűrheti az előző szomszédokat. |
.prevUntil() | Lekéri minden elem előtti szomszédait addig, amíg az első paraméternek megfelelő elemet el nem éri (azt nem tartalmazza). Az első paraméter lehet CSS szelektor, DOM elem vagy JQ objektum. A második paraméter egy CSS szelektor a találatok szűréséhez. |
.next() | Lekéri az aktuális gyűjtemény minden elemének közvetlen rákövetkező szomszédját. CSS szelektorral szűrheti a rákövetkező szomszédokat. |
.nextAll() | Lekéri az aktuális gyűjtemény minden eleme utáni összes szomszédos elemet. CSS szelektorral szűrheti az utánuk lévő szomszédokat. |
.nextUntil() | Lekéri minden elem utáni szomszédait addig, amíg az első paraméternek megfelelő elemet el nem éri (azt nem tartalmazza). Az első paraméter lehet CSS szelektor, DOM elem vagy JQ objektum. A második paraméter egy CSS szelektor a találatok szűréséhez. |
.closest() | Felfelé haladva a DOM-ban megkeresi az első elemet, amely illeszkedik a paraméterre. A paraméter lehet CSS szelektor, DOM elem vagy JQ objektum. |
.siblings() | Lekéri az aktuális gyűjtemény minden elemének összes testvérelemét. CSS szelektorral szűrheti a testvérelemeket. |
.add() | Új elemeket ad hozzá az aktuális gyűjteményhez. A paraméter lehet HTML karakterlánc, CSS szelektor, JQ objektum, DOM elem, DOM elemek tömbje vagy NodeList. |
.empty() | Eltávolítja az aktuális elemek összes gyermekcsomópontját. |
.remove() | Eltávolítja az aktuális gyűjtemény elemeit a DOM-ból. CSS szelektorral szűrheti az eltávolítandó elemeket. |
.prepend() | A megadott tartalom beszúrása az aktuális elemeken belülre, az elejére. A paraméter lehet HTML karakterlánc, DOM elem, DOM elemek tömbje vagy JQ objektum. Több paraméter is átadható. Átadhat egy függvényt is, amely beszúrandó tartalmat ad vissza; a paraméterei az index és az eredeti HTML, a A módszer az eredeti gyűjteményt adja vissza. |
.prependTo() | Az aktuális gyűjtemény elemeinek beszúrása a cél-elemek belsejének elejére. A paraméter lehet CSS szelektor, HTML karakterlánc, DOM elem, DOM elemek tömbje vagy JQ objektum. A módszer az eredeti gyűjteményt adja vissza. |
.append() | A megadott tartalom beszúrása az aktuális elemeken belülre, a végére. A paraméter lehet HTML karakterlánc, DOM elem, DOM elemek tömbje vagy JQ objektum. Több paraméter is átadható. Átadhat egy függvényt is; a paraméterei az index és az eredeti HTML, a A módszer az eredeti gyűjteményt adja vissza. |
.appendTo() | Az aktuális gyűjtemény elemeinek beszúrása a cél-elemek belsejének végére. A paraméter lehet CSS szelektor, HTML karakterlánc, DOM elem, DOM elemek tömbje vagy JQ objektum. A módszer az eredeti gyűjteményt adja vissza. |
.after() | A megadott tartalom beszúrása az aktuális elemek után, testvérelemként. A paraméter lehet HTML karakterlánc, DOM elem, DOM elemek tömbje vagy JQ objektum. Több paraméter is átadható. Átadhat egy függvényt is; a paraméterei az index és az eredeti HTML, a A módszer az eredeti gyűjteményt adja vissza. |
.insertAfter() | Az aktuális gyűjtemény elemeinek beszúrása a cél-elemek után, testvérelemként. Ha az elem már a DOM része, akkor áthelyezésre kerül. Több célpont esetén klónozva lesz. A célpont lehet HTML karakterlánc, CSS szelektor, DOM elem, tömb vagy JQ objektum. |
.before() | A megadott tartalom beszúrása az aktuális elemek elé, testvérelemként. A paraméter lehet HTML karakterlánc, DOM elem, DOM elemek tömbje vagy JQ objektum. Több paraméter is átadható. Átadhat egy függvényt is; a paraméterei az index és az eredeti HTML, a A módszer az eredeti gyűjteményt adja vissza. |
.insertBefore() | Az aktuális gyűjtemény elemeinek beszúrása a cél-elemek elé, testvérelemként. Ha az elem már a DOM része, akkor áthelyezésre kerül. Több célpont esetén klónozva lesz. A célpont lehet HTML karakterlánc, CSS szelektor, DOM elem, tömb vagy JQ objektum. |
.replaceWith() | Lecseréli az aktuális gyűjtemény elemeit a megadott elemekkel. A paraméter lehet HTML karakterlánc, DOM elem, DOM elemek tömbje vagy JQ objektum. Átadhat egy függvényt is; a paraméterei az index és az eredeti HTML, a Visszaadja az eredeti (lecserélt) gyűjteményt. |
.replaceAll() | Lecseréli a cél-elemeket az aktuális gyűjtemény elemeire. A paraméter lehet CSS szelektor, DOM elem, tömb vagy JQ objektum. Az új (behelyettesített) elemekből álló gyűjteményt adja vissza. |
.clone() | Mély-klónozással másolja a gyűjtemény összes elemét. A natív |
.serializeArray() | Az űrlap-elemek értékeit egy Ez a módszer használható egyedi űrlap-elemeken vagy a teljes |
.serialize() | Szerializálja az űrlap-elemek értékeit. |
.on() | Eseménykezelőt rendel az elemek megadott eseményeihez. Példák alább: |
.one() | Eseménykezelő rögzítése, amely csak egyszer fut le. A használata megegyezik az |
.off() | Leválasztja (unbind) az eseménykezelőket az elemekről. |
.trigger() | Kiváltja a megadott eseményt. |
$.ajaxSetup() | Globális konfiguráció beállítása az Ajax kérésekhez. A részletes paraméterlistát lásd az AJAX paraméterek alatt. |
$.ajax() | AJAX kérést küld, Promise-t ad vissza. A részletes paraméterlistát lásd az AJAX paraméterek alatt. |
.ajaxStart() | Globális AJAX események. Függvény végrehajtása az AJAX kérés indításakor. |
.ajaxSuccess() | Globális AJAX események. Sikeres AJAX kérés esetén lefutó függvény. |
.ajaxError() | Globális AJAX események. Hiba esetén lefutó függvény. |
.ajaxComplete() | Globális AJAX események. A kérés befejezésekor (sikertől függetlenül) lefutó függvény. |
| Paraméter neve | Típus | Alapértelmezett | Leírás |
|---|---|---|---|
url | String | Az aktuális oldal URL-je. | A kérés cél-URL címe. |
method | String | GET | Kérés típusa (HTTP method). Lehet: GET, POST, PUT, PATCH, HEAD, OPTIONS, DELETE |
data | any | '' | A szervernek küldendő adatok. |
processData | Boolean | true | Az adatokat lekérdező karakterlánccá (query string) alakítsa-e. |
async | Boolean | true | Aszinkron legyen-e a kérés. |
cache | Boolean | true | Használjon-e gyorsítótárat (csak GET és HEAD esetén). |
username | String | '' | HTTP autentikációhoz tartozó felhasználónév. |
password | String | '' | HTTP autentikációhoz tartozó jelszó. |
headers | Object | {} | A fejrészhez (Headers) adandó adatok; a A karakterlánc vagy |
xhrFields | Object | {} | Az XMLHttpRequest objektumon beállítandó adatok. |
statusCode | Object | {} | HTTP állapotkódok és hozzájuk rendelt függvények. 200-299 közötti kód vagy 304 esetén sikeres; a paraméterek megegyeznek a |
dataType | String | text | A szerver által visszaadott adat típusa. Lehet: text, json |
contentType | String | application/x-www-form-urlencoded | Tartalom kódolási típusa. false esetén nem állít be Content-Type-ot. |
timeout | Number | 0 | A kérés időtúllépése (milliszekundum). 0 esetén soha nem jár le. |
global | Boolean | true | Kiváltson-e globális AJAX eseményeket. |
beforeSend | Function | A kérés elküldése előtt hívódik meg; | |
success | Function | Sikeres kérés után hívódik meg. | |
error | Function | Hiba esetén hívódik meg. | |
complete | Function | A kérés befejezése után hívódik meg. |
Megjegyzés: Az alábbi módszerek csak az mdui keretrendszerben érhetők el; az önálló mdui.jq könyvtár nem tartalmazza őket.
.reflow() | Az aktuális elem kényszerített újrarajzolása. |
.transition() | Beállítja az elem Lehet mértékegységgel ellátott időérték vagy anélküli; utóbbi esetben az |
.transitionEnd() | Transitionend eseménykezelő hozzáadása az elemhez. A visszahívási függvény paramétere a |
.transform() | Beállítja az elem |
.transformOrigin() | Beállítja az elem |
.mutation() | Végrehajtja az elemen és utódain regisztrált inicializáló függvényeket. |
$.showOverlay() | Létrehozza és megjeleníti a maszkot (overlay); a maszk JQ objektumát adja vissza. Paraméterként megadható a |
$.hideOverlay() | Elrejti a maszkot. Többszöri |
$.lockScreen() | Zárolja az oldalt, megakadályozva a görgetést. |
$.unlockScreen() | Feloldja az oldal zárolását. Többszöri |
$.throttle() | Függvény fojtás (throttle). Paraméterként a végrehajtandó függvényt és a késleltetést (milliszekundum) várja. |
$.guid() | Globálisan egyedi azonosítót (ID) generál. Paraméterként átadott értékhez, ha nem létezik guid, újat generál; ha már létezik, a meglévőt adja vissza. |