الفرق بين المراجعتين ل"Cordova/cordova plugin statusbar"

من موسوعة حسوب
اذهب إلى التنقل اذهب إلى البحث
ط (تدقيق)
سطر 3: سطر 3:
 
[[تصنيف: Plugin]]
 
[[تصنيف: Plugin]]
 
يوفر الكائن <code>StatusBar</code> بعض الدوال التي يمكن استخدامها لتخصيص شريط الحالة في منصتي iOS و أندرويد.
 
يوفر الكائن <code>StatusBar</code> بعض الدوال التي يمكن استخدامها لتخصيص شريط الحالة في منصتي iOS و أندرويد.
=== التثبيت ===  
+
== التثبيت ==  
  
تتطلب هذه الطريقة في التثبيت الإصدارَ 5.0 من كوروفا وما فوقه:  
+
تتطلب هذه الطريقة في التثبيت الإصدار 5.0 من كوروفا وما بعده:  
 
<syntaxhighlight lang="shell">cordova plugin add cordova-plugin-statusbar‎</syntaxhighlight>  
 
<syntaxhighlight lang="shell">cordova plugin add cordova-plugin-statusbar‎</syntaxhighlight>  
  
سطر 11: سطر 11:
 
<syntaxhighlight lang="shell">cordova plugin add org.apache.cordova.statusbar‎</syntaxhighlight>  
 
<syntaxhighlight lang="shell">cordova plugin add org.apache.cordova.statusbar‎</syntaxhighlight>  
  
من الممكن أيضًا تثبيت هذه الإضافة عبر مستودع git مباشرة (إلا أنه غير مستقر)  
+
من الممكن أيضًا تثبيت هذه الإضافة عبر مستودع git مباشرة (إلا أنه غير مستقر):
 
<syntaxhighlight lang="shell">cordova plugin add https://github.com/apache/cordova-plugin-statusbar.git‎</syntaxhighlight>  
 
<syntaxhighlight lang="shell">cordova plugin add https://github.com/apache/cordova-plugin-statusbar.git‎</syntaxhighlight>  
  
=== تفضيلات ===  
+
== تفضيلات ==  
==== الملف <code>Config.xml</code>====  
+
=== الملف <code>Config.xml</code>===  
* <code>StatusBarOverlaysWebView</code>: (قيمة منطقية، القيمة الافتراضية هي <code>true</code>). على منصة iOS 7، هذا الخيار يجعل شريط الحالة يركَب (overlay) على [[Cordova/webviews|العارض]] أو العكس عند بدء التشغيل.  
+
* <code>StatusBarOverlaysWebView</code>: (قيمة منطقية؛ القيمة الافتراضية هي <code>true</code>) في منصة iOS 7، هذا الخيار يجعل شريط الحالة يركب (overlay) على [[Cordova/webviews|العارض]] أو العكس عند بدء التشغيل.  
 
<syntaxhighlight lang="xml"><preference name="StatusBarOverlaysWebView" value="true" />‎</syntaxhighlight>  
 
<syntaxhighlight lang="xml"><preference name="StatusBarOverlaysWebView" value="true" />‎</syntaxhighlight>  
* <code>StatusBarBackgroundColor</code>: (سلسلة نصية تمثل لونًا سداسعشريًا [color hex]، بدون قيمة افتراضية). على منصة iOS 7، يضبط هذا الخيار لون خلفية شريط الحالة، حيث يعطيها اللون المُتضمّن في السلسلة النصية السداسعشرية (‎<code>#RRGGBB</code>) عند بدء التشغيل. إذا لم يتم تعيين هذه القيمة، فسيكون لون الخلفية شفافًا.  
+
* <code>StatusBarBackgroundColor</code>: (سلسلة نصية تمثل لونًا ست عشريًا [color hex]؛ لا توجد قيمة افتراضية). في منصة iOS 7، يضبط هذا الخيار لون خلفية شريط الحالة، إذ يعطيها اللون المُتضمّن في السلسلة النصية الست عشرية (مثل ‎<code>#RRGGBB</code>) عند بدء التشغيل. إذا لم يتم تعيين هذه القيمة، فسيكون لون الخلفية شفافًا.  
 
<syntaxhighlight lang="xml"><preference name="StatusBarBackgroundColor" value="#000000" />‎</syntaxhighlight>  
 
<syntaxhighlight lang="xml"><preference name="StatusBarBackgroundColor" value="#000000" />‎</syntaxhighlight>  
* <code>StatusBarStyle</code>: (نمط شريط الحالة، االقيمة الافتراضية هي <code>lightcontent</code>). على منصة iOS 7، يعيّن هذا الخيار نمط شريط الحالة. الخيارات الافتراضية المتاحة هي: <code>lightcontent</code> و <code>blacktranslucent</code> و <code>blackopaque</code>.  
+
* <code>StatusBarStyle</code>: (نمط شريط الحالة؛ القيمة الافتراضية هي <code>lightcontent</code>). في منصة iOS 7، يعيّن هذا الخيار نمط شريط الحالة. الخيارات الافتراضية المتاحة هي: <code>lightcontent</code> و <code>blacktranslucent</code> و <code>blackopaque</code>.  
 
<syntaxhighlight lang="xml"><preference name="StatusBarStyle" value="lightcontent" />‎</syntaxhighlight>  
 
<syntaxhighlight lang="xml"><preference name="StatusBarStyle" value="lightcontent" />‎</syntaxhighlight>  
* <code>StatusBarDefaultScrollToTop</code>: (قيمة منطقية، القيمة الافتراضية تساوي <code>false</code>). في نظام التشغيل iOS 7، يتيح هذا الخيار ل[[Cordova/webviews|عارض]] كوروفا استخدام السلوك الافتراضي في التمرير إلى الأعلى (scroll-to-top). القيمة الافتراضية هي <code>false</code>، ما يعني أنّه يمكنك الاستماع إلى الحدث "<code>statusTap</code>" (الموضح أدناه) وتخصيص السلوك.  
+
* <code>StatusBarDefaultScrollToTop</code>: (قيمة منطقية؛ القيمة الافتراضية تساوي <code>false</code>). في نظام التشغيل iOS 7، يتيح هذا الخيار ل[[Cordova/webviews|عارض]] كوروفا استخدام السلوك الافتراضي في التمرير إلى الأعلى (scroll-to-top). القيمة الافتراضية هي <code>false</code>، ما يعني أنّه يمكنك الاستماع إلى الحدث "<code>statusTap</code>" (الموضح أدناه) وتخصيص السلوك.  
 
<syntaxhighlight lang="xml"><preference name="StatusBarDefaultScrollToTop" value="false" />‎</syntaxhighlight>  
 
<syntaxhighlight lang="xml"><preference name="StatusBarDefaultScrollToTop" value="false" />‎</syntaxhighlight>  
====ملاحظات خاصة بمنصة أندرويد ====  
+
===ملاحظات خاصة بمنصة أندرويد ===  
  
 
توصي إرشادات منصة أندرويد من الإصدار 5 وما بعده، بأن يكون لون شريط الحالة مختلفًا عن لون التطبيق الرئيسي (بخلاف لون شريط الحالة المُوحّد في العديد من تطبيقات iOS 7+‎)، لذلك قد ترغب في تعيين لون شريط الحالة في وقت التشغيل عبر التابعين <code>[[Cordova/cordova plugin statusbar#StatusBar.backgroundColorByHexString|StatusBar.backgroundColorByHexString]]</code> و <code>[[Cordova/cordova plugin statusbar#StatusBar.backgroundColorByName|StatusBar.backgroundColorByName]]</code>. فيما يلي إحدى الطرق الممكنة للقيام بذلك:  
 
توصي إرشادات منصة أندرويد من الإصدار 5 وما بعده، بأن يكون لون شريط الحالة مختلفًا عن لون التطبيق الرئيسي (بخلاف لون شريط الحالة المُوحّد في العديد من تطبيقات iOS 7+‎)، لذلك قد ترغب في تعيين لون شريط الحالة في وقت التشغيل عبر التابعين <code>[[Cordova/cordova plugin statusbar#StatusBar.backgroundColorByHexString|StatusBar.backgroundColorByHexString]]</code> و <code>[[Cordova/cordova plugin statusbar#StatusBar.backgroundColorByName|StatusBar.backgroundColorByName]]</code>. فيما يلي إحدى الطرق الممكنة للقيام بذلك:  
سطر 31: سطر 31:
 
}‎</syntaxhighlight>  
 
}‎</syntaxhighlight>  
  
=== إخفاء شريط الحالة عند بدء التشغيل ===  
+
== إخفاء شريط الحالة عند بدء التشغيل ==  
  
خلال وقت التشغيل، يمكنك استخدام الدالة [[Cordova/cordova plugin statusbar#StatusBar.hide|StatusBar.hide]] أدناه، ولكن إذا كنت تريد إخفاء شريط الحالة عند بدء تشغيل التطبيق، فعليك تعديل الملف <code>Info.plist</code> الخاص بتطبيقك.  
+
خلال وقت التشغيل، يمكنك استخدام الدالة [[Cordova/cordova plugin statusbar#StatusBar.hide|<code>StatusBar.hide</code>]] أدناه، ولكن إذا كنت تريد إخفاء شريط الحالة عند بدء تشغيل التطبيق، فعليك تعديل الملف <code>Info.plist</code> الخاص بتطبيقك.  
  
 
أضف أو عدّل هاتين الخاصيتين إذا لم تكونا موجودتين. عيّن <code>"Status bar is initially hidden"</code> إلى القيمة <code>"YES"</code> وعّين <code>"View controller-based status bar appearance"</code> إلى القيمة <code>"NO"</code>. إذا عدّلتها يدويًا من دون استخدام بيئة العمل Xcode، فستكون المفاتيح والقيم كما يلي:  
 
أضف أو عدّل هاتين الخاصيتين إذا لم تكونا موجودتين. عيّن <code>"Status bar is initially hidden"</code> إلى القيمة <code>"YES"</code> وعّين <code>"View controller-based status bar appearance"</code> إلى القيمة <code>"NO"</code>. إذا عدّلتها يدويًا من دون استخدام بيئة العمل Xcode، فستكون المفاتيح والقيم كما يلي:  
سطر 41: سطر 41:
 
<false/>‎</syntaxhighlight>  
 
<false/>‎</syntaxhighlight>  
  
===التوابع===  
+
==<code>StatusBar</code>==  
  
تعرِّف هذه الإضافة كائنًا عامًّا <code>StatusBar</code>.  
+
تعرِّف هذه الإضافة كائنًا عامًّا هو <code>StatusBar</code>. على الرغم من أنّ هذا الكائن موجود في النطاق العام (global scope)، إلا أنه لن يكون متوفرًا إلا بعد إطلاق الحدث <code>[[Cordova/events#deviceready|deviceready]]</code>. <syntaxhighlight lang="javascript">document.addEventListener("deviceready", onDeviceReady, false);
 
 
على الرغم من أنّ هذا الكائن موجود في النطاق العام (global scope)، إلا أنه لن يكون متوفرًا إلا بعد إطلاق الحدث <code>[[Cordova/events#deviceready|deviceready]]</code>.  
 
<syntaxhighlight lang="javascript">document.addEventListener("deviceready", onDeviceReady, false);
 
 
function onDeviceReady() {
 
function onDeviceReady() {
 
     console.log(StatusBar);
 
     console.log(StatusBar);
}‎</syntaxhighlight>
+
}‎</syntaxhighlight>التوابع التي يمكن استعمالها مع هذا الكائن هي:
 
* <code>StatusBar.overlaysWebView</code>  
 
* <code>StatusBar.overlaysWebView</code>  
 
* <code>StatusBar.styleDefault</code>  
 
* <code>StatusBar.styleDefault</code>  
سطر 59: سطر 56:
 
* <code>StatusBar.hide</code>  
 
* <code>StatusBar.hide</code>  
 
* <code>StatusBar.show</code>  
 
* <code>StatusBar.show</code>  
 
+
الخاصيات التي يمكن استعمالها مع هذا الكائن هي:
=== الخاصيات ===
 
 
* <code>StatusBar.isVisible</code>  
 
* <code>StatusBar.isVisible</code>  
 
+
الأحداث التي يمكن استعمالها مع هذا الكائن هي:
===الأحداث===
 
 
* <code>statusTap</code>  
 
* <code>statusTap</code>  
  
 
==<code>StatusBar.overlaysWebView</code>==  
 
==<code>StatusBar.overlaysWebView</code>==  
  
على منصة iOS 7، يجعل هذا التابعُ شريطَ الحالة يركب (overlay) على [[Cordova/webviews|العارض]]، أو العكس.  
+
في منصة iOS 7، يجعل هذا التابعُ شريطَ الحالة يركب (overlay) على [[Cordova/webviews|العارض]]، أو العكس.  
 
<syntaxhighlight lang="javascript">StatusBar.overlaysWebView(true);‎</syntaxhighlight>  
 
<syntaxhighlight lang="javascript">StatusBar.overlaysWebView(true);‎</syntaxhighlight>  
  
===الوصف===
+
اضبط هذا الخيار في منصة iOS 7 إلى القيمة <code>false</code> لإظهار شريط الحالة مثل ما هو الحال في منصة iOS 6. قم بتعيين نمط ولون الخلفية بالشكل الذي تراه مناسبًا باستخدام الدوال الأخرى.  
 
 
على منصة iOS 7، اضبط هذا الخيار عند القيمة <code>false</code> لإظهار شريط الحالة مثل ما هو الحال في منصة iOS 6. قم بتعيين نمط ولون الخلفية بالشكل الذي تراه مناسبًا باستخدام الدوال الأخرى.  
 
 
 
=== المنصات المدعومة ===
 
*iOS
 
  
=== مثال سريع ===
+
المنصات المدعومة هي:
<syntaxhighlight lang="javascript">StatusBar.overlaysWebView(true);
+
*[[Cordova/platforms ios|iOS]]
 +
إليك المثال السريع التالي:<syntaxhighlight lang="javascript">StatusBar.overlaysWebView(true);
 
StatusBar.overlaysWebView(false);‎</syntaxhighlight>  
 
StatusBar.overlaysWebView(false);‎</syntaxhighlight>  
  
 
==<code>StatusBar.styleDefault</code>==  
 
==<code>StatusBar.styleDefault</code>==  
  
استدع هذا التابع لاستخدام شريط الحالة الافتراضي (نص غامق على خلفية فاتحة).  
+
استعمل هذا التابع لاستخدام شريط الحالة الافتراضي (نص غامق على خلفية فاتحة).  
<syntaxhighlight lang="javascript">StatusBar.styleDefault();‎</syntaxhighlight>  
+
<syntaxhighlight lang="javascript">StatusBar.styleDefault();‎</syntaxhighlight>المنصات المدعومة هي:
 
 
=== المنصات المدعومة ===
 
 
*iOS  
 
*iOS  
 
*أندرويد 6 وما بعده  
 
*أندرويد 6 وما بعده  
سطر 96: سطر 85:
 
==<code>StatusBar.styleLightContent</code>==  
 
==<code>StatusBar.styleLightContent</code>==  
  
استدع هذا التابع لأجل استخدام شريط الحالة<code>lightContent</code> (نص فاتح على خلفية داكنة).
+
استعمل هذا التابع لأجل استخدام شريط الحالة<code>lightContent</code> (نص فاتح على خلفية داكنة):
<syntaxhighlight lang="javascript">StatusBar.styleLightContent();‎</syntaxhighlight>  
+
<syntaxhighlight lang="javascript">StatusBar.styleLightContent();‎</syntaxhighlight>المنصات المدعومة هي:
 
 
=== المنصات المدعومة ===
 
 
*iOS  
 
*iOS  
 
*أندرويد 6 وما بعده  
 
*أندرويد 6 وما بعده  
سطر 109: سطر 96:
  
 
استدع هذا التابع لاستخدام شريط الحالة من النوع <code>blackTranslucent</code> (نص فاتح، على خلفية داكنة).  
 
استدع هذا التابع لاستخدام شريط الحالة من النوع <code>blackTranslucent</code> (نص فاتح، على خلفية داكنة).  
<syntaxhighlight lang="javascript">StatusBar.styleBlackTranslucent();‎</syntaxhighlight>  
+
<syntaxhighlight lang="javascript">StatusBar.styleBlackTranslucent();‎</syntaxhighlight>المنصات المدعومة هي:
 
 
=== المنصات المدعومة ===
 
 
*iOS  
 
*iOS  
 
*أندرويد 6 وما بعده  
 
*أندرويد 6 وما بعده  
سطر 121: سطر 106:
  
 
استدع هذا التابع لاستخدام شريط الحالة من النوع <code>blackOpaque</code> (نص فاتح على خلفيات داكنة).  
 
استدع هذا التابع لاستخدام شريط الحالة من النوع <code>blackOpaque</code> (نص فاتح على خلفيات داكنة).  
<syntaxhighlight lang="javascript">StatusBar.styleBlackOpaque();‎</syntaxhighlight>  
+
<syntaxhighlight lang="javascript">StatusBar.styleBlackOpaque();‎</syntaxhighlight>المنصات المدعومة هي:
 
 
=== المنصات المدعومة ===
 
 
*iOS  
 
*iOS  
 
*أندرويد 6 وما بعده  
 
*أندرويد 6 وما بعده  
سطر 132: سطر 115:
 
==<code>StatusBar.backgroundColorByName</code>==  
 
==<code>StatusBar.backgroundColorByName</code>==  
  
على منصة iOS 7، عند ضبط الخاصية <code>StatusBar.statusBarOverlaysWebView</code> عند القيمة <code>false</code>، فيمكنك تعيين لون خلفية شريط الحالة باسم اللون.  
+
في منصة iOS 7، عند ضبط الخاصية <code>StatusBar.statusBarOverlaysWebView</code> إلى القيمة <code>false</code>، يمكنك تعيين لون خلفية شريط الحالة باسم أي لون تريده.  
 
<syntaxhighlight lang="javascript">StatusBar.backgroundColorByName("red");‎</syntaxhighlight>  
 
<syntaxhighlight lang="javascript">StatusBar.backgroundColorByName("red");‎</syntaxhighlight>  
  
 
أسماء الألوان المدعومة هي:  
 
أسماء الألوان المدعومة هي:  
<syntaxhighlight lang="javascript">black, darkGray, lightGray, white, gray, red, green, blue, cyan, yellow, magenta, orange, purple, brown‎</syntaxhighlight>  
+
<syntaxhighlight lang="javascript">black, darkGray, lightGray, white, gray, red, green, blue, cyan, yellow, magenta, orange, purple, brown‎</syntaxhighlight>المنصات المدعومة هي:
 
 
=== المنصات المدعومة ===
 
 
*iOS  
 
*iOS  
 
*أندرويد الإصدار 5 وما بعده  
 
*أندرويد الإصدار 5 وما بعده  
سطر 147: سطر 128:
 
==<code>StatusBar.backgroundColorByHexString</code>==  
 
==<code>StatusBar.backgroundColorByHexString</code>==  
  
يعيّن هذا التابع لون خلفية شريط الحالة عبر إعطائه سلسلة نصية تحتوي لونًا سداسعشريًا (hex).  
+
يعيّن هذا التابع لون خلفية شريط الحالة عبر إعطائه سلسلة نصية تحتوي لونًا ست عشريًا (hex).  
 
<syntaxhighlight lang="javascript">StatusBar.backgroundColorByHexString("#C0C0C0");‎</syntaxhighlight>  
 
<syntaxhighlight lang="javascript">StatusBar.backgroundColorByHexString("#C0C0C0");‎</syntaxhighlight>  
  
اختصارات ألوان CSS مدعومةٌ أيضًا.  
+
اختصارات ألوان [[CSS]] مدعومةٌ أيضًا.  
 
<syntaxhighlight lang="javascript">StatusBar.backgroundColorByHexString("#333"); // => #333333
 
<syntaxhighlight lang="javascript">StatusBar.backgroundColorByHexString("#333"); // => #333333
 
StatusBar.backgroundColorByHexString("#FAB"); // => #FFAABB‎</syntaxhighlight>  
 
StatusBar.backgroundColorByHexString("#FAB"); // => #FFAABB‎</syntaxhighlight>  
  
على منصة iOS 7، عند ضبط الخاصية <code>StatusBar.statusBarOverlaysWebView</code> عند القيمة <code>false</code>، فيمكنك تعيين لون خلفية شريط الحالة عبر سلسلة نصية سداسعشرية (<code>‎#RRGGBB</code>).  
+
في منصة iOS 7، عند ضبط الخاصية <code>StatusBar.statusBarOverlaysWebView</code> إلى القيمة <code>false</code>، فيمكنك تعيين لون خلفية شريط الحالة عبر سلسلة نصية ست عشرية (<code>‎#RRGGBB</code>).  
  
على منصتي WP7 و WP8، يمكنك أيضًا تحديد قيم من قبيل ‎<code>#AARRGGBB</code>، حيث تمثل <code>AA</code> قيمة الشفافية ألفا (alpha value)  
+
في منصتي WP7 و WP8، يمكنك أيضًا تحديد قيم مثل ‎<code>#AARRGGBB</code>، إذ تمثل <code>AA</code> قيمة الشفافية ألفا (alpha value).
  
=== المنصات المدعومة ===
+
المنصات المدعومة هي:
 
*iOS  
 
*iOS  
 
*أندرويد 5 ومابعده  
 
*أندرويد 5 ومابعده  
سطر 168: سطر 149:
  
 
يخفي هذا التابع شريط الحالة.  
 
يخفي هذا التابع شريط الحالة.  
<syntaxhighlight lang="javascript">StatusBar.hide();‎</syntaxhighlight>  
+
<syntaxhighlight lang="javascript">StatusBar.hide();‎</syntaxhighlight>المنصات المدعومة هي:
 
 
=== المنصات المدعومة ===
 
 
*iOS  
 
*iOS  
 
*أندرويد  
 
*أندرويد  
سطر 180: سطر 159:
  
 
يعرض هذا التابع شريط الحالة.  
 
يعرض هذا التابع شريط الحالة.  
<syntaxhighlight lang="javascript">StatusBar.show();‎</syntaxhighlight>  
+
<syntaxhighlight lang="javascript">StatusBar.show();‎</syntaxhighlight>المنصات المدعومة هي:
 
 
=== المنصات المدعومة ===
 
 
*iOS  
 
*iOS  
 
*أندرويد  
 
*أندرويد  
سطر 191: سطر 168:
 
==<code>StatusBar.isVisible</code>==  
 
==<code>StatusBar.isVisible</code>==  
  
تحقق من هذه الخاصية لمعرفة ما إذا كان شريط الحالة مرئيًا أم لا.  
+
استعمل هذه الخاصية لمعرفة ما إذا كان شريط الحالة مرئيًا أم لا.  
 
<syntaxhighlight lang="javascript">if (StatusBar.isVisible) {
 
<syntaxhighlight lang="javascript">if (StatusBar.isVisible) {
 
     // افعل شيئًا ما
 
     // افعل شيئًا ما
}‎</syntaxhighlight>  
+
}‎</syntaxhighlight>المنصات المدعومة هي:
 
 
=== المنصات المدعومة ===
 
 
*iOS  
 
*iOS  
 
*أندرويد  
 
*أندرويد  
سطر 205: سطر 180:
 
==<code>statusTap</code>==  
 
==<code>statusTap</code>==  
  
أنصِت لهذا الحدث لمعرفة ما إذا تم النقر على شريط الحالة.  
+
أنصِت لهذا الحدث لمعرفة ما إذا تم النقر على شريط الحالة أم لا.  
 
<syntaxhighlight lang="javascript">window.addEventListener('statusTap', function() {
 
<syntaxhighlight lang="javascript">window.addEventListener('statusTap', function() {
 
     // أو افعل ما تريد ،document.body.scrollTop = 0 مرّر إلى أعلى عبر
 
     // أو افعل ما تريد ،document.body.scrollTop = 0 مرّر إلى أعلى عبر
});‎</syntaxhighlight>  
+
});‎</syntaxhighlight>المنصات المدعومة هي:
 
 
=== المنصات المدعومة ===
 
 
*iOS
 
*iOS
  
== انظر أيضا ==
+
== انظر أيضًا ==
 
* إضافة [[Cordova/cordova plugin dialogs|مربعات الحوار]]
 
* إضافة [[Cordova/cordova plugin dialogs|مربعات الحوار]]
 
* إضافة <nowiki/>[[Cordova/cordova plugin battery status|حالة البطارية]]
 
* إضافة <nowiki/>[[Cordova/cordova plugin battery status|حالة البطارية]]
 +
* إضافة [[Cordova/cordova plugin network information|حالة الشبكة]]
 
* [[Cordova/plugins|دليل تطوير الإضافات في كوردوفا]]
 
* [[Cordova/plugins|دليل تطوير الإضافات في كوردوفا]]
  
 
==مصادر==
 
==مصادر==
 
*[https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-statusbar/index.html صفحة cordova-plugin-statusbar في توثيق كوردوفا الرسمي.]
 
*[https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-statusbar/index.html صفحة cordova-plugin-statusbar في توثيق كوردوفا الرسمي.]

مراجعة 12:22، 24 ديسمبر 2018

يوفر الكائن StatusBar بعض الدوال التي يمكن استخدامها لتخصيص شريط الحالة في منصتي iOS و أندرويد.

التثبيت

تتطلب هذه الطريقة في التثبيت الإصدار 5.0 من كوروفا وما بعده:

cordova plugin add cordova-plugin-statusbar‎

لا يزال بالإمكان تثبيت هذه الإضافة على الإصدارات القديمة من كوردوفا عبر المُعرِّف المُهمل التالي:

cordova plugin add org.apache.cordova.statusbar‎

من الممكن أيضًا تثبيت هذه الإضافة عبر مستودع git مباشرة (إلا أنه غير مستقر):

cordova plugin add https://github.com/apache/cordova-plugin-statusbar.git‎

تفضيلات

الملف Config.xml

  • StatusBarOverlaysWebView: (قيمة منطقية؛ القيمة الافتراضية هي true) في منصة iOS 7، هذا الخيار يجعل شريط الحالة يركب (overlay) على العارض أو العكس عند بدء التشغيل.
<preference name="StatusBarOverlaysWebView" value="true" />
  • StatusBarBackgroundColor: (سلسلة نصية تمثل لونًا ست عشريًا [color hex]؛ لا توجد قيمة افتراضية). في منصة iOS 7، يضبط هذا الخيار لون خلفية شريط الحالة، إذ يعطيها اللون المُتضمّن في السلسلة النصية الست عشرية (مثل ‎#RRGGBB) عند بدء التشغيل. إذا لم يتم تعيين هذه القيمة، فسيكون لون الخلفية شفافًا.
<preference name="StatusBarBackgroundColor" value="#000000" />
  • StatusBarStyle: (نمط شريط الحالة؛ القيمة الافتراضية هي lightcontent). في منصة iOS 7، يعيّن هذا الخيار نمط شريط الحالة. الخيارات الافتراضية المتاحة هي: lightcontent و blacktranslucent و blackopaque.
<preference name="StatusBarStyle" value="lightcontent" />
  • StatusBarDefaultScrollToTop: (قيمة منطقية؛ القيمة الافتراضية تساوي false). في نظام التشغيل iOS 7، يتيح هذا الخيار لعارض كوروفا استخدام السلوك الافتراضي في التمرير إلى الأعلى (scroll-to-top). القيمة الافتراضية هي false، ما يعني أنّه يمكنك الاستماع إلى الحدث "statusTap" (الموضح أدناه) وتخصيص السلوك.
<preference name="StatusBarDefaultScrollToTop" value="false" />

ملاحظات خاصة بمنصة أندرويد

توصي إرشادات منصة أندرويد من الإصدار 5 وما بعده، بأن يكون لون شريط الحالة مختلفًا عن لون التطبيق الرئيسي (بخلاف لون شريط الحالة المُوحّد في العديد من تطبيقات iOS 7+‎)، لذلك قد ترغب في تعيين لون شريط الحالة في وقت التشغيل عبر التابعين StatusBar.backgroundColorByHexString و StatusBar.backgroundColorByName. فيما يلي إحدى الطرق الممكنة للقيام بذلك:

if (cordova.platformId == 'android') {
    StatusBar.backgroundColorByHexString("#333");
}

إخفاء شريط الحالة عند بدء التشغيل

خلال وقت التشغيل، يمكنك استخدام الدالة StatusBar.hide أدناه، ولكن إذا كنت تريد إخفاء شريط الحالة عند بدء تشغيل التطبيق، فعليك تعديل الملف Info.plist الخاص بتطبيقك.

أضف أو عدّل هاتين الخاصيتين إذا لم تكونا موجودتين. عيّن "Status bar is initially hidden" إلى القيمة "YES" وعّين "View controller-based status bar appearance" إلى القيمة "NO". إذا عدّلتها يدويًا من دون استخدام بيئة العمل Xcode، فستكون المفاتيح والقيم كما يلي:

<key>UIStatusBarHidden</key>
<true/>
<key>UIViewControllerBasedStatusBarAppearance</key>
<false/>

StatusBar

تعرِّف هذه الإضافة كائنًا عامًّا هو StatusBar. على الرغم من أنّ هذا الكائن موجود في النطاق العام (global scope)، إلا أنه لن يكون متوفرًا إلا بعد إطلاق الحدث deviceready.

document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() {
    console.log(StatusBar);
}

التوابع التي يمكن استعمالها مع هذا الكائن هي:

  • StatusBar.overlaysWebView
  • StatusBar.styleDefault
  • StatusBar.styleLightContent
  • StatusBar.styleBlackTranslucent
  • StatusBar.styleBlackOpaque
  • StatusBar.backgroundColorByName
  • StatusBar.backgroundColorByHexString
  • StatusBar.hide
  • StatusBar.show

الخاصيات التي يمكن استعمالها مع هذا الكائن هي:

  • StatusBar.isVisible

الأحداث التي يمكن استعمالها مع هذا الكائن هي:

  • statusTap

StatusBar.overlaysWebView

في منصة iOS 7، يجعل هذا التابعُ شريطَ الحالة يركب (overlay) على العارض، أو العكس.

StatusBar.overlaysWebView(true);

اضبط هذا الخيار في منصة iOS 7 إلى القيمة false لإظهار شريط الحالة مثل ما هو الحال في منصة iOS 6. قم بتعيين نمط ولون الخلفية بالشكل الذي تراه مناسبًا باستخدام الدوال الأخرى.

المنصات المدعومة هي:

إليك المثال السريع التالي:

StatusBar.overlaysWebView(true);
StatusBar.overlaysWebView(false);

StatusBar.styleDefault

استعمل هذا التابع لاستخدام شريط الحالة الافتراضي (نص غامق على خلفية فاتحة).

StatusBar.styleDefault();

المنصات المدعومة هي:

  • iOS
  • أندرويد 6 وما بعده
  • Windows Phone 7
  • Windows Phone 8
  • Windows Phone 8.1

StatusBar.styleLightContent

استعمل هذا التابع لأجل استخدام شريط الحالةlightContent (نص فاتح على خلفية داكنة):

StatusBar.styleLightContent();

المنصات المدعومة هي:

  • iOS
  • أندرويد 6 وما بعده
  • Windows Phone 7
  • Windows Phone 8
  • Windows Phone 8.1

StatusBar.styleBlackTranslucent

استدع هذا التابع لاستخدام شريط الحالة من النوع blackTranslucent (نص فاتح، على خلفية داكنة).

StatusBar.styleBlackTranslucent();

المنصات المدعومة هي:

  • iOS
  • أندرويد 6 وما بعده
  • Windows Phone 7
  • Windows Phone 8
  • Windows Phone 8.1

StatusBar.styleBlackOpaque

استدع هذا التابع لاستخدام شريط الحالة من النوع blackOpaque (نص فاتح على خلفيات داكنة).

StatusBar.styleBlackOpaque();

المنصات المدعومة هي:

  • iOS
  • أندرويد 6 وما بعده
  • Windows Phone 7
  • Windows Phone 8
  • Windows Phone 8.1

StatusBar.backgroundColorByName

في منصة iOS 7، عند ضبط الخاصية StatusBar.statusBarOverlaysWebView إلى القيمة false، يمكنك تعيين لون خلفية شريط الحالة باسم أي لون تريده.

StatusBar.backgroundColorByName("red");

أسماء الألوان المدعومة هي:

black, darkGray, lightGray, white, gray, red, green, blue, cyan, yellow, magenta, orange, purple, brown

المنصات المدعومة هي:

  • iOS
  • أندرويد الإصدار 5 وما بعده
  • Windows Phone 7
  • Windows Phone 8
  • Windows Phone 8.1

StatusBar.backgroundColorByHexString

يعيّن هذا التابع لون خلفية شريط الحالة عبر إعطائه سلسلة نصية تحتوي لونًا ست عشريًا (hex).

StatusBar.backgroundColorByHexString("#C0C0C0");

اختصارات ألوان CSS مدعومةٌ أيضًا.

StatusBar.backgroundColorByHexString("#333"); // => #333333
StatusBar.backgroundColorByHexString("#FAB"); // => #FFAABB‎

في منصة iOS 7، عند ضبط الخاصية StatusBar.statusBarOverlaysWebView إلى القيمة false، فيمكنك تعيين لون خلفية شريط الحالة عبر سلسلة نصية ست عشرية (‎#RRGGBB).

في منصتي WP7 و WP8، يمكنك أيضًا تحديد قيم مثل ‎#AARRGGBB، إذ تمثل AA قيمة الشفافية ألفا (alpha value).

المنصات المدعومة هي:

  • iOS
  • أندرويد 5 ومابعده
  • Windows Phone 7
  • Windows Phone 8
  • Windows Phone 8.1

StatusBar.hide

يخفي هذا التابع شريط الحالة.

StatusBar.hide();

المنصات المدعومة هي:

  • iOS
  • أندرويد
  • Windows Phone 7
  • Windows Phone 8
  • Windows Phone 8.1

StatusBar.show

يعرض هذا التابع شريط الحالة.

StatusBar.show();

المنصات المدعومة هي:

  • iOS
  • أندرويد
  • Windows Phone 7
  • Windows Phone 8
  • Windows Phone 8.1

StatusBar.isVisible

استعمل هذه الخاصية لمعرفة ما إذا كان شريط الحالة مرئيًا أم لا.

if (StatusBar.isVisible) {
    // افعل شيئًا ما
}

المنصات المدعومة هي:

  • iOS
  • أندرويد
  • Windows Phone 7
  • Windows Phone 8
  • Windows Phone 8.1

statusTap

أنصِت لهذا الحدث لمعرفة ما إذا تم النقر على شريط الحالة أم لا.

window.addEventListener('statusTap', function() {
    // أو افعل ما تريد ،document.body.scrollTop = 0 مرّر إلى أعلى عبر
});

المنصات المدعومة هي:

  • iOS

انظر أيضًا

مصادر