chrome.omnibox

ब्यौरा

Omnibox API की मदद से, Google Chrome के पता बार में कोई कीवर्ड रजिस्टर किया जा सकता है. इसे Omnibox भी कहा जाता है.

इस स्क्रीनशॉट में, 'Chromium Search' कीवर्ड से जुड़े सुझाव दिखाए गए हैं

जब कोई व्यक्ति आपके एक्सटेंशन का कीवर्ड डालता है, तो वह सिर्फ़ आपके एक्सटेंशन से इंटरैक्ट करता है. टाइप किया गया हर अक्षर आपके एक्सटेंशन को भेजा जाता है. इसके जवाब में, आपको सुझाव देने का विकल्प मिलता है.

सुझावों को कई तरीकों से बेहतर तरीके से फ़ॉर्मैट किया जा सकता है. जब उपयोगकर्ता किसी सुझाव को स्वीकार करता है, तो आपके एक्सटेंशन को इसकी सूचना मिलती है. इसके बाद, वह कार्रवाई कर सकता है.

मेनिफ़ेस्ट

इस एपीआई का इस्तेमाल करने के लिए, इन कुंजियों को मेनिफ़ेस्ट फ़ाइल में एलान करना होगा.

"omnibox"

Omnibox API का इस्तेमाल करने के लिए, आपको मेनिफ़ेस्ट में "omnibox.keyword" फ़ील्ड शामिल करना होगा. आपको 16x16 पिक्सल का आइकॉन भी तय करना चाहिए. यह आइकॉन, उपयोगकर्ताओं को कीवर्ड मोड में जाने का सुझाव देते समय पता बार में दिखेगा.

उदाहरण के लिए:

{   "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

Chrome 44 या इसके बाद का वर्शन

स्टाइल का टाइप.

Enum

"url"

"match"

"dim"

OnInputEnteredDisposition

Chrome 44 या इसके बाद का वर्शन

खोज वाली पट्टी में की गई क्वेरी के लिए विंडो डिस्पोज़िशन. नतीजे दिखाने के लिए, इस कॉन्टेक्स्ट का सुझाव दिया जाता है. उदाहरण के लिए, अगर ओम्निबॉक्स कमांड किसी यूआरएल पर नेविगेट करने के लिए है, तो 'newForegroundTab' का मतलब है कि नेविगेशन, चुने गए नए टैब में होना चाहिए.

Enum

"currentTab"

"newForegroundTab"

"newBackgroundTab"

SuggestResult

नतीजा सुझाएं.

प्रॉपर्टी

  • कॉन्टेंट

    स्ट्रिंग

    यूआरएल बार में डाला गया टेक्स्ट. जब उपयोगकर्ता इस एंट्री को चुनता है, तब यह टेक्स्ट एक्सटेंशन को भेजा जाता है.

  • मिटाया जा सकता है

    बूलियन ज़रूरी नहीं है

    Chrome 63 और इसके बाद के वर्शन

    इससे पता चलता है कि सुझाव के तौर पर मिले नतीजे को उपयोगकर्ता मिटा सकता है या नहीं.

  • ब्यौरा

    स्ट्रिंग

    यूआरएल ड्रॉपडाउन में दिखने वाला टेक्स्ट. इसमें स्टाइलिंग के लिए, एक्सएमएल स्टाइल वाला मार्कअप शामिल किया जा सकता है. इन टैग का इस्तेमाल किया जा सकता है: 'url' (लिटरल यूआरएल के लिए), 'match' (उपयोगकर्ता की क्वेरी से मैच होने वाले टेक्स्ट को हाइलाइट करने के लिए), और 'dim' (सहायता देने वाले टेक्स्ट को धुंधला करने के लिए). स्टाइल को नेस्ट किया जा सकता है. जैसे, डिम किया गया मैच. आपको पांच पहले से तय की गई इकाइयों को एस्केप करना होगा, ताकि उन्हें टेक्स्ट के तौर पर दिखाया जा सके: stackoverflow.com/a/1091953/89484

तरीके

setDefaultSuggestion()

chrome.omnibox.setDefaultSuggestion(
  suggestion: DefaultSuggestResult,
): Promise<void>

यह कुकी, डिफ़ॉल्ट सुझाव के लिए ब्यौरा और स्टाइल सेट करती है. डिफ़ॉल्ट सुझाव वह टेक्स्ट होता है जो यूआरएल बार के नीचे, सुझाव वाली पहली लाइन में दिखता है.

पैरामीटर

  • सुझाव

    DefaultSuggestResult

    'content' पैरामीटर के बिना, SuggestResult ऑब्जेक्ट का कुछ हिस्सा.

रिटर्न

  • Promise<void>

    Chrome 100+

इवेंट

onDeleteSuggestion

Chrome 63 और इसके बाद के वर्शन 
chrome.omnibox.onDeleteSuggestion.addListener(
  callback: function,
)

उपयोगकर्ता ने सुझाया गया कोई नतीजा मिटा दिया है.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर ऐसा दिखता है: 

    (text: string) => void

    • टेक्स्ट

      स्ट्रिंग

onInputCancelled

chrome.omnibox.onInputCancelled.addListener(
  callback: function,
)

उपयोगकर्ता ने इनपुट स्वीकार किए बिना, कीवर्ड डालने का सेशन बंद कर दिया है.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर ऐसा दिखता है: 

    () => void

onInputChanged

chrome.omnibox.onInputChanged.addListener(
  callback: function,
)

उपयोगकर्ता ने ऑम्निबॉक्स में टाइप किए गए टेक्स्ट को बदल दिया है.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर ऐसा दिखता है: 

    (text: string, suggest: function) => void

    • टेक्स्ट

      स्ट्रिंग

    • सुझाव दें

      फ़ंक्शन

      suggest पैरामीटर ऐसा दिखता है: 

      (suggestResults: SuggestResult[]) => void

      • suggestResults

        SuggestResult[]

        नतीजों के सुझावों की ऐरे

onInputEntered

chrome.omnibox.onInputEntered.addListener(
  callback: function,
)

उपयोगकर्ता ने ओम्निबॉक्स में टाइप किए गए टेक्स्ट को स्वीकार कर लिया है.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर ऐसा दिखता है: 

    (text: string, disposition: OnInputEnteredDisposition) => void

onInputStarted

chrome.omnibox.onInputStarted.addListener(
  callback: function,
)

उपयोगकर्ता ने एक्सटेंशन का कीवर्ड टाइप करके, कीवर्ड डालने का सेशन शुरू किया है. इस इवेंट को हर इनपुट सेशन में सिर्फ़ एक बार भेजा जाता है. साथ ही, इसे onInputChanged इवेंट से पहले भेजा जाता है.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर ऐसा दिखता है: 

    () => void