Support/JavaScript frameworks

From Jmol
Jump to navigation Jump to search

Compatibility of Jmol applets with JavaScript frameworks

Please share here any experience with including Jmol applets in pages that use JavaScript frameworks or JavaScript libraries (both compatibilities and incompatibilities).

jQuery

resizable

The Jmol applet may be inserted in a div that receives jQuery resizable attribute. If the applet is given a 100% size, this makes an applet that may be resized at will by the user. (The container div must have explicit width and height.)

Uses

  • jQuery basic library, e.g. File icon.gifjquery.min.js
  • jQuery UI, e.g. File icon.gifjquery-ui.min.js and one of the associated themes like File icon.gifjquery-ui.css

draggable

The Jmol applet may be inserted in a div that receives jQuery draggable attribute. The user can thus move the applet around the page. Uses

  • jQuery basic library, e.g. File icon.gifjquery.min.js
  • jQuery UI, e.g. File icon.gifjquery-ui.min.js and one of the associated themes like File icon.gifjquery-ui.css

Jmol-JSO / JSmol

The new Jmol JavaScript Object library (JSmol) includes part of jQuery, so it should be fully compatible. If you need extra jQuery functionality, you should be careful to avoid conflicts between duplicate jQuery calls.


Prototype

...

Dojo Toolkit

...

Twirlymol, the 'inspiration' for JSmol lite (JSmolTM) uses Dojo.

MochiKit

Uses the $ shorthand global which may conflict with JSmol and JQuery

Used used as the primary JavaScript framework (alongside jQuery) in the eportfolio/CMS Mahara

In Mahara, jQuery is loaded first, $j set as the global, then MochiKit loaded taking ownership of $

YUI3

Uses the YUI global. Y is the shorthand local.

jQuery-YUI Rosetta Stone [1]