@htmlguyllc/jpack

jPack

jPack is a library of components, objects, plugin wrappers, and utilities designed to make building custom websites simpler.

With jPack, you can easily upgrade your server-side rendered application to a pseudo-SPA using XHR requests for page-loads, get values from the querystring, store and interact with user/multi-tenant website data, and more.

What's Included

Four categories of functionality are provided in this library. Each one is detailed further in the documentation below.

Type	Namespace	Object/Function/Class
Components	components	navigation, XHRForm, FormFromURL
Objects	objects	request, Site, User
Plugin Wrappers	plugin_wrappers	None Yet.
Utilities	utilities	strings, data_types, dom, events

Installation

Standard Global

Download the latest release, unzip and move it in your website's public folder, then include it in your HTML. Don't forget to also include dependencies (listed in package.json).

<script href="/@htmlguyllc/jpack/dist/jpack.min.js">

<script>
//wait for the page to finish loading so we know jpack is ready
window.addEventListener('load', function() {
    
    //now you can take advantage of the jpack library
    var fname = jpack.utilities.strings.ucfirst('bob'); //Bob
    
    //or if you're feeling lazy, you can tie all jpack components to window for shorter use.
    jpack.goGlobal("jp");
    
    jp.strings.ucfirst('bob');
    
    //or if you're insanely lazy and want to cross your fingers that nothing conflicts, you can tie 
    // everything to window WITHOUT a namespace
    jpack.goGlobal();
    
    strings.ucfirst('bob');
};
</script>

With NPM or Yarn:

npm i @htmlguyllc/jpack;
//or
yarn add @htmlguyllc/jpack;

ES6 (Babel)

//a single component from it's own file
import {strings} from '@htmlguyllc/jpack/es/utilities/strings';
strings.ucfirst('bob');

//or a single component from the collection file
import {strings} from '@htmlguyllc/jpack/es/utilities';
strings.ucfirst('bob');

//or multiple components from the collection file
import {strings, dom} from '@htmlguyllc/jpack/es/utilities';
strings.ucfirst('bob');
dom.exists('a.my-link');

//or a namespaced object containing all components
import * as utilities from '@htmlguyllc/jpack/es/utilities';
utilities.strings.ucfirst('bob');

//or a namespaced object containing all
import {jpack} from '@htmlguyllc/jpack';
jpack.utilities.strings.ucfirst('bob');

CommonJS (Browserify)

var jpack = require('@htmlguyllc/jpack');

//now use it
jpack.utilities.strings.ucfirst('bob');

Dependencies

Name	Required by	Link
url-search-params-polyfill	request	https://www.npmjs.com/package/url-search-params-polyfill
axios	navigation	https://www.npmjs.com/package/axios
formdata-polyfill	XHRForm (and anything that extends it)	https://www.npmjs.com/package/formdata-polyfill

Documentation

- Components -

-Navigation

Grabs content from a URL and replaces it on the current page (along with browser history button handling, onload/unload handlers, and much more

Method/Property	Params (name:type)	Return	Notes
setPassthroughData	data:mixed	self	set data you want provided in the onload method for the next page
clearPassthroughData		self	must be called manually or the data will persist infinitely. you can set an onload callback to clear this every time
getPassthroughData		mixed	returns the data you set
setIncomingElement	el:string	self	a selector string for the element being retrieved from another page which contains the HTML you want put on the current page
getIncomingElement		string
setReplaceElement	el:string	self	a selector string for the element on the current page you want the new HTML to replace
getReplaceElement		string
load	url:string, callback:function/null, incoming_el:string/null, replace_el:string/null, push_state:bool	void	pulls content from the provided URL and puts it on the current page - also swaps out the page title, metas, and much more
loaderEnabled	n/a	bool	property to toggle the slow request loader on/off
setLoaderDelay	delay:int	self	set how long a request should take in ms before the loader displays
getLoaderDelay		self
getLoaderEl		Element
showLoader		self	shows the loader after the delay
hideLoader		self	clears the loader timeout and hides it
parseHTML	html:string, parent_el:string	object	parses HTML from the request to get key components like metas and the HTML to be displayed
getRouteFromMeta	html:string	string	retrieves the value of a meta tag named "current_route" to be passed in the onload event to help trigger page-specific JS
replacePageContent	html:string, url:string, incoming_el:string, replace_el:string, push_state:bool	self	replaces HTML on the page with the new content, updates metas, runs the unload and load callbacks and more
reload	callback:function	self	reloads the current page using .load()
fullReload		void	performs a full browser refresh of the current page
redirect	url:string	void	redirects the user to a new page (no XHR request)
setTitle	title:string	self	sets the page title
onLoad	callback:function	self	add an onload callback (runs 100ms after unload)
onUnload	callback:function	self	add an unload callback
onNavigationFailure	callback:function	self	add a callback when the load() request fails - the error message is provided in event.detail.error
triggerOnLoad	el:mixed, el_selector:string, route:string	self	triggers all onload callbacks
triggerUnload	el:mixed, el_selector:string, route:string	self	triggers all unload callbacks
triggerNavigationFailure	error:string	self	triggers the nav failure and provides an error message
initHistoryHandlers		self	sets event listeners to handle back/forward navigation in the user's browser

To use:

import {navigation} from '@htmlguyllc/jpack/es/components'; 

//handles browser back/forward buttons
navigation.initHistoryHandlers();

//a selector that contains the HTML you'd like to pull from the response
navigation.setIncomingElement('#main-content');

//a selector that will be replaced with the incoming HTML
navigation.setReplaceElement('#main-content');

//enables a loader to show if a request takes more than 300ms
//WARNING: No styling is provided at this time. It uses Bootstrap 4's progress-bar classes.
navigation.loaderEnabled = true;
navigation.setLoaderDelay(300);

//things to do when a page loads
navigation.onLoad(function(e){
    var params = e.detail; //get info from the event
    //if a current_route meta was set in the incoming HTML, it'll be provided to you here
    //you can use this to kick off your page-specific JS
    var route = params.route; 
    //the data you set prior to loading the page, if any
    var data = params.data; //or navigation.getPassthroughData()
    //the DOM element that was added to the page replacing the previous
    var el = params.el;
    
    //el_selector is the incoming selector that was used for this request
    //WARNING: If you change the incomingElement for a single request
    //and the replaceElement is not the same, future requests will not work
    //because the replaceElement no longer exists in the DOM
    //in this case you'll want to run navigation.setReplaceElement(params.el_selector);
    //now future requests will replace the new element on the page
    var el_selector = params.el_selector;
   
   //if gtag is set (google analytics), push a page view
   if( typeof gtag !== 'undefined' ) {
       gtag('config', 'GA_MEASUREMENT_ID', {
           page_path: request.getURIWithQueryString()
       });
   }
   
   //scroll to the top of the page
   window.scrollTo(0, 0);
   
   //.. do something...like init tooltip plugins
});

//things to do when leaving a page
navigation.onUnload(function(){
   //.. do something...like remove generic event handlers or destroy plugins 
});

//things to do when a page fails to load
navigation.onNavigationFailure(function(e){
    var error = e.detail.error;
    //.. do something...like show an error popup for the user or log the issue
});

//to prevent duplicate code, you can run your onload callbacks immediately
navigation.triggerOnLoad(dom.getElement('body'), 'body', navigation.getRouteFromMeta());

//now use the plugin to load pages
//if you're lazy, the fastest way to integrate is to just add data-href to all internal links 
//and then attach a handler like this:
import {events} from '@htmlguyllc/jpack/es/utilities';
events.onClick('[data-href]', function(){
   navigation.load(this.href); 
});

//set something that will be received onload of the next page
navigation.setPassthroughData({
    product_id:1
});

//you can use the load method at any time to load a new page 
// the second param is an optional callback that only runs for that page
navigation.load('/my-page', function(new_el, new_el_selector, pass_through_params){
    //my page is now loaded
    
    //new_el is the new element on the page
    //new_el_selector is the incomingSelector used for this request
    
    //pass_through_data is any data that was set on navigation prior to this request
    //so in this instance, it will be {product_id:1} (set above)
    
    //now clear that data so it's gone for the next page load
    navigation.clearPassthroughData();
});

//in some cases, you'll want to grab a different element from the URL
//this example grabs .popup-content from /my-popup and replaces .current-popup
navigation.load('/my-popup', function(new_el, el_sel, data){
   //now the new element is on the page
}, '.popup-content', '.current-popup');

-XHRForm

Submits a form using XHR

Method/Property	Params (name:type)	Return	Notes
constructor	form:Element,options:object	self
setXHRSubmit	enabled:bool	self	enable/disable the XHR submission of the form
setSubmitMethod	method:string	self	override the form and provide a method (GET, POST, PATCH)
getSubmitMethod		method:string
setSubmitURL	url:mixed	self	pass null to use the form's action, function to dynamically generate the URL (receives the form as a param), or string
getSubmitURL		url:string	returns whatever was set in the constructor or using setSubmitURL, not the final URL
attachSubmitHandler	form:mixed	self	attaches the event listener to on submit of the passed form
onSuccess	callback:function	self	adds an onSuccess callback (you can add as many as you'd like)
clearOnSuccessCallbacks		self
triggerOnSuccess	response:mixed, form:Element	self	runs all onSuccess callbacks and passes the server's response and the form element
onError	callback:function	self	adds an onError callback (you can add as many as you'd like)
clearOnErrorCallbacks		self
triggerOnError	error:string, response:mixed, form:Element	self	triggers all onError callbacks and passes the error string, server response, and form Element
submitForm	form:Element	self	gets URL and method, checks form validity using .validate(), gets values, submits, and kicks off callbacks
getFormValues	form:Element	self	returns data from the form to be submitted - override this if you want to manipulate it first
setValidateCallback	callback:function	is_valid:bool	pass a function to validate the form and return true if it's valid, false if it's not. False prevents form submission so you must display errors for the user within here. The default callback uses Bootstrap 4's "was-validated" class to show errors and HTML5's :invalid attribute to validate
validate	form:Element	bool	passes the form to the validate callback and returns the response

To use:

import {XHRForm} from '@htmlguyllc/jpack/es/components'; 

//shown with defaults
var remote_form = new XHRForm(document.getElementById('my-form'), {
        xhrSubmit: true, //wouldn't make a whole lotta sent to use this if this were false lol, but it's here for extending classes and incase you want to toggle it for whatever reason
        submitURL:null, //when null, the form's action will be used (if explicitly defined), otherwise it falls back to the URL the form was retrieved from
        submitMethod:null, //when null, the form's method will be used (if explicitly defined), otherwise it falls back to POST
        onError: function(error, response, form){ }, //although you can add more, you can only pass 1 to start with in the constructor
        onSuccess: function(response, form){ }, //although you can add more, you can only pass 1 to start with in the constructor
        //validate the form, display any errors and return false to block submission
        validateForm: function(form){
            //add .was-validated for bootstrap to show errors
            form.classList.add('was-validated');
    
            //if there are any :invalid elements, the form is not valid
            const is_valid = !form.querySelector(':invalid');
    
            //if it's valid, clear the validation indicators
            if( is_valid ) form.classList.remove('was-validated');
    
            return is_valid;
        }
});

//attach the submission handler
remote_form.attachSubmitHandler();

-FormFromURL

Allows you to pull a form from a URL and insert it into the current page very easily including optional XHR form submission!

Method/Property	Params (name:type)	Return	Notes
constructor	url:string, options:object	self
setURL	url:string	self	set the URL to pull the form from
getURL		url:string
setIncomingElementSelector	selector:string	self	set a selector for the form element or it's parent that is returned by the URL
getIncomingElementSelector		selector:string
setInsertIntoElement	element:mixed	self	set the element that the form should be inserted into
getInsertIntoElement		element:mixed
getForm		void	pulls the form from the URL and runs the insertForm method
insertForm	parsed_content:object, response:mixed, form:Element/null	el:Element	inserts the form into the parent element, attaches the submit handler, triggers onload, and returns the parent element
onload	callback:function	self	adds a callback function to be run when the form is loaded on the page
clearOnloadCallbacks		self	removes all onload callbacks
triggerOnload	form:Element	self	runs all onload callbacks and passes the form to them

There are several methods and properties inherited from XHRForm that are not listed here. Please see XHRForm above for those details

To use:

import {FormFromURL} from '@htmlguyllc/jpack/es/components'; 

//shown with defaults
var remote_form = new FormFromURL('/my-form', {
        incomingElementSelector: null, //when null, it assumes the entire response is the form's HTML
        insertIntoElement: null, //error on null, must provide this
        onload: function(form){ return this; }, //although you can add more, you can only pass 1 to start with in the constructor
        xhrSubmit: true, 
        submitURL:null, //when null, the form's action will be used (if explicitly defined), otherwise it falls back to the URL the form was retrieved from
        submitMethod:null, //when null, the form's method will be used (if explicitly defined), otherwise it falls back to POST
        onError: function(error, response, form){ }, //although you can add more, you can only pass 1 to start with in the constructor
        onSuccess: function(response, form){ }, //although you can add more, you can only pass 1 to start with in the constructor
        //validate the form, display any errors and return false to block submission
        validateForm: function(form){
            //add .was-validated for bootstrap to show errors
            form.classList.add('was-validated');
    
            //if there are any :invalid elements, the form is not valid
            const is_valid = !form.querySelector(':invalid');
    
            //if it's valid, clear the validation indicators
            if( is_valid ) form.classList.remove('was-validated');
    
            return is_valid;
        }
});

//grab the form and insert in into the "insertIntoElement"
remote_form.getForm();

Extending:

FormFromURL extends XHRForm and either can be extended as you need.

See examples/FormModalFromURL for an example

- Objects -

-Request

Provides a wrapper for window.location and query string access

Method/Property	Params (name:type)	Return	Notes
query	n/a	URLSearchParams	see https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams#Methods
isHttps		bool
getDomain		string
getDomainWithProtocol		string
getURI		string	also known as the path - does not include querystring
getURIWithQueryString		string	full URL after the domain
getFullURL		string
appendSlash	string:string	string	adds a slash (if there isn't already one) to the end of a string.

To use:

import {request} from '@htmlguyllc/jpack/es/objects'; 

//get product_id from the querystring
var product_id = request.query.get('product_id');

var current_full_url = request.getFullURL();

var full_blog_url = request.appendSlash(request.getDomainWithProtocol())+'blog'; //https://my-domain.com/blog

-Site

Designed for multi-tenant applications, this object stores a site's id, name, and config object.

Method/Property	Params (name:type)	Return	Notes
getId		string/int
setId	id:string/int	this
getName		string	this
setName	name:string	this
getConfig		object	this
setConfig	config:object	this	overwrites all config
getConfigItem		mixed	returns an individual item from config
setConfigItem	key:string,val:mixed	this	sets the value of an individual item in config
populate	data:object	this	sets provided values all at once (id,name,config)

Instantiation with current site data:

The easy way:

Create an object named $site with values from your server (prior to including jpack)

<script>
const $site = {
    id: <?php echo $site['id']; ?>,
    name: "<?php echo $site['name']; ?>",
    //$site['config'] is a key/val array of configuration options
    config: JSON.parse("<?php echo json_encode($site['config']); ?>"),
};
</script>

Then instantiate the Site class in your JS file somewhere

const cur_site = new Site($site);
cur_site.getId();

@see: /examples/CurrentSiteSingleton for a method of instantiating the current site once and using everywhere Note: Even though that creates a singleton which is available anywhere, it's still highly recommended that you pass that object to functions and methods where it is used (dependency injection)

The harder way:

Perform an XHR request to grab site details via a JSON API, then run the populate method on the site object.

import {Site} from '@htmlguyllc/jpack/es/objects';
 
//this example uses jQuery's shorthand AJAX call, you can use axios or any request you want
$.get('/my-site-info-endpoint.php', function(data){
    //don't forget error handling!
    const cur_site = new Site(JSON.parse(data));
});

Of course you can use this class for any site, not just the current one, but this is the intended usage.

-User

Designed for sites with user accounts/guest accounts. This class stores a user's details and allows for front-end permission checks.

Method/Property	Params	Return	Notes
constructor	data:object	self
getId		string/int
setId	id:string/int	this
getIsGuest		bool	if your site has users who don't login but still interact and have a user record (like guest checkout)
setIsGuest	is_guest:bool	this
setIsAdmin		bool	if your site has users who have ultimate permissions and you want to do something based on that
setIsGuest	is_admin:bool	this
getUsername		string
setUsername	username:string	this
getFname		string
setFname	fname:string	this
getLname		string
setLname	lname:string	this
getName		string	returns fname and lname concatenated with a space
getEmail		string
setEmail	email:string	this
getPhone		string
setPhone	phone:string	this
getPermissions		array
setPermissions	permissions:array	this
addPermission	permission:string/int	this
removePermission	permission:string/int	this
hasPermission	permission:string/int	bool
getAdditionalData		object	set any additional data about this user that doesn't fit the default getters and setters here (a better idea would be to extend this object with your custom properties/methods)
setAdditionalData	data:object	this
getDataItem	key:string	mixed	returns a single value from the additional data object/array
setDataItem	key:string, val:mixed	sets a single value in the additional data array/object
populate	data:object	this	sets provided values all at once (id, isGuest, isAdmin, etc)

Instantiation with current user data:

The easy way:

Create an object named $user with values from your server

<script>
const $user = {
    id: <?php echo $user['id']; ?>,
    fname: "<?php echo $user['fname']; ?>",
    //..
    permissions: JSON.parse("<?php echo json_encode($user['permissions']); ?>"),
    additionalData: JSON.parse("<?php echo json_encode([
        'user_type'=>$user['user_type'],
        //whatever else you might want to pass
    ]); ?>"),
    //..
};
</script>

Then instantiate the User class in your JS file somewhere

const cur_user = new User($user);
cur_user.getId();

@see: /examples/CurrentUserSingleton for a method of instantiating the current user once and using everywhere Note: Even though that creates a singleton which is available anywhere, it's still highly recommended that you pass that object to functions and methods where it is used (dependency injection)

The harder way:

Perform an XHR request to grab site details via a JSON API, then run the populate method on the site object.

import {User} from '@htmlguyllc/jpack/es/objects';
 
$.get('/my-user-info-endpoint.php', function(data){
    //don't forget error handling!
    const cur_user = new User(JSON.parse(data));
});

Of course you can use this class for any User not just the current one, but that's the intended usage.

- Plugin Wrappers -

None yet.

- Utilities -

-Strings

Common string manipulations

Method/Property	Params (name:type)	Return	Notes
ucfirst	string:string	string	capitalizes the first letter of a string like ucfirst in PHP
getter	string:string	string	creates a getter method name from a string
setter	string:string	string	creates a setter method name from a string

To Use:

import {strings} from '@htmlguyllc/jpack/es/utilities';

strings.ucfirst('bob'); //returns 'Bob'
strings.getter('name'); //returns 'getName';
strings.setter('name'); //returns 'setName';

-DOM

HTML DOM helpers

Method/Property	Params (name:type)	Return	Notes
getElement	el:mixed, error_on_none:bool, error_on_multiple:bool	Element/HTMLDocument/null	returns a native DOM element for whatever you provide (selector string, array of elements, single element, jQuery wrapped DOM element, etc)
getElements	el:mixed, error_on_none:bool	array	same as getElement, except it returns all matches
remove	el:mixed	this	removes elements from the DOM - uses .getElements()
replaceElWithHTML	el:mixed, html:string	Element	replaces an element in the DOM with HTML and returns a reference to the new Element
exists	el:mixed	bool	checks to see if it exists in the DOM
multipleExist	el:mixed	bool	checks to see if more than 1 instance exists in the DOM

To Use:

import {dom} from '@htmlguyllc/jpack/es/utilities';

//Dont do this. Most of these are dumb examples.
dom.getElement('.my-fav-button', true, true); //will throw an error if it doesn't find it, or if it finds more than 1
dom.getElements('.links', true); //will throw an error if none are found
dom.getElement('.my-button'); //returns the button, or null (if multiple, it returns the first)
dom.getElements('.links'); //returns an array of any matches for .links
dom.getElement($('a')); //returns the native DOM element for the link and removes the jQuery wrapper
dom.getElement(document.querySelectorAll('a')); //returns the first anchor

dom.exists('a'); //returns true if there is an anchor on the page
dom.multipleExist('a'); //returns true if more than 1 anchor on the page

-Type Checks

Check the data type of a value with more specificity than typeof or vanilla JS functions

Method/Property	Params (name:type)	Return	Notes
isDataObject	value:object, keys:array, require_all_keys:bool, block_other_keys:bool, throw_error:bool	bool	validates that an object contains data and not a dom element, array, null or anything else that would normally return true when you call typeof

To Use:

import {type_checks} from '@htmlguyllc/jpack/es/utilities';

var my_obj = {id:null, name:'John Doe', email:'[e-mail]'};

//make sure my_obj contains the keys: 'id', 'name', 'email'
//force all keys to exist
//block any keys that aren't in that list
//throw an error if the object fails any checks
type_checks.isDataObject(my_obj, ['id', 'name', 'email'], true, true, true);

-Events

Shorthand event handlers

Method/Property	Params (name:type)	Return	Notes
onClick	el:mixed, callback:function	array	prevents the browser's default so you can handle link clicks and form submissions with less code
offClick	el:mixed, callback:function	array	removes the handler you added using onClick
onSubmit	el:mixed, callback:function	array	same as .onClick() but for submit
offSubmit	el:mixed, callback:function	array	same as .offClick() but for submit
onChange	el:mixed, callback:function	array	adds an on change handler but does NOT preventDefault - mostly exists for consistency
offChange	el:mixed, callback:function	array	removes the handler you added using .onChange()
onEventPreventDefault	el:mixed, event:string, callback:function	array	attaches an event handler and prevents the default browser action
offEventPreventDefault	el:mixed, event:string, callback:function	array	removes the handler you attached with .onEventPreventDefault()
on	el:mixed, event:string, callback:function	array	attaches an event listener
off	el:mixed, event:string, callback:function	array	removes an event listener
trigger	el:mixed, event:string, event_options:mixed	array	triggers an event on an element/elements - uses .getElements()

To Use:

import {events} from '@htmlguyllc/jpack/es/utilities';

events.onClick('a.my-link', function(){
   //do something without the page redirecting to the href 
});

events.onSubmit('form.my-form', function(){
   //do something and submit the form using XHR 
});

//trigger submit on a form and pass an object as additional data in the event
events.trigger('.my-form', 'submit', {id:1});