README

Different Yii2 libraries for helping you to write less code and organize it better.

JsHelper is for simplified handling of common tasks with AJAX, modals, and display of messages from Javascript code. See the source code for understanding the purpose of this library.

Please note that this library is primarily for my own use and might be lacking proper documentation and overall explanation of things, even though I try to document everything in the way I code and write comments. Also be aware that features might change without proper notice even though I try to always make code backwards compatible.

Installation

The preferred way to install this extension is through composer.

First install Yii2, then:

composer require winternet-studio/yii2-libs

Usage

Once the extension is installed, simply use it in your code by :

<?php
use winternet\yii2\JsHelper;

echo JsHelper::initAjax();  //call within <body>
echo JsHelper::standardModal(['id' => 'StandardModal2']);
?>

Javascript code:

// To make an AJAX call:

appJS.ajax({
	url: '/your/url',
	type: 'POST',
	dataType: 'json',
	data: {var1: 'something', var2: 'something else'}
});

// To show a standard modal (either initAjax() or initModal() must have been called beforehand):

appJS.showModal('Here goes the <b>content</b> for your modal.');

// To show a modal, specifying more options:

appJS.showModal({
	title: 'Modal title goes here',
	html: 'Here goes the <b>content</b> for your modal.',
	customModalSelector: '#StandardModal2',
	openCallback: function(modalRef) {
		// code for before modal is being opened
		// NOTE: not reexecuted when a closed modal is shown again (set up standard Bootstrap modal events for that)
	},
	openedCallback: function(modalRef) {
		// code for after modal has been opened
		// NOTE: not reexecuted when a closed modal is shown again (set up standard Bootstrap modal events for that)
	},
	closeCallback: function(modalRef) {
		// code for before modal is being closed
		// NOTE: not reexecuted when a closed modal is shown again (set up standard Bootstrap modal events for that)
	},
	closedCallback: function(modalRef) {
		// code for after modal has been closed
		// NOTE: not reexecuted when a closed modal is shown again (set up standard Bootstrap modal events for that)
	}
});

See the source code to understand how and why to use these libraries.

winternet-studio / yii2-libs

Maintainers

Details

README

Installation

Usage