chromex.ext.page-action — binaryage/chromex 0.8.1

clj

Use the chrome.pageAction API to put icons in the main Google Chrome toolbar, to the right of the address bar. Page actions represent actions that can be taken on the current page, but that aren't applicable to all pages. Page actions appear grayed out when inactive.

• available since Chrome 30
• https://developer.chrome.com/extensions/pageAction

api-table clj

gen-call clj

gen-wrap clj/s macro

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

get-popup clj/s macro

(get-popup details)

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

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

get-popup* cljs

(get-popup* config details)

get-title clj/s macro

(get-title details)

Gets the title of the page action.

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

get-title* cljs

(get-title* config details)

hide clj/s macro

(hide tab-id)

Hides the page action. Hidden page actions still appear in the Chrome toolbar, but are grayed out.

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

hide* cljs

(hide* config tab-id)

on-clicked* cljs

(on-clicked* config channel & args)

set-icon clj/s macro

(set-icon details)

Sets the icon for the page 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/pageAction#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/pageAction#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 page action's icon.

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

set-popup* cljs

(set-popup* config details)

set-title clj/s macro

(set-title details)

Sets the title of the page action. This is displayed in a tooltip over the page action.

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

set-title* cljs

(set-title* config details)

show clj/s macro

(show tab-id)

Shows the page action. The page action is shown whenever the tab is selected.

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

show* cljs

(show* config tab-id)

tap-all-events clj/s macro

(tap-all-events chan)

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

tap-on-clicked-events clj/s macro

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

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

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

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

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

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