ब्यौरा
Omnibox API की मदद से, Google Chrome के पता बार में कोई कीवर्ड रजिस्टर किया जा सकता है. इस पता बार को खोज बार भी कहा जाता है.
जब उपयोगकर्ता आपके एक्सटेंशन का कीवर्ड डालता है, तो वह सिर्फ़ आपके एक्सटेंशन के साथ इंटरैक्ट करना शुरू करता है. हर कीस्ट्रोक आपके एक्सटेंशन को भेजा जाता है. इसके जवाब में, सुझाव दिए जा सकते हैं.
सुझावों को कई तरीकों से फ़ॉर्मैट किया जा सकता है. जब उपयोगकर्ता कोई सुझाव स्वीकार करता है, तो आपके एक्सटेंशन को इसकी सूचना दी जाती है और वह कार्रवाई कर सकता है.
मेनिफ़ेस्ट
खोज बार एपीआई का इस्तेमाल करने के लिए, आपको मेनिफ़ेस्ट में "omnibox.keyword" फ़ील्ड शामिल करना होगा. आपको 16 x 16 पिक्सल का आइकॉन भी तय करना चाहिए. यह आइकॉन, पता बार में तब दिखेगा, जब उपयोगकर्ताओं को कीवर्ड मोड में जाने का सुझाव दिया जाएगा.
उदाहरण के लिए:
{
"name": "Aaron's omnibox extension",
"version": "1.0",
"omnibox": { "keyword" : "aaron" },
"icons": {
"16": "16-full-color.png"
},
"background": {
"persistent": false,
"scripts": ["background.js"]
}
}
उदाहरण
इस एपीआई को आज़माने के लिए, chrome-extension-samples रिपॉज़िटरी से omnibox API का उदाहरण इंस्टॉल करें.
टाइप
DefaultSuggestResult
सुझाया गया नतीजा.
प्रॉपर्टी
-
ब्यौरा
स्ट्रिंग
यूआरएल ड्रॉपडाउन में दिखने वाला टेक्स्ट. इसमें स्टाइलिंग के लिए, एक्सएमएल-स्टाइल मार्कअप शामिल हो सकता है. इस्तेमाल किए जा सकने वाले टैग ये हैं: 'url' (यूआरएल के लिए), 'match' (उपयोगकर्ता की क्वेरी से मैच होने वाले टेक्स्ट को हाइलाइट करने के लिए), और 'dim' (धुंधले हेल्पर टेक्स्ट के लिए). स्टाइल को नेस्ट किया जा सकता है. उदाहरण के लिए, डिम किया गया मैच.
DescriptionStyleType
स्टाइल का टाइप.
Enum
"url"
"match"
"dim"
OnInputEnteredDisposition
खोज बार की क्वेरी के लिए विंडो डिस्पोज़िशन. नतीजे दिखाने के लिए, यह कॉन्टेक्स्ट इस्तेमाल करने का सुझाव दिया जाता है. उदाहरण के लिए, अगर खोज बार में किसी यूआरएल पर जाने का निर्देश दिया जाता है, तो 'newForegroundTab' का मतलब है कि नेविगेशन, चुने गए नए टैब में होना चाहिए.
Enum
"currentTab"
"newForegroundTab"
"newBackgroundTab"
SuggestResult
सुझाया गया नतीजा.
प्रॉपर्टी
-
कॉन्टेंट
स्ट्रिंग
यूआरएल बार में डाला गया टेक्स्ट, जो उपयोगकर्ता के इस एंट्री को चुनने पर एक्सटेंशन को भेजा जाता है.
-
मिटाया जा सकता है
बूलियन ज़रूरी नहीं
Chrome 63+ Chrome 148 से browser.*क्या उपयोगकर्ता, सुझाए गए नतीजे को मिटा सकता है.
-
ब्यौरा
स्ट्रिंग
यूआरएल ड्रॉपडाउन में दिखने वाला टेक्स्ट. इसमें स्टाइलिंग के लिए, एक्सएमएल-स्टाइल मार्कअप शामिल हो सकता है. इस्तेमाल किए जा सकने वाले टैग ये हैं: 'url' (यूआरएल के लिए), 'match' (उपयोगकर्ता की क्वेरी से मैच होने वाले टेक्स्ट को हाइलाइट करने के लिए), और 'dim' (धुंधले हेल्पर टेक्स्ट के लिए). स्टाइल को नेस्ट किया जा सकता है. उदाहरण के लिए, डिम किया गया मैच. पहले से तय की गई पांच इकाइयों को टेक्स्ट के तौर पर दिखाने के लिए, आपको उन्हें एस्केप करना होगा: stackoverflow.com/a/1091953/89484
तरीके
setDefaultSuggestion()
browser.omnibox.setDefaultSuggestion(
suggestion: DefaultSuggestResult,
): Promise<void>
यह डिफ़ॉल्ट सुझाव के लिए ब्यौरा और स्टाइल सेट करता है. डिफ़ॉल्ट सुझाव वह टेक्स्ट होता है जो यूआरएल बार के नीचे, सुझाव की पहली लाइन में दिखता है.
पैरामीटर
-
सुझाव
'content' पैरामीटर के बिना, SuggestResult ऑब्जेक्ट का कुछ हिस्सा.
रिटर्न
-
वादा<शून्य>
Chrome 100+ Chrome 148 से browser.*
इवेंट
onDeleteSuggestion
browser.omnibox.onDeleteSuggestion.addListener(
callback: function,
)
उपयोगकर्ता ने सुझाया गया कोई नतीजा मिटाया है.
पैरामीटर
-
कॉलबैक
फ़ंक्शन
callbackपैरामीटर कुछ ऐसा दिखता है:(text: string) => void
-
टेक्स्ट
स्ट्रिंग
-
onInputCancelled
browser.omnibox.onInputCancelled.addListener(
callback: function,
)
उपयोगकर्ता ने इनपुट स्वीकार किए बिना, कीवर्ड इनपुट सेशन को खत्म कर दिया है.
पैरामीटर
-
कॉलबैक
फ़ंक्शन
callbackपैरामीटर कुछ ऐसा दिखता है:() => void
onInputChanged
browser.omnibox.onInputChanged.addListener(
callback: function,
)
उपयोगकर्ता ने खोज बार में टाइप किए गए टेक्स्ट को बदल दिया है.
पैरामीटर
-
कॉलबैक
फ़ंक्शन
callbackपैरामीटर कुछ ऐसा दिखता है:(text: string, suggest: function) => void
-
टेक्स्ट
स्ट्रिंग
-
सुझाव दें
फ़ंक्शन
suggestपैरामीटर कुछ ऐसा दिखता है:(suggestResults: SuggestResult[]) => void
-
suggestResults
सुझाए गए नतीजों का कलेक्शन
-
-
onInputEntered
browser.omnibox.onInputEntered.addListener(
callback: function,
)
उपयोगकर्ता ने खोज बार में टाइप किए गए सुझाव को स्वीकार कर लिया है.
पैरामीटर
-
कॉलबैक
फ़ंक्शन
callbackपैरामीटर कुछ ऐसा दिखता है:(text: string, disposition: OnInputEnteredDisposition) => void
-
टेक्स्ट
स्ट्रिंग
-
disposition
-
onInputStarted
browser.omnibox.onInputStarted.addListener(
callback: function,
)
उपयोगकर्ता ने एक्सटेंशन का कीवर्ड टाइप करके, कीवर्ड इनपुट सेशन शुरू किया है. यह हर इनपुट सेशन में सिर्फ़ एक बार और किसी भी onInputChanged इवेंट से पहले भेजा जाता है.
पैरामीटर
-
कॉलबैक
फ़ंक्शन
callbackपैरामीटर कुछ ऐसा दिखता है:() => void