chrome.omnibox

ब्यौरा

खोज बार (खोज क्वेरी डालने वाला) एपीआई आपको Google Chrome के पता बार के साथ किसी कीवर्ड को रजिस्टर करने की सुविधा देता है. इसे खोज वाली पट्टी के नाम से भी जाना जाता है.

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

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

मेनिफ़ेस्ट

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

"omnibox"

खोज वाली पट्टी API का इस्तेमाल करने के लिए, आपको मेनिफ़ेस्ट में "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 अपने-आप आपके 16x16-पिक्सल आइकॉन का ग्रेस्केल वर्शन बना देता है. आपको सभी रंगों वाला वर्शन देना चाहिए, ताकि रंग की ज़रूरत वाली दूसरी स्थितियों में भी इसका इस्तेमाल किया जा सके. उदाहरण के लिए, कॉन्टेक्स्ट मेन्यू एपीआई 16x16-पिक्सल का आइकॉन भी इस्तेमाल करता है, लेकिन यह रंगीन होता है.

उदाहरण

इस एपीआई को आज़माने के लिए, chrome-extension-सैंपल डेटा स्टोर करने की जगह से, खोज वाली पट्टी के एपीआई का उदाहरण इंस्टॉल करें.

टाइप

DefaultSuggestResult

सुझाया गया नतीजा.

प्रॉपर्टी

• ब्यौरा

  स्ट्रिंग

  यूआरएल के ड्रॉपडाउन में दिखने वाला टेक्स्ट. स्टाइल के लिए, एक्सएमएल-स्टाइल वाला मार्कअप शामिल हो सकता है. साथ काम करने वाले टैग ये हैं: 'url' (लिटरल यूआरएल के लिए), 'मैच करता है' (उपयोगकर्ता की क्वेरी से मेल खाने वाले टेक्स्ट को हाइलाइट करने के लिए), और 'डिम' (कम हेल्पर टेक्स्ट के लिए). स्टाइल नेस्ट किए जा सकते हैं, जैसे कि डिम्ड मैच.

DescriptionStyleType

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

स्टाइल टाइप.

Enum

OnInputEnteredDisposition

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

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

Enum

"currentTab"

"newForegroundTab"

SuggestResult

सुझाया गया नतीजा.

प्रॉपर्टी

• वीडियो

  स्ट्रिंग

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

• हटाया जा सकने वाला

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

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

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

• ब्यौरा

  स्ट्रिंग

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

तरीके

setDefaultSuggestion()

वादा

chrome.omnibox.setDefaultSuggestion(
  suggestion: DefaultSuggestResult,
  callback?: function,
)

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

पैरामीटर

• सुझाव

  DefaultSuggestResult

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

• कॉलबैक

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

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

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

  ()=>void

रिटर्न

• Promise<void>

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

  प्रॉमिस, मेनिफ़ेस्ट 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

  • टेक्स्ट

    स्ट्रिंग

  • स्वभाव

    OnInputEnteredDisposition

onInputStarted

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

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

पैरामीटर

• कॉलबैक

  फ़ंक्शन

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

  ()=>void