diff options
Diffstat (limited to 'browser/components/extensions/schemas/find.json')
-rw-r--r-- | browser/components/extensions/schemas/find.json | 122 |
1 files changed, 122 insertions, 0 deletions
diff --git a/browser/components/extensions/schemas/find.json b/browser/components/extensions/schemas/find.json new file mode 100644 index 0000000000..39e455f191 --- /dev/null +++ b/browser/components/extensions/schemas/find.json @@ -0,0 +1,122 @@ +[ + { + "namespace": "manifest", + "types": [ + { + "$extend": "OptionalPermission", + "choices": [ + { + "type": "string", + "enum": ["find"] + } + ] + } + ] + }, + { + "namespace": "find", + "description": "Use the <code>browser.find</code> API to interact with the browser's <code>Find</code> interface.", + "permissions": ["find"], + "functions": [ + { + "name": "find", + "type": "function", + "async": true, + "description": "Search for text in document and store found ranges in array, in document order.", + "parameters": [ + { + "name": "queryphrase", + "type": "string", + "description": "The string to search for." + }, + { + "name": "params", + "type": "object", + "description": "Search parameters.", + "optional": true, + "properties": { + "tabId": { + "type": "integer", + "description": "Tab to query. Defaults to the active tab.", + "optional": true, + "minimum": 0 + }, + "caseSensitive": { + "type": "boolean", + "description": "Find only ranges with case sensitive match.", + "optional": true + }, + "matchDiacritics": { + "type": "boolean", + "description": "Find only ranges with diacritic sensitive match.", + "optional": true + }, + "entireWord": { + "type": "boolean", + "description": "Find only ranges that match entire word.", + "optional": true + }, + "includeRectData": { + "description": "Return rectangle data which describes visual position of search results.", + "type": "boolean", + "optional": true + }, + "includeRangeData": { + "description": "Return range data which provides range data in a serializable form.", + "type": "boolean", + "optional": true + } + } + } + ] + }, + { + "name": "highlightResults", + "type": "function", + "async": true, + "description": "Highlight a range", + "parameters": [ + { + "name": "params", + "type": "object", + "description": "highlightResults parameters", + "optional": true, + "properties": { + "rangeIndex": { + "type": "integer", + "description": "Found range to be highlighted. Default highlights all ranges.", + "minimum": 0, + "optional": true + }, + "tabId": { + "type": "integer", + "description": "Tab to highlight. Defaults to the active tab.", + "minimum": 0, + "optional": true + }, + "noScroll": { + "type": "boolean", + "description": "Don't scroll to highlighted item.", + "optional": true + } + } + } + ] + }, + { + "name": "removeHighlighting", + "type": "function", + "async": true, + "description": "Remove all highlighting from previous searches.", + "parameters": [ + { + "name": "tabId", + "type": "integer", + "description": "Tab to highlight. Defaults to the active tab.", + "optional": true + } + ] + } + ] + } +] |