utools.onPluginReady(() => {
+ uTools API
在插件初始化完成时，uTools会自动在你的window对象上挂载utools对象，它将提供一些特有的api，使你的插件能够更好的与uTools主窗口沟通，并获得一些有意义的底层能力。
事件
你可以根据需要事先定义好一些回调函数，uTools会在事件产生时主动调用它们。
onPluginReady(callback)
callback Function
当插件装载成功，uTools将会主动调用这个方法（生命周期内仅调用一次）。
示例
utools.onPluginReady(() => {
console.log('插件装配完成，已准备好')
})
-
onPluginEnter(callback)
callback Function
- Object code String
plugin.json 配置的 feature.code
type String
plugin.json 配置的 feature.cmd.code
payload String | Object | Array
feature.cmd.type 对应匹配的数据
optional Array | undefined
存在多个匹配时的可选匹配类型和数据 [{ type, payload }]
每当插件从后台进入到前台时，uTools将会主动调用这个方法。
示例
utools.onPluginEnter(({code, type, payload, optional}) => {
+
onPluginEnter(callback)
callback Function
+ Object code String
plugin.json 配置的 feature.code
type String
plugin.json 配置的 feature.cmd.code
payload String | Object | Array
feature.cmd.type 对应匹配的数据
optional Array | undefined
存在多个匹配时的可选匹配类型和数据 [{ type, payload }]
每当插件从后台进入到前台时，uTools将会主动调用这个方法。
示例
utools.onPluginEnter(({code, type, payload, optional}) => {
console.log('用户进入插件', code, type, payload)
})
-
onPluginOut(callback)
callback Function
每当插件从前台进入到后台时，uTools将会主动调用这个方法。
示例
utools.onPluginOut(() => {
+
onPluginOut(callback)
callback Function
每当插件从前台进入到后台时，uTools将会主动调用这个方法。
示例
utools.onPluginOut(() => {
console.log('用户退出插件')
})
-
onPluginDetach(callback)
callback Function
用户对插件进行分离操作时，uTools将会主动调用这个方法。
示例
utools.onPluginDetach(() => {
+
onPluginDetach(callback)
callback Function
用户对插件进行分离操作时，uTools将会主动调用这个方法。
示例
utools.onPluginDetach(() => {
console.log('插件被分离')
})
-
onDbPull(callback)
callback Function
当此插件的数据在其他设备上被更改后同步到此设备时，uTools将会主动调用这个方法
示例
utools.onDbPull(() => {
+
onDbPull(callback)
callback Function
当此插件的数据在其他设备上被更改后同步到此设备时，uTools将会主动调用这个方法
示例
utools.onDbPull(() => {
console.log('onDbPull')
})
-
窗口交互
hideMainWindow(isRestorePreWindow)
isRestorePreWindow Boolean
是否焦点回归到前面的活动窗口，默认 true
返回 Boolean
执行该方法将会隐藏uTools主窗口，包括此时正在主窗口运行的插件，分离的插件不会被隐藏。
示例
utools.hideMainWindow()
-
showMainWindow()
返回 Boolean
执行该方法将会显示uTools主窗口，包括此时正在主窗口运行的插件。
示例
utools.showMainWindow()
-
setExpendHeight(height)
height Integer返回 Boolean
执行该方法将会修改插件窗口的高度。
示例
utools.setExpendHeight(100)
-
setSubInput(onChange, placeholder, isFocus)
onChange Function
Object text String
子输入框文本修改时触发
placeholder String (可选)
子输入框占位符
isFocus Boolean (可选)
子输入框是否获得焦点，默认 true
返回 Boolean
设置子输入框，进入插件后，原本uTools的搜索条主输入框将会变成子输入框，子输入框可以为插件所使用。
主输入框
子输入框
示例
utools.setSubInput(({ text }) => {
+
窗口交互
hideMainWindow(isRestorePreWindow)
isRestorePreWindow Boolean
是否焦点回归到前面的活动窗口，默认 true
返回 Boolean
执行该方法将会隐藏uTools主窗口，包括此时正在主窗口运行的插件，分离的插件不会被隐藏。
示例
utools.hideMainWindow()
+
showMainWindow()
返回 Boolean
执行该方法将会显示uTools主窗口，包括此时正在主窗口运行的插件。
示例
utools.showMainWindow()
+
setExpendHeight(height)
height Integer返回 Boolean
执行该方法将会修改插件窗口的高度。
示例
utools.setExpendHeight(100)
+
setSubInput(onChange, placeholder, isFocus)
onChange Function
Object text String
子输入框文本修改时触发
placeholder String (可选)
子输入框占位符
isFocus Boolean (可选)
子输入框是否获得焦点，默认 true
返回 Boolean
设置子输入框，进入插件后，原本uTools的搜索条主输入框将会变成子输入框，子输入框可以为插件所使用。
主输入框
子输入框
示例
utools.setSubInput(({ text }) => {
console.log(text)
}, '搜索')
-
removeSubInput()
返回 Boolean
移出先前设置的子输入框，在插件切换到其他页面时可以重新设置子输入框为其所用。
示例
utools.removeSubInput()
-
setSubInputValue(value)
value String返回 Boolean
直接对子输入框的值进行设置。
示例
utools.setSubInputValue('uTools')
-
subInputFocus()
返回 Boolean
子输入框获得焦点
示例
utools.subInputFocus()
-
subInputSelect()
返回 Boolean
子输入框获得焦点并选中
示例
utools.subInputSelect()
-
subInputBlur()
返回 Boolean
子输入框失去焦点，插件获得焦点
示例
utools.subInputBlur()
-
outPlugin()
返回 Boolean
执行该方法将会退出当前插件。
示例
utools.outPlugin()
-
redirect(label, payload)
label String
feature.cmd.label 名称
payload String | Object
feature.cmd.type 对应的数据
返回 Boolean
该方法可以携带数据，跳转到另一个插件进行处理，如果用户未安装对应的插件，uTools会弹出提醒并引导进入插件中心下载。
示例
//content 为string类型
+
removeSubInput()
返回 Boolean
移出先前设置的子输入框，在插件切换到其他页面时可以重新设置子输入框为其所用。
示例
utools.removeSubInput()
+
setSubInputValue(value)
value String返回 Boolean
直接对子输入框的值进行设置。
示例
utools.setSubInputValue('uTools')
+
subInputFocus()
返回 Boolean
子输入框获得焦点
示例
utools.subInputFocus()
+
subInputSelect()
返回 Boolean
子输入框获得焦点并选中
示例
utools.subInputSelect()
+
subInputBlur()
返回 Boolean
子输入框失去焦点，插件获得焦点
示例
utools.subInputBlur()
+
outPlugin()
返回 Boolean
执行该方法将会退出当前插件。
示例
utools.outPlugin()
+
redirect(label, payload)
label String
feature.cmd.label 名称
payload String | Object
feature.cmd.type 对应的数据
返回 Boolean
该方法可以携带数据，跳转到另一个插件进行处理，如果用户未安装对应的插件，uTools会弹出提醒并引导进入插件中心下载。
示例
//content 为string类型
utools.redirect('翻译', 'hello world')
//content 为object类型
@@ -49,35 +49,35 @@
'data': '/path/to/img.jpg' //filePath、array
//'data': ['path1', 'path2'] //支持数组
})
-
showOpenDialog(options)
options Object
与 Electron API dialog.showOpenDialogSync options 一致
返回 Array | undefined
返回选择的文件数组，用户取消返回 undefined
弹出文件选择框
示例
utools.showOpenDialog({
+
showOpenDialog(options)
options Object
与 Electron API dialog.showOpenDialogSync options 一致
返回 Array | undefined
返回选择的文件数组，用户取消返回 undefined
弹出文件选择框
示例
utools.showOpenDialog({
filters: [{ 'name': 'plugin.json', extensions: ['json'] }],
properties: ['openFile']
})
-
showSaveDialog(options)
options Object
与 Electron API dialog.showSaveDialogSync options 一致
返回 String | undefined
返回选择的路径，用户取消返回 undefined
弹出文件保存框
示例
utools.showSaveDialog({
+
showSaveDialog(options)
options Object
与 Electron API dialog.showSaveDialogSync options 一致
返回 String | undefined
返回选择的路径，用户取消返回 undefined
弹出文件保存框
示例
utools.showSaveDialog({
title: '保存位置',
defaultPath: utools.getPath('downloads')
buttonLabel: '保存'
})
-
showMessageBox(options)
options Object
与 Electron API dialog.showMessageBoxSync options 一致
返回 Integer
返回点击按钮的索引
弹出消息框
示例
utools.showMessageBox({
+
showMessageBox(options)
options Object
与 Electron API dialog.showMessageBoxSync options 一致
返回 Integer
返回点击按钮的索引
弹出消息框
示例
utools.showMessageBox({
type: 'question',
buttons: ['取消', '关机'],
title: '关机确认',
message: '电脑确定要关机?',
defaultId: 1
})
-
findInPage(text, options)
text String
要搜索的内容(必填)
options Object (可选)
与 Electron API contentsfindinpagetext-options options 一致
插件页面中查找内容
示例
utools.findInPage('utools')
-
stopFindInPage(action)
action String
"clearSelection" | "keepSelection" | "activateSelection", 默认 "clearSelection"
停止插件页面中查找
示例
utools.stopFindInPage()
-
startDrag(file)
file String | Array
文件路径 或 文件路径集合
原生拖拽文件到其他窗口
示例
utools.startDrag('/path/to/file')
-
createBrowserWindow(url, options)
url String
相对路径的html文件 例如: test.html?param=xxx
options Object
与 Electron API new BrowserWindow 参数一样, 注意: preload 需配置相对位置
创建浏览器窗口
示例
utools.createBrowserWindow('test.html?param=xxxxxx', {
+
findInPage(text, options)
text String
要搜索的内容(必填)
options Object (可选)
与 Electron API contentsfindinpagetext-options options 一致
插件页面中查找内容
示例
utools.findInPage('utools')
+
stopFindInPage(action)
action String
"clearSelection" | "keepSelection" | "activateSelection", 默认 "clearSelection"
停止插件页面中查找
示例
utools.stopFindInPage()
+
startDrag(file)
file String | Array
文件路径 或 文件路径集合
原生拖拽文件到其他窗口
示例
utools.startDrag('/path/to/file')
+
createBrowserWindow(url, options)
url String
相对路径的html文件 例如: test.html?param=xxx
options Object
与 Electron API new BrowserWindow 参数一样, 注意: preload 需配置相对位置
创建浏览器窗口
示例
utools.createBrowserWindow('test.html?param=xxxxxx', {
title: '测试窗口',
fullscreen: true,
webPreferences: {
preload: 'test/preload.js'
}
})
-
动态增减功能
很多时候，插件中会提供一些功能供用户进行个性化设置（例如：网页快开插件），这部分配置无法在plugin.json事先定义好，所以我们提供了以下方法对插件功能进行动态增减。
getFeatures()
返回 Array
返回本插件所有动态增加的功能。
const features = utools.getFeatures()
+
动态增减功能
很多时候，插件中会提供一些功能供用户进行个性化设置（例如：网页快开插件），这部分配置无法在plugin.json事先定义好，所以我们提供了以下方法对插件功能进行动态增减。
getFeatures()
返回 Array
返回本插件所有动态增加的功能。
const features = utools.getFeatures()
console.log(features)
-
setFeature(feature)
feature Object
+
