1.0.8 • Published 2 years ago

@hqdaemon/qx v1.0.8

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

QX

Lightweight JavaScript library for manipulating with HTML Swap Slider & Swap'n'Loop'n'Fullscreen Gallery On Board

DeepScan grade

Initialization

Just add the script into your HTML

<script src="/path_to_script/qx.min.js"></script>

Or install via npm

npm install @hqdaemon/qx

Using

$(selector) - Like JQuery. Using querySelectorAll documentation

Methods

$.isTouch()

Return True if it is a Touch Device or False if not.

$.isTouch();

$.isDark()

Return True if the Client uses Dark Mode or False if not

$.isDark();

$.isPassive()

Return {passive:false} if Passive is available or False if not

$.isPassive();

on(eventNames, function)

Add Event Listeners to elements.

$(selector).on(eventNames,functionName);

off(eventNames, function)

Remove Event Listeners from elements.

$(selector).off(eventNames,functionName);

click(function)

Adding Click Or Tap Listener to elements depending on TouchScreen Device Detected.

$(selector).click(functionName);

addClass(classNames)

Adding the class name or list of class names to the element.

$(selector).addClass('className1 className2');

removeClass(classNames)

Remove the class name or list of class names from elements classList.

$(selector).removeClass('className1 className2');

hasClass(classNames)

Checking elements for class name available. Returning array of values if it needed.

$(selector).hasClass(className);

css({properties})

Set css to elements.

$(selector).css({prop:value});

getAttr(attributeName)

Get Attribute value of elements

$(selector).getAttr(attributeName);

setAttr(attributeName)

Set Attribute to elements

$(selector).setAttr(attributeName,value);

removeAttr(attributeName)

Remove Attribute from elements

$(selector).removeAttr(attributeName);

hover()

Add a behavior that switches the class "hover" when you hover the mouse or tap on the element.

$(selector).hover();

remove()

Removes an element from the DOM

$(selector).remove();

replace(HTML)

Replace element with new HTML

$(selector).replace(HTML);

append(HTML)

Append HTML before End Of Elements

$(selector).append(HTML);

prepend(HTML)

Insert HTML before the Beging Of Elements

$(selector).prepend(HTML);

after(HTML)

Insert HTML after the End Of Elements

$(selector).after(HTML);

val(value)

Get or Set value of inputs. Return typed values, e.g. (string) "1.23" becomes (float) 1.23, "true" > true and "false" > false

$(selector).val(newValue); // Set value
$(selector).val(); // Get value

hide()

Hide elements. Set display to "none".

$(selector).hide();

show()

Show elements. Set display to "block".

$(selector).show();

text()

Get or Set plain text of elements

$(selector).text(newText); // Set text
$(selector).text(); // Get text

html()

Get or Set HTML of elements

$(selector).html(newHtml); // Set HTML inner elements
$(selector).html(); // Get Outer HTML

fadeIn(duration, callback)

Fade-in element using the transparency.

$(selector).fadeIn(duration=600,callback=false);

fadeOut(duration, callback)

Fade-out element using the transparency.

$(selector).fadeOut(duration=600,callback=false);

width(value)

Get or Set Width of elements

$(selector).width(value=false);

height(value)

Get or Set Height of elements

$(selector).height(value=false);

each(function)

Executing function for each of elements

$(selector).each(functionName);

slideUp(duration, callback)

Slide Up Elements and fade-out

$(selector).slideUp(duration=500, callback=false);

slideDown(duration, callback)

Slide Down Elements and fade-in

$(selector).slideDown(duration=500, callback=false);

getBounds()

Return the size and position of elements

$(selector).getBounds();

parent()

Return the list of parent elements

$(selector).parent();

textWidth()

Return the list of elements width

$(selector).textWidth();

top()

Return Offset Top Of Elements

$(selector).top();

find(selector)

Find elements inside the list of selected elements

$(selector).find(selector);

focus()

Set focus at the first element of the list

$(selector).focus();

copy()

Return deep copies of elements

$(selector).copy();

Loop Sliders

Create a Adaptive Loop Slider that works on desktop and touch devices. To work correctly add the qx.min.css file. Return an array of created sliders.

<link rel="stylesheet" type="text/css" href="/path_to_css/qx.min.css" />
<div class="slider">
	<div class="slides">
		<div class="wrap">
			<div class="item">1</div>
			<div class="item">2</div>
			<div class="item">3</div>
			<div class="item">4</div>
		</div>
	</div>
	<div class="circles"></div>
	<div class="nav prev">◀</div>
	<div class="nav next">▶</div>
</div>
let sliders = $(".slider").slider();
let slider = sliders[0];
// Return [QX.slider]

slider.goTo()

Change the slider to the specified one. Accepts the slide number, "prev" or "next" values.

slider.goTo(index);

Gallery

Create Swap'n'Loop'n'Fullscreen Gallery

<link rel="stylesheet" type="text/css" href="/path_to_css/qx.min.css" />
<div class="gallery">
	<div data-img="path_to_img_1"></div>
	<div data-img="path_to_img_2"></div>
	<div data-img="path_to_img_3"></div>
	<!-- ... -->
	<div data-img="path_to_img_n"></div>
</div>
$(".gallery > div").gallery();

MIT License

Copyright (c) HQ • hqmode.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.