summaryrefslogtreecommitdiffstats
path: root/browser/components/extensions/schemas/find.json
blob: 39e455f1914b73f253921778610b78c6c3407182 (plain)
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
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
          }
        ]
      }
    ]
  }
]