1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
<div id="pageData-title" class="pageData">Page Actions</div>
<!-- BEGIN AUTHORED CONTENT -->
<p>Page actions are a simple way to represent actions that can be taken on a page ("Email this page", "Share with Facebook", etc).</p>
<p>
Page actions are displayed as icons on the right side of the OmniBox.
The RSS icon in the following screenshot
represents a page action
that lets you subscribe to
the RSS feed for the current page.
</p>
<img src="images/page-action.png"
width="361" height="79" />
<h2 id="manifest">Manifest</h2>
<p>Developers can declare page actions in the manifest using the following syntax:</p>
<pre>"page_actions": [
{
"id": "myaction", // Chosen by the developer. Should be unique within their extension.
"name": "Do action", // The page action name, also used as tooltip (unless overridden).
"icons": ["favicon.png", "favicon2.png"]
}
]</pre>
<p>Supported icon image formats include for example: png, bmp, ico, jpg, gif. If an image larger than 16x16 is specified, it will be resized to fit. For optimal performance, consider using an image that does not have to be resized to fit.</p>
<h2>Events</h2>
<p>Each page action displays an icon in the OmniBox. Whenever the user clicks the icon an event is sent to the extension, signifying that the user wants to apply an action to the current page. To receive notifications about the event, the extension must register a listener.</p>
<p>Page action events are created dynamically using the id of the page action declared in the manifest. For example, a page action with id 'foo' will setup an event called chrome.pageActions["foo"]. An extension would then register listeners like so:</p>
<pre>chrome.pageActions["foo"].addListener(function(object reply) {
console.log(reply.pageActionId); // Display the id of the page action.
console.log(reply.data.tabId); // Display the id of the tab for which the page action event applies.
console.log(reply.data.tabUrl); // Display the URL of the page for which the page action event applies.
});</pre>
<p style="margin-left:25px;"><strong>Parameters</strong></p>
<p style="margin-left:25px;"><i>reply ( object )</i><br>
An object containing the information about the event. Contains the following properties:</p>
<p style="margin-left:50px;"><i>pageActionId ( string )</i><br>
The id of the page action that triggered the event.</p>
<p style="margin-left:50px;"><i>data ( object )</i><br>
An object specifying what tab and which page the event applies to. Contains the following properties:</p>
<p style="margin-left:75px;"><i>tabId ( string )</i><br>
The id of the tab that was active when the event was triggered.</p>
<p style="margin-left:75px;"><i>tabUrl ( string )</i><br>
The url of the page for which the page action applies to.</p>
<!-- END AUTHORED CONTENT -->
|
