chromex.ext.browser-action — binaryage/chromex 0.6.5

clj

Use browser actions to put icons in the main Google Chrome toolbar, to the right of the address bar. In addition to its icon, a browser action can have a tooltip, a badge, and a popup.

• available since Chrome 27
• https://developer.chrome.com/extensions/browserAction

api-table clj

disable clj/s macro

(disable)

(disable tab-id)

Disables the browser action for a tab.

|tab-id| - The ID of the tab for which to modify the browser action.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [].

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/extensions/browserAction#method-disable.

disable* cljs

(disable* config tab-id)

enable clj/s macro

(enable)

(enable tab-id)

Enables the browser action for a tab. Defaults to enabled.

|tab-id| - The ID of the tab for which to modify the browser action.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [].

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/extensions/browserAction#method-enable.

enable* cljs

(enable* config tab-id)

gen-call clj

gen-wrap clj/s macro

(gen-wrap kind item-id config & args)

get-badge-background-color clj/s macro

(get-badge-background-color details)

Gets the background color of the browser action.

|details| - https://developer.chrome.com/extensions/browserAction#property-getBadgeBackgroundColor-details.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [result] where:

|result| - https://developer.chrome.com/extensions/browserAction#property-callback-result.

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/extensions/browserAction#method-getBadgeBackgroundColor.

get-badge-background-color* cljs

(get-badge-background-color* config details)

get-badge-text clj/s macro

(get-badge-text details)

Gets the badge text of the browser action. If no tab is specified, the non-tab-specific badge text is returned.

|details| - https://developer.chrome.com/extensions/browserAction#property-getBadgeText-details.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [result] where:

|result| - https://developer.chrome.com/extensions/browserAction#property-callback-result.

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/extensions/browserAction#method-getBadgeText.

get-badge-text* cljs

(get-badge-text* config details)

get-popup clj/s macro

(get-popup details)

Gets the HTML document that is set as the popup for this browser action.

|details| - https://developer.chrome.com/extensions/browserAction#property-getPopup-details.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [result] where:

|result| - https://developer.chrome.com/extensions/browserAction#property-callback-result.

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/extensions/browserAction#method-getPopup.

get-popup* cljs

(get-popup* config details)

get-title clj/s macro

(get-title details)

Gets the title of the browser action.

|details| - https://developer.chrome.com/extensions/browserAction#property-getTitle-details.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [result] where:

|result| - https://developer.chrome.com/extensions/browserAction#property-callback-result.

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/extensions/browserAction#method-getTitle.

get-title* cljs

(get-title* config details)

on-clicked* cljs

(on-clicked* config channel & args)

set-badge-background-color clj/s macro

(set-badge-background-color details)

Sets the background color for the badge.

|details| - https://developer.chrome.com/extensions/browserAction#property-setBadgeBackgroundColor-details.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [].

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/extensions/browserAction#method-setBadgeBackgroundColor.

set-badge-background-color* cljs

(set-badge-background-color* config details)

set-badge-text clj/s macro

(set-badge-text details)

Sets the badge text for the browser action. The badge is displayed on top of the icon.

|details| - https://developer.chrome.com/extensions/browserAction#property-setBadgeText-details.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [].

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/extensions/browserAction#method-setBadgeText.

set-badge-text* cljs

(set-badge-text* config details)

set-icon clj/s macro

(set-icon details)

Sets the icon for the browser action. The icon can be specified as the path to an image file, as the pixel data from a canvas element, or as a dictionary of one of those. Either the path or the imageData property must be specified.

|details| - https://developer.chrome.com/extensions/browserAction#property-setIcon-details.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [].

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/extensions/browserAction#method-setIcon.

set-icon* cljs

(set-icon* config details)

set-popup clj/s macro

(set-popup details)

Sets the HTML document to be opened as a popup when the user clicks the browser action icon.

|details| - https://developer.chrome.com/extensions/browserAction#property-setPopup-details.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [].

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/extensions/browserAction#method-setPopup.

set-popup* cljs

(set-popup* config details)

set-title clj/s macro

(set-title details)

Sets the title of the browser action. This title appears in the tooltip.

|details| - https://developer.chrome.com/extensions/browserAction#property-setTitle-details.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [].

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/extensions/browserAction#method-setTitle.

set-title* cljs

(set-title* config details)

tap-all-events clj/s macro

(tap-all-events chan)

Taps all valid non-deprecated events in chromex.ext.browser-action namespace.

tap-on-clicked-events clj/s macro

(tap-on-clicked-events channel & args)

Fired when a browser action icon is clicked. Does not fire if the browser action has a popup.

Events will be put on the |channel| with signature [::on-clicked [tab]] where:

|tab| - https://developer.chrome.com/extensions/browserAction#property-onClicked-tab.

Note: |args| will be passed as additional parameters into Chrome event's .addListener call.

https://developer.chrome.com/extensions/browserAction#event-onClicked.