Skip to content

Latest commit

 

History

History
82 lines (48 loc) · 1.59 KB

README.md

File metadata and controls

82 lines (48 loc) · 1.59 KB
Raw

favicon.js 1.3.0

Finds a website’s favicon URL, if any. Requires a context, like a browser extension, that allows cross-origin requests.

Example

<script type="text/javascript" src="favicon.js"></script>
<script type="text/javascript">
  var favicon = new Favicon;

  favicon.get('https://disconnect.me/', function(url) {
    jQuery('#favicon').attr('src', url);
        // favicon.js automagically loads jQuery.
  });
</script>
<img id="favicon" width="16" height="16" src="default.png" alt="A favicon.">

Constructor

Favicon([{string} alt])

A class for finding a website’s favicon URL, if any.

Parameter

alt A default favicon URL, absolute or relative.

Methods

{string} getAlt()

Fetches the default favicon URL.

Return value

An absolute or relative URL.

{Favicon} setAlt({string} alt)

Mungs the default favicon URL.

Parameter

alt An absolute or relative URL.

Return value

The favicon object.

{Favicon} get({string} url, {function(string)} callback)

Finds a favicon URL.

Parameters

url A website’s absolute URL or hostname.

callback A continuation, to execute when the method completes, that takes a favicon URL.

Return value

The favicon object.

Author

Brian Kennish

License

Copyright 2012, 2013 Disconnect, Inc.

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.

See also

jQuery