chrome.omnibox

الوصف

تسمح لك واجهة برمجة التطبيقات للمربّع متعدد الاستخدامات بتسجيل كلمة رئيسية باستخدام شريط عناوين Google Chrome، والذي يُعرف أيضًا باسم "المربّع متعدد الاستخدامات".

لقطة شاشة تعرض اقتراحات ذات صلة بالكلمة الرئيسية "بحث Chromium"

عندما يُدخل المستخدم الكلمة الرئيسية للإضافة، يبدأ المستخدم في التفاعل فقط مع الإضافة. يتم إرسال كل ضغطة مفتاح إلى إضافتك، ويمكنك تقديم اقتراحات ردًا على ذلك.

يمكن تنسيق الاقتراحات بشكل غني بعدة طرق. وعندما يقبل المستخدم اقتراحًا، يتم إعلام إضافتك ويمكنه اتخاذ إجراء.

البيان

يجب الإعلان عن المفاتيح التالية في البيان لاستخدام واجهة برمجة التطبيقات هذه.

"omnibox"

يجب تضمين حقل "omnibox.keyword" في البيان لاستخدام واجهة برمجة التطبيقات للمربّع المتعدد الاستخدامات. إِنْتَ أيضًا رمزًا بحجم 16 × 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. يمكن أن تحتوي على ترميز بنمط XML لتصميمها. العلامات المتوافقة هي "عنوان URL". (لعنوان URL حرفي)، 'مطابقة' (لإبراز النص الذي يتطابق مع طلب بحث المستخدم) و"تعتيم" (لنص مساعد الإضاءة الخافت). يمكن دمج الأنماط، على سبيل المثال مطابقة خافتة.

DescriptionStyleType

الإصدار 44 من Chrome أو الإصدارات الأحدث

نوع النمط.

Enum

"عنوان URL"

"مطابقة"

"تعتيم"

OnInputEnteredDisposition

الإصدار 44 من Chrome أو الإصدارات الأحدث

ترتيب النافذة لطلب بحث المربّع المتعدد الاستخدامات وهذا هو السياق المقترَح لعرض النتائج. على سبيل المثال، إذا كان أمر المربع المتعدد الاستخدامات هو الانتقال إلى عنوان URL معين، فسيبدأ ترتيب "newForegroundTab" تعني أن التنقل يجب أن يتم في علامة تبويب جديدة محددة.

Enum

"currentTab"

"newForegroundTab"

"newBackgroundTab"

SuggestResult

نتيجة مقترَحة.

أماكن إقامة

  • محتوى

    سلسلة

    النص الذي يتم وضعه في شريط عنوان URL، والذي يتم إرساله إلى الإضافة عندما يختار المستخدم هذا الإدخال.

  • قابل للحذف

    قيمة منطقية اختيارية

    الإصدار 63 من Chrome أو الإصدارات الأحدث

    ما إذا كان يمكن للمستخدم حذف نتيجة الاقتراحات.

  • الوصف

    سلسلة

    النص الذي يتم عرضه في القائمة المنسدلة لعناوين URL. يمكن أن تحتوي على ترميز بنمط XML لتصميمها. العلامات المتوافقة هي "عنوان URL". (لعنوان URL حرفي)، 'مطابقة' (لإبراز النص الذي يتطابق مع طلب بحث المستخدم) و"تعتيم" (لنص مساعد الإضاءة الخافت). يمكن دمج الأنماط، على سبيل المثال مطابقة خافتة. يجب الهروب من الكيانات الخمسة المحددة مسبقًا لعرضها كنص: stackoverflow.com/a/1091953/89484

الطُرق

setDefaultSuggestion()

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

تضبط الوصف والتصميم للاقتراح التلقائي. الاقتراح الافتراضي هو النص المعروض في صف الاقتراح الأول أسفل شريط عنوان URL.

المعلمات

  • اقتراح

    DefaultSuggestResult

    كائن suggestResult جزئي، بدون "content" .

  • رد الاتصال

    الدالة اختيارية

    الإصدار 100 من Chrome أو الإصدارات الأحدث

    تظهر المَعلمة callback على النحو التالي: 

    () => void

المرتجعات

  • وعود <باطلة>

    الإصدار 100 من Chrome أو الإصدارات الأحدث

    تتوفّر الوعود في الإصدار Manifest V3 والإصدارات الأحدث، ولكن يتم توفير معاودة الاتصال. التوافق مع الأنظمة القديمة. لا يمكنك استخدام كلتيهما في نفس استدعاء الدالة. تشير رسالة الأشكال البيانية يتم حل الوعد بنفس النوع الذي يتم إرساله إلى معاودة الاتصال.

فعاليات

onDeleteSuggestion

الإصدار 63 من Chrome أو الإصدارات الأحدث 
chrome.omnibox.onDeleteSuggestion.addListener(
  callback: function,
)

حذف المستخدم نتيجة مقترحة.

المعلمات

  • رد الاتصال

    دالة

    تظهر المَعلمة callback على النحو التالي: 

    (text: string) => void

    • text

      سلسلة

onInputCancelled

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

أنهى المستخدم جلسة إدخال الكلمات الرئيسية بدون قبول الإدخال.

المعلمات

  • رد الاتصال

    دالة

    تظهر المَعلمة callback على النحو التالي: 

    () => void

onInputChanged

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

غيَّر المستخدم ما هو مكتوب في المربّع المتعدد الاستخدامات.

المعلمات

  • رد الاتصال

    دالة

    تظهر المَعلمة callback على النحو التالي: 

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

    • text

      سلسلة

    • اقتراح

      دالة

      تظهر المَعلمة suggest على النحو التالي: 

      (suggestResults: SuggestResult[]) => void

      • suggestResults

        SuggestResult[]

        مصفوفة من نتائج الاقتراحات

onInputEntered

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

قبِل المستخدم ما هو مكتوب في المربّع المتعدد الاستخدامات.

المعلمات

onInputStarted

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

بدأ المستخدم جلسة إدخال كلمة رئيسية عن طريق كتابة الكلمة الرئيسية للإضافة. ونضمن أنّه سيتم إرسال ذلك مرة واحدة فقط لكل جلسة إدخال، وقبل أي أحداث onInputChanged.

المعلمات

  • رد الاتصال

    دالة

    تظهر المَعلمة callback على النحو التالي: 

    () => void