chrome.omnibox

refresh date: 2026-09-25 robots: noindex

ब्यौरा

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

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

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

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

मेनिफ़ेस्ट

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' का मतलब है कि नेविगेशन, चुने गए नए Tab में होना चाहिए.

Enum

"currentTab"

"newForegroundTab"

"newBackgroundTab"

SuggestResult

खोज के लिए मिला सुझाव.

प्रॉपर्टी

  • कॉन्टेंट

    स्ट्रिंग

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

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

    boolean ज़रूरी नहीं है

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

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

  • ब्यौरा

    स्ट्रिंग

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

तरीके

setDefaultSuggestion()

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

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

पैरामीटर

  • सुझाव

    DefaultSuggestResult

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

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं है

    Chrome 100+

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

    () => void

रिटर्न

  • Promise<void>

    Chrome 100+

    प्रॉमिस सिर्फ़ Manifest V3 और इसके बाद के वर्शन के लिए काम करते हैं. अन्य प्लैटफ़ॉर्म को कॉलबैक का इस्तेमाल करना होगा.

इवेंट

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