browser.omnibox

বিবরণ

Omnibox API আপনাকে Google Chrome-এর অ্যাড্রেস বারে একটি কীওয়ার্ড রেজিস্টার করতে দেয়, যা Omnibox নামেও পরিচিত।

ব্যবহারকারী আপনার এক্সটেনশনের কীওয়ার্ড লিখলে, তিনি শুধুমাত্র আপনার এক্সটেনশনের সাথে ইন্টার‍্যাক্ট করা শুরু করেন। প্রতিটি কিস্ট্রোক আপনার এক্সটেনশনে পাঠানো হয় এবং আপনি উত্তরে সাজেশন দিতে পারেন।

সাজেশনগুলি বিভিন্ন উপায়ে রিচ ফর্ম্যাট করা যেতে পারে। ব্যবহারকারী কোনও সাজেশন গ্রহণ করলে, আপনার এক্সটেনশন বিজ্ঞপ্তি পায় এবং অ্যাকশন নিতে পারে।

ম্যানিফেস্ট

এই API ব্যবহার করতে নিম্নলিখিত কীগুলি ম্যানিফেস্টে ঘোষণা করতে হবে।

"omnibox"

Omnibox API ব্যবহার করতে আপনাকে ম্যানিফেস্টে "omnibox.keyword" ফিল্ড অন্তর্ভুক্ত করতে হবে। আপনাকে ১৬ বাই ১৬ পিক্সেলের একটি আইকনও উল্লেখ করতে হবে, যা ব্যবহারকারীদের কীওয়ার্ড মোডে প্রবেশ করার পরামর্শ দেওয়ার সময় অ্যাড্রেস বারে দেখানো হবে।

যেমন:

{
  "name": "Aaron's omnibox extension",
  "version": "1.0",
  "omnibox": { "keyword" : "aaron" },
  "icons": {
    "16": "16-full-color.png"
  },
  "background": {
    "persistent": false,
    "scripts": ["background.js"]
  }
}

মনে রাখবেন: Chrome অটোমেটিক আপনার ১৬x১৬-পিক্সেল আইকনের একটি গ্রেস্কেল ভার্সন তৈরি করে। আপনাকে একটি সম্পূর্ণ রঙিন ভার্সন প্রদান করতে হবে যাতে এটি অন্যান্য পরিস্থিতিতেও ব্যবহার করা যেতে পারে যেখানে রঙের প্রয়োজন হয়। যেমন, কন্টেক্সট মেনু API-ও ১৬x১৬ পিক্সেলের আইকন ব্যবহার করে, তবে এটি রঙিন দেখায়।

উদাহরণ

এই API ব্যবহার করে দেখতে, chrome-extension-samples রিপোজিটরি থেকে omnibox API-এর উদাহরণ ইনস্টল করুন।

ধরন

DefaultSuggestResult

একটি সাজেস্ট করা ফলাফল।

প্রপার্টি

• বর্ণনা

  স্ট্রিং

  URL ড্রপডাউনে যে টেক্সট দেখানো হয়। স্টাইলিংয়ের জন্য XML-স্টাইল মার্কআপ থাকতে পারে। কাজ করে এমন ট্যাগ হল 'url' (আক্ষরিক URL-এর জন্য), 'match' (ব্যবহারকারীর কোয়েরির সাথে ম্যাচ করা টেক্সট হাইলাইট করার জন্য) এবং 'dim' (ডিম হেল্পার টেক্সটের জন্য)। স্টাইল নেস্ট করা যেতে পারে, যেমন, ডিমড ম্যাচ।

DescriptionStyleType

Chrome 44+ Chrome 148 থেকে browser.*

স্টাইলের ধরন।

Enum

"url"

"ম্যাচ"

"ডিম"

OnInputEnteredDisposition

Chrome 44+ Chrome 148 থেকে browser.*

অমনিবক্স কোয়েরির জন্য উইন্ডো ডিসপোজিশন। ফলাফল দেখানোর জন্য এটি হল সাজেস্ট করা প্রসঙ্গ। যেমন, অমনিবক্স কমান্ড যদি কোনও নির্দিষ্ট URL-এ নেভিগেট করার জন্য হয়, তাহলে 'newForegroundTab' ডিসপোজিশনের অর্থ হল নেভিগেশনটি একটি নতুন বেছে নেওয়া ট্যাবে হওয়া উচিত।

Enum

"currentTab"

"newForegroundTab"

"newBackgroundTab"

SuggestResult

একটি সাজেস্ট করা ফলাফল।

প্রপার্টি

• কন্টেন্ট

  স্ট্রিং

  URL বারে যে টেক্সট লেখা হয় এবং ব্যবহারকারী এই এন্ট্রি বেছে নিলে এক্সটেনশনে যা পাঠানো হয়।

• মুছে ফেলা যাবে

  বুলিয়ান ঐচ্ছিক

  Chrome 63+ Chrome 148 থেকে browser.*

  ব্যবহারকারী সাজেস্ট করা ফলাফল মুছে দিতে পারবেন কিনা।

• বর্ণনা

  স্ট্রিং

  URL ড্রপডাউনে যে টেক্সট দেখানো হয়। স্টাইলিংয়ের জন্য XML-স্টাইল মার্কআপ থাকতে পারে। কাজ করে এমন ট্যাগ হল 'url' (আক্ষরিক URL-এর জন্য), 'match' (ব্যবহারকারীর কোয়েরির সাথে ম্যাচ করা টেক্সট হাইলাইট করার জন্য) এবং 'dim' (ডিম হেল্পার টেক্সটের জন্য)। স্টাইল নেস্ট করা যেতে পারে, যেমন, ডিমড ম্যাচ। টেক্সট হিসেবে দেখানোর জন্য আপনাকে পাঁচটি আগে থেকে নির্ধারিত এন্টিটি এড়িয়ে যেতে হবে: stackoverflow.com/a/1091953/89484

পদ্ধতি

setDefaultSuggestion()

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

ডিফল্ট সাজেশনের জন্য বিবরণ ও স্টাইলিং সেট করে। ডিফল্ট সাজেশন হল সেই টেক্সট যা URL বারের নিচে প্রথম সাজেশন সারিতে দেখানো হয়।

প্যারামিটারগুলি

• সাজেশন

  DefaultSuggestResult

  'content' প্যারামিটার ছাড়া একটি আংশিক SuggestResult অবজেক্ট।

রিটার্ন

• <void> প্রমিস

  Chrome 100+ ব্রাউজার।* Chrome 148 থেকে

ইভেন্ট

onDeleteSuggestion

Chrome 63+ Chrome 148 থেকে browser.*

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

      SuggestResult[]

      সাজেস্ট করা ফলাফলের অ্যারে

onInputEntered

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

ব্যবহারকারী অমনিবক্সে যা টাইপ করা হয়েছে তা গ্রহণ করেছেন।

প্যারামিটারগুলি

• কলব্যাক

  ফাংশন

  callback প্যারামিটারটি দেখতে এইরকম:

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

  • মেসেজ পাঠান

    স্ট্রিং

  • ডিসপোজিশন

    OnInputEnteredDisposition

onInputStarted

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

ব্যবহারকারী এক্সটেনশনের কীওয়ার্ড টাইপ করে কীওয়ার্ড ইনপুট সেশন শুরু করেছেন। এটি ইনপুট সেশন প্রতি ঠিক একবার এবং যেকোনও onInputChanged ইভেন্টের আগে পাঠানো হবে বলে গ্যারান্টি দেওয়া হয়।

প্যারামিটারগুলি

• কলব্যাক

  ফাংশন

  callback প্যারামিটারটি দেখতে এইরকম:

  () => void