Skip to content

Latest commit

 

History

History
149 lines (103 loc) · 3.13 KB

README.md

File metadata and controls

149 lines (103 loc) · 3.13 KB
Raw

Bower version

swfJQ Logo

jQuery plugin that easily manipulate SWF based on SWFObject.

This awesome class exist since 2009. Now on Bower.

Demo

http://webcaetano.github.io/swf-jquery/

Quickstart

Using Bower

bower install swf-jquery --save

Documentation

$(selector).flash()

Load flash swf on the select

$('#div1').flash('myFlash.swf');

Load with Parameters

Load a flash swf with parameters.

flashvars accept string,boolean,number

for object and array use JSON.stringify() and JSON.parse() on actionscript

$('#div1').flash({
	swf: 'myFlash.swf',
	height: 400, // stage Height
	width: 600, // stage width
	allowFullScreen: true,
	wmode: 'transparent', // background transparent
	flashvars: { // set Flash variables
		players: 2,
		computer: true,
		foo: 'bar',
		obj: JSON.stringify({name:'TheOddOne',arr:[1,2,3]})
	}
});

$.flash.available

Return a boolean value based on availability Flash plugin.

return $.flash.available; // returns true if Flash plugin available

$.flash.version

Return a object containing version information about the the user's Flash plugin.

return $.flash.version

/* returns {
	"original":"Shockwave Flash 17.0 r0",
	"array":["17","0","0"],
	"string":"17.0.0",
	"major":17,
	"minor":0,
	"release":0
}*/

$.flash.hasVersion()

A function which returns a boolean value of whether the user has installed the minimum specificed version of the Flash plugin.

return $.flash.hasVersion(9.1); // returns true if at least Flash 9.1 or greater is detected

$.flash.activeX

A boolean value of whether the browser uses Flash via activeX.

return $.flash.activeX; // returns true or false

$.flash.expressInstaller

A string that sets the filename of the express installer that will always be used.

$.flash.expressInstaller = 'myFlashPath/expressInstall.swf'; // changes the express installer

$.flash.encodeParams

A boolean value of whether the params will always be URI encoded.

$.flash.encodeParams = false; // default is true

$.flash()

A function which returns a standards-friendly jQuery'd flash object.

var useLater = $.flash.create({
	swf: 'myFlash.swf',
	height: 400,
	width: 600
});

$(document).ready(function(){
	$.('#putFlashHere').html(userLater);
});

Project to-do list.

  • Setup to bower.
  • Create Demo in githubPages
  • Finish documentation.
  • Create swfZepto

Authors

@jonathantneal

@webcaetano