chromex.ext.action — binaryage/chromex 0.6.4

clj

Use actions to put icons in the main Google Chrome toolbar, to the right of the address bar. Actions can be set to take action on all pages (default_state: enabled) or only the current page (default_state: disabled). If an action is default disabled, the action appears grayed out when inactive. In addition to its icon, an action can also have a tooltip, a badge, and a popup.

• available since Chrome master
• https://developer.chrome.com/extensions/action

api-table clj

disable clj/s macro

(disable)

(disable tab-id)

Disables the action for a tab.

|tab-id| - The id of the tab for which you want to modify the 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/action#method-disable.

disable* cljs

(disable* config tab-id)

enable clj/s macro

(enable)

(enable tab-id)

Enables the action for a tab. By default, actions are enabled.

|tab-id| - The id of the tab for which you want to modify the 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/action#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 action.

|details| - https://developer.chrome.com/extensions/action#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/action#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/action#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 action. If no tab is specified, the non-tab-specific badge text is returned.

|details| - https://developer.chrome.com/extensions/action#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/action#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/action#method-getBadgeText.

get-badge-text* cljs

(get-badge-text* config details)

get-popup clj/s macro

(get-popup details)

Gets the html document set as the popup for this action.

|details| - https://developer.chrome.com/extensions/action#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/action#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/action#method-getPopup.

get-popup* cljs

(get-popup* config details)

get-title clj/s macro

(get-title details)

Gets the title of the action.

|details| - https://developer.chrome.com/extensions/action#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/action#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/action#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/action#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/action#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 action. The badge is displayed on top of the icon.

|details| - https://developer.chrome.com/extensions/action#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/action#method-setBadgeText.

set-badge-text* cljs

(set-badge-text* config details)

set-icon clj/s macro

(set-icon details)

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

|details| - https://developer.chrome.com/extensions/action#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/action#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 on the action's icon.

|details| - https://developer.chrome.com/extensions/action#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/action#method-setPopup.

set-popup* cljs

(set-popup* config details)

set-title clj/s macro

(set-title details)

Sets the title of the action. This shows up in the tooltip.

|details| - https://developer.chrome.com/extensions/action#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/action#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.action namespace.

tap-on-clicked-events clj/s macro

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

Fired when an action icon is clicked. This event will not fire if the action has a popup.

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

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

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

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