-
Notifications
You must be signed in to change notification settings - Fork 0
Version Compatibilities
jsonHTML still does not have an official release, as the API is still under construction. In order to least affect anyone using this code library during the developmental phase, I still maintain the ideal that any changes to the API should be minor, and not drastic. If you have used v0.5.X-X, and want to begin using v0.6+ be sure to read the Incompatibility Notice, If you would rather still use v0.5 to v0.6, I left the old documentation, and you should still be able to download the latest v0.6.X-X pre-release.
#####Incompatibilities between v0.5 - v0.6 and v0.7+:
For the sake of simplicity, and increasing the flexibility of jsonHTML it was determined that it is important to allow the user to append to any portion of the DOM. The user is now able to append to the body of the HTML directly by simply specifying 'body.' In order to do this properly, if you are to append to any div in the DOM, you have to specify it with the hash symbol '#.' Before you were able to simply type .appendTo('divID'), but now it is required to type .appendTo('#divID'), jQuery users should already be familiar with this, as it is a necessary method in order to use jQuery properly.
#####Incompatibilities between v0.7.x and v0.8.x+
In order to allow the user to gain lower access to the native jQuery functionality, I have decided to allow the .appendTo function to return a jQuery.Deferred() object. It should not affect any code already written in v0.7.x as nobody should have attempted to chain another function behind appendTo(), as anything chained behind .appendTo() would have done nothing on the DOM anyways. The v8 engine will now throw an error in the javaScript Console if the user has incorrectly done chaining in the previously explained way. The positive aspect to this, is that chaining is actually more useful, you can detect when the object is done being appended to the DOM by simply adding .done(). In this way you can add a function which you want to execute after the object has been appended to the DOM: "$jConstruct('div').appendTo('body').done(function() { console.log('now added to the DOM')});" Before this functionality was added, one would have to use the .addFunction() method in order to execute a function after the object has been rendered to the DOM, this functionality is basically useless, and quite possibly may become depricated.
#####key:
'*' = Implemented, but no Documentation yet.
'-' = Needs to be done.
'~' = currently being worked on, limited support.
'+' = Done, and documented.
-Possibly remove some syntactic sugar from v0.5, make it more low level, thus more functional, and more future proof.
~Implement more HTML objects.
*Added support for images! Cant believe I forgot this very important functionality to jsonHTML, you must know that this is a very alpha release, not tested, just implemented on the whim, you can only get it by doing a git clone of the repository, there is currently no release with this functionality. You define the source of the image with "src" and you define the text for the image as "text," just like you normally insert text for a div object.
*Make the ".appendTo" function utilize jQuery Deferreds, so the user can simply type ".appendTo('body').state.done(function() { console.log('done appending to the DOM')});" which brings the user down a tad lower level by not having to utilize ".addFunction," and allows for some asynchronious programming techniques to take place. View v0.8.x+
*Object DOM removal memory leak fix.
*micronDB is now implemented within jsonHTML. (Not included in the latest release yet, a new release will be made shortly.) This is revolutionary, and will require quite a lot of documentation... maybe a youTube tutorial. Hint: Mutate objects to any other type, and back. Objects that you add with jsonHTML can be found utilizing query commands:
arrdb.query({ //gets all jsonHTML objects of the type div.
where: {
type: 'div', //can define a property to search for.
},
}); //returns an array.
+Implement an easy way to handle events: on click, blur... etc...
+Can append a jsonHTML object to a parent jsonHTML object, by passing the object directly, or by passing the parent objects ID.
)
c (
o ) )
p (
y .---------------------.
r | _____ |___
i | .'`_,-._`'. __ \
g | / ( [ ] ) \ | ||
h | /.-""`( )`""-.\ | ||
t | ' <'```(.)```'> ' | _||
| <'```(.)```'> |/ _/
2 | <'``(.)``'> ./
0 | <``\_/``> |
1 | `'---'` |
6 \github.com/trillobite/
\_________________/ Keep it black, keep it free.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled "GNU
Free Documentation License".