Add a description for $.avatar() and remove TODOs @raghunayyar fixed

This commit is contained in:
kondou 2013-08-31 23:41:49 +02:00
parent 385de45ed9
commit 8de9e3d85e
2 changed files with 28 additions and 2 deletions

View File

@ -4,7 +4,6 @@ $(document).ready(function(){
$('#avatar .avatardiv').avatar(OC.currentUser, 128); $('#avatar .avatardiv').avatar(OC.currentUser, 128);
// User settings // User settings
$.each($('td.avatar .avatardiv'), function(i, data) { $.each($('td.avatar .avatardiv'), function(i, data) {
$(data).avatar($(data).parent().parent().data('uid'), 32); // TODO maybe a better way of getting the current name … may be fixed by new-user-mgmt $(data).avatar($(data).parent().parent().data('uid'), 32);
}); });
// TODO when creating a new user, he gets a previously used avatar may be fixed by new user-mgmt
}); });

View File

@ -5,6 +5,33 @@
* See the COPYING-README file. * See the COPYING-README file.
*/ */
/**
* This plugins inserts the right avatar for the user, depending on, whether
* he has a custom uploaded avatar, or not and show a placeholder with the
* first letter of the users displayname instead.
* For this it asks the core_avatar_get route, thus this plugin is fit very
* tightly fitted for owncloud. It may not work anywhere else.
*
* You may use this on any <div></div>
* Here I'm using <div class="avatardiv"></div> as an example.
*
* There are 3 ways to call this:
*
* 1. $('.avatardiv').avatar('jdoe', 128);
* This will make the div to jdoe's fitting avatar, with the size of 128px.
*
* 2. $('.avatardiv').avatar('jdoe');
* This will make the div to jdoe's fitting avatar. If the div aready has a
* height, it will be used for the avatars size. Otherwise this plugin will
* search for 'size' DOM data, to use it for avatar size. If neither are
* available it will default to 64px.
*
* 3. $('.avatardiv').avatar();
* This will search the DOM for 'user' data, to use as the username. If there
* is no username available it will default to a placeholder with the value of
* "x". The size will be determined the same way, as the second example did.
*/
(function ($) { (function ($) {
$.fn.avatar = function(user, size) { $.fn.avatar = function(user, size) {
if (typeof(size) === 'undefined') { if (typeof(size) === 'undefined') {