Page Actions
Contents
使用page actions把图标放置到地址栏里。page actions定义需要处理的页面的事件,但是它们不是适用于所有页面的。下面是一些page actions的示例:
- 订阅该页面的RSS feed
- 为页面的图片做一个幻灯片
在下面的屏幕截图中的RSS图标,提供了一个可以让用户订阅当前页面RSS Feed的page action。
想让扩展图标总是可见,则使用browser action。
注意: 打包的应用程序不能使用page actions。
Manifest
在 extension manifest 中用下面的方式注册你的page action:
{ "name": "My extension", ... "page_action": { "default_icon": "icons/foo.png", // optional "default_title": "Do action", // optional; shown in tooltip "default_popup": "popup.html" // optional }, ... }
UI的组成部分
同browser actions一样,page actions 可以有图标、提示信息、 弹出窗口。但没有badge,也因此,作为辅助,page actions可以有显示和消失两种状态。阅读browser action UI. 可以找到图标、提示信息、 弹出窗口相关信息。
使用方法 show() 和 hide() 可以显示和隐藏page action。缺省情况下page action是隐藏的。当要显示时,需要指定图标所在的标签页,图标显示后会一直可见,直到该标签页关闭或开始显示不同的URL (如:用户点击了一个连接)
提示
为了获得最佳的视觉效果,请遵循下列指导方针:
- 要只对少数页面使用page action;
- 不要对大多数页面使用它,如果功能需要,使用 browser actions代替。
- 没事别总让图标出现动画,那会让人很烦。
示例
你可以在examples/api/pageAction 找到使用page action的简单示例,其它例子和源代码帮助查看Samples。
API reference: chrome.pageAction
Methods
hide
隐藏page action.
Parameters
-
tabId
( integer )
- 要执行这个动作的标签ID。
Returns
setIcon
为page aciton设置图标。图标可以是一个图片的路径或者是从一个canvas元素提取的像素信息.。无论是图标路径还是canvas的 imageData,这个属性必须被指定。
Parameters
-
details
( object )
- Undocumented.
-
-
tabId
( integer )
- 要执行这个动作的标签ID。
-
imageData
( optional ImageData )
- 图片的像素信息。必须是一个ImageData 对象(例如:一个canvas元素)。
-
-
path
( optional string )
- 图片在扩展中的的相对路径。
-
iconIndex
( optional integer )
- 不建议。manifest中定义的,0开始的图标数组下标。
-
tabId
Returns
setPopup
设置一个点击page actions时显示在popup中的HTML。
Parameters
-
details
( object )
- Undocumented.
-
-
tabId
( integer )
- 要设置popup的标签ID。
-
popup
( string )
- popup中显示的html文件。如果设置为空字符(''),将不显示popup。
-
tabId
Returns
这个功能已经在chromium 5.0.316.0版本添加。如果你需要这个功能,可以通过manifest的minimum_chrome_version键值来确认你的扩展不会运行在早期的浏览器版本。
Events
onClicked
当page action图标被点击的时候调用,如果page action是一个popup,这个事件将不会触发。Fi
Parameters
-
tab
( Tab )
- Undocumented.