jQuery.jQlipboard()

jQuery.jQlipboard( config )Returns: undefined

Description: Initializes jQlipboard; enables pasting.

Note: This function is only availible in the withPaste version of jQlipboard.

As of version w0.2, the "pasting" option is removed; pasting will always be on. If the "pasting" option is defined, it will be ignored as per any unpromped option.

Most browsers require permission to read the clipboard so the option "permissionPrompt" adjests when the prompt is is displayed. The possible parameters are "immediate", to prompt the user when the page loads; and "when needed", which displays the first time a past function is called.

The .paste() function has some extra functionality. This functionality is always utilized when using copy functions. To use this functionality without the need to rely on copy functions, the option "copyListener" enables listener that detects when the user manually copies something, and adjusts the .paste() function automatically. By default, "copyListener" is set to false.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
 
$.jQlipboard({

	/*
	 * Determines when the page will request permession to
	 * use the clipboard; on load or when needed
	 */
	"permissionPrompt": /* "immediate", "when needed" (default) */,

	/*
	 * Detects when you modify the clipboard on your own
	 * and adjusts the functions accordingly
	 */
	"copyListener": /* true, false (default) */
})