chrome.omnibox

ब्यौरा

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

'Chromium Search' कीवर्ड से मिलते-जुलते सुझाव दिखाने वाला स्क्रीनशॉट

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

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

मेनिफ़ेस्ट

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

"omnibox"

खोज वाली पट्टी एपीआई का इस्तेमाल करने के लिए आपको मेनिफ़ेस्ट में "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 से खोज वाली पट्टी एपीआई का उदाहरण इंस्टॉल करें डेटा स्टोर करने की जगह.

टाइप

DefaultSuggestResult

सुझाव का एक नतीजा.

प्रॉपर्टी

  • ब्यौरा

    स्ट्रिंग

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

DescriptionStyleType

Chrome 44 और उसके बाद वाले वर्शन के लिए

स्टाइल टाइप.

Enum

"url"

"match"

"धीमी"

OnInputEnteredDisposition

Chrome 44 और उसके बाद वाले वर्शन के लिए

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

Enum

"currentTab"

"newForegroundTab"

"newbackgroundTab"

SuggestResult

सुझाव का एक नतीजा.

प्रॉपर्टी

  • कॉन्टेंट

    स्ट्रिंग

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

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

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

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

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

  • ब्यौरा

    स्ट्रिंग

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

तरीके

setDefaultSuggestion()

प्रॉमिस 
chrome.omnibox.setDefaultSuggestion(
  suggestion: DefaultSuggestResult,
  callback?: function,
)

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

पैरामीटर

  • सुझाव

    DefaultSuggestResult

    'content' के बिना, एक आंशिक suggestedresults ऑब्जेक्ट पैरामीटर.

  • कॉलबैक

    फ़ंक्शन वैकल्पिक

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

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

    () => void

रिटर्न

  • प्रॉमिस<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

onInputStarted

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

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

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

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

    () => void