{"id":1517,"date":"2013-04-09T22:17:53","date_gmt":"2013-04-09T22:17:53","guid":{"rendered":"http:\/\/www.sitekickr.com\/blog\/?p=1517"},"modified":"2013-04-09T22:17:53","modified_gmt":"2013-04-09T22:17:53","slug":"add-favorites-javascrip","status":"publish","type":"post","link":"https:\/\/www.sitekickr.com\/blog\/add-favorites-javascrip\/","title":{"rendered":"Add to Favorites with JavaScript – the smarter way"},"content":{"rendered":"

Let's get it out of the way now. Yes, the "Add to Favorites" button is pretty old-school. The modern web user is savvy enough to be able to quickly identify and use their web browsers bookmarking feature without much struggle.<\/p>\n

But how many of us simply forget to bookmark a page or tool that we'd like to reference often? Having a small, intelligent, unobtrusive reminder to bookmark the page isn't going to force any visitors into a steaming fit of rage.<\/p>\n

This is an okay practice, if used sparingly and appropriately:<\/p>\n

    \n
  1. Don't place an "Add to Favorites" button on your home page, it should be reserved for deep links that the user might have difficulty locating again.<\/li>\n
  2. Only display the link if JavaScript is available (since JavaScript is required to add the favorite to the browser).<\/li>\n
  3. If a user has added the page to their bookmarks or favorites, don't display the link or icon to do so.<\/li>\n<\/ol>\n

    The first one is simple, just don't do it! The second one makes us think about implementation. For obvious reasons, the browser does not expose the current user's bookmarked pages in a request header or to JavaScript. So, how can we find out if the user has added our page as a favorite.<\/p>\n

    The short answer is, we can't. But, we can get close. By leveraging HTML 5 Storage<\/a>, we can track when a user has clicked the "Add to Favorites" button in a local storage variable. With each page load, we'll check this variable to see if it contains the current page. If it does, we do not display the "Add to Favorites" button.<\/p>\n

    You'll notice in the code below that the bookmark "button" is added via JavaScript to the end of the <h1> tag. You can, of course, append it wherever you like. The purpose of this line is to demonstrate item #2 in the list above. We don't want this button to display if JavaScript is not available.
    \n\t <\/p>\n

    jQuery Add Bookmark Code<\/h3>\n

    var page = location.href.replace(location.hostname, '').replace('http:\/\/', '').replace('https:\/\/', '');
    \n\tif (typeof Storage !== 'undefined') {
    \n\t  if (window.localStorage.getItem('bmarkAttempt')) {
    \n\t    if (window.localStorage.getItem('bmarkAttempt').indexOf(page) !== -1) {
    \n\t      return false;
    \n\t    }
    \n\t  }
    \n\t}<\/p>\n

    \t$('h1').append('<a id="bookmark"><img src="\/mybookmarkimage.jpg" alt="Add to Fav\\'s" \/><\/a>');<\/p>\n

    \t$("#bookmark").click(function() {
    \n\t  BookmarkApp.addBookmark(this);<\/p>\n

    \t  if (typeof Storage !== 'undefined') {
    \n\t    var bmarkAttempt = '';<\/p>\n

    \t    if (window.localStorage.getItem('bmarkAttempt')) {
    \n\t      bmarkAttempt = window.localStorage.getItem('bmarkAttempt');
    \n\t    }<\/p>\n

    \t    window.localStorage.setItem('bmarkAttempt', bmarkAttempt + ',' + page);
    \n\t  }<\/p>\n

    \t  $(this).remove();
    \n\t});<\/code><\/p>\n

     <\/p>\n

    You'll notice the use of a function called BookmarkApp. You can copy\/paste the code for this function from the creator's website at: http:\/\/eureka.ykyuen.info\/2011\/07\/21\/javascript-add-to-bookmark<\/a><\/p>\n

    However, you'll need to change one line of the code to function with IE.<\/p>\n

    Change:<\/p>\n

    var isMSIE = (-[1,]) ? false : true;<\/code><\/p>\n

    to<\/p>\n

    var isMSIE=(navigator.appName=="Microsoft Internet Explorer")?true:false;<\/code><\/p>\n","protected":false},"excerpt":{"rendered":"

    Let's get it out of the way now. Yes, the "Add to Favorites" button is pretty old-school. The modern web user is savvy enough to…<\/p>\n","protected":false},"author":1,"featured_media":1522,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"amp_status":""},"categories":[5],"tags":[248],"_links":{"self":[{"href":"https:\/\/www.sitekickr.com\/blog\/wp-json\/wp\/v2\/posts\/1517"}],"collection":[{"href":"https:\/\/www.sitekickr.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.sitekickr.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.sitekickr.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.sitekickr.com\/blog\/wp-json\/wp\/v2\/comments?post=1517"}],"version-history":[{"count":3,"href":"https:\/\/www.sitekickr.com\/blog\/wp-json\/wp\/v2\/posts\/1517\/revisions"}],"predecessor-version":[{"id":1523,"href":"https:\/\/www.sitekickr.com\/blog\/wp-json\/wp\/v2\/posts\/1517\/revisions\/1523"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.sitekickr.com\/blog\/wp-json\/wp\/v2\/media\/1522"}],"wp:attachment":[{"href":"https:\/\/www.sitekickr.com\/blog\/wp-json\/wp\/v2\/media?parent=1517"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.sitekickr.com\/blog\/wp-json\/wp\/v2\/categories?post=1517"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.sitekickr.com\/blog\/wp-json\/wp\/v2\/tags?post=1517"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}