عرض مصدر Cordova/cordova plugin statusbar

<noinclude>{{DISPLAYTITLE:إضافة شريط الحالة في كوردوفا}}</noinclude>
[[تصنيف: Cordova]]
[[تصنيف: Plugin]]
يوفر الكائن <code>StatusBar</code> بعض الدوال التي يمكن استخدامها لتخصيص شريطي الحالة في منصتي iOS و أندرويد. 

: تحذير: تقرير عن القضايا على [https://issues.apache.org/jira/issues/?jql=project%20%3D%20CB%20AND%20status%20in%20(Open%2C%20%22In%20Progress%22%2C%20Reopened)%20AND%20resolution%20%3D%20Unresolved%20AND%20component%20%3D%20%22cordova-plugin-statusbar%22%20ORDER%20BY%20priority%20DESC%2C%20summary%20ASC%2C%20updatedDate%20DESC Apache Cordova issue tracker] 

=== التثبيت === 

تتطلب هذه الطريقة في التثبيت هذه الإصدار 5.0 من كوروفا وما فوقه: 
<syntaxhighlight lang="xml">cordova plugin add cordova-plugin-statusbar‎</syntaxhighlight> 

لا يزال بالإمكان تثبيت هذه الإضافة على الإصدارات القديمة من كوردوفا عبر المُعرِّف <code>deprecated</code> 
<syntaxhighlight lang="xml">cordova plugin add org.apache.cordova.statusbar‎</syntaxhighlight> 

من الممكن أيضًا تثبيت هذه الإضافة عبر مستودع git مباشرة (إلا أنه غير مستقر) 
<syntaxhighlight lang="xml">cordova plugin add https://github.com/apache/cordova-plugin-statusbar.git‎</syntaxhighlight> 

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

تحدد إرشادات أندرويد، الإصدار 5 وما بعده، أن يكون لون شريط الحالة مختلفًا عن لون التطبيق الرئيسي (بخلاف لون شريط الحالة الموحد في العديد من تطبيقات iOS 7+‎)، لذلك قد ترغب بدلاً من ذلك في تعيين لون شريط الحالة في وقت التشغيل عبر التابعين <code>StatusBar.backgroundColorByHexString</code> أو <code>StatusBar.backgroundColorByName</code>. فيما يلي إحدى الطرق الممكنة للقيام بذلك: 
<syntaxhighlight lang="xml">if (cordova.platformId == 'android') {
    StatusBar.backgroundColorByHexString("#333");
}‎</syntaxhighlight> 

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

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

إضافة أو عدل هاتين الخاصيتين إذا لم تكونا موجودتين. عيّن <code>"Status bar is initially hidden"</code> إلى القيمة <code>"YES"</code> وعّين <code>"View controller-based status bar appearance"</code> إلى القيمة <code>"NO"</code>. إذا عدّلتها يدويًا من دون استخدام بيئة العمل Xcode، فستكون المفاتيح والقيم كما يلي: 
<syntaxhighlight lang="xml"><key>UIStatusBarHidden</key>
<true/>
<key>UIViewControllerBasedStatusBarAppearance</key>
<false/>‎</syntaxhighlight> 

===التوابع=== 

تعرّف هذه الإضافة كائنًا عامًّا <code>StatusBar</code>. 

على الرغم من أن هذا الكائن موجود في النطاق العام (global scope)، إلا أنه لن يكون متوفرًا إلا بعد إطلاق الحدث <code>deviceready</code>. 
<syntaxhighlight lang="xml">document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() {
    console.log(StatusBar);
}‎</syntaxhighlight> 
* 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) على [[Cordova/webviews|العارض]]، أو العكس. 
<syntaxhighlight lang="xml">StatusBar.overlaysWebView(true);‎</syntaxhighlight> 

===الوصف=== 

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

=== المنصات المدعومة === 
*iOS 

=== مثال سريع === 
<syntaxhighlight lang="xml">StatusBar.overlaysWebView(true);
StatusBar.overlaysWebView(false);‎</syntaxhighlight> 

==StatusBar.styleDefault== 

استخدم شريط الحالة الافتراضي (النص غامق على خلفية فاتحة). 
<syntaxhighlight lang="xml">StatusBar.styleDefault();‎</syntaxhighlight> 

=== المنصات المدعومة === 
*iOS 
*أندرويد 6 وما بعده 
* Windows Phone 7 
*Windows Phone 8 
* Windows Phone 8.1 

==StatusBar.styleLightContent== 

لأجل استخدام شريط الحالة ذو المحتوى المُشعّ lightContent (نص مُشِع على خلفية داكنة). 
<syntaxhighlight lang="xml">StatusBar.styleLightContent();‎</syntaxhighlight> 

=== المنصات المدعومة === 
*iOS 
*Android 6+ 
*Windows Phone 7 
*Windows Phone 8 
*Windows Phone 8.1 

==StatusBar.styleBlackTranslucent== 

لاستخدام شريط الحالة من النوع blackTranslucent (نص فاتح، على خلفية داكنة). 
<syntaxhighlight lang="xml">StatusBar.styleBlackTranslucent();‎</syntaxhighlight> 

=== المنصات المدعومة === 
*iOS 
*Android 6+ 
*Windows Phone 7 
*Windows Phone 8 
*Windows Phone 8.1 

==StatusBar.styleBlackOpaque== 

لاستخدام شريط الحالة من النوع blackOpaque (نص مشعّ على خلفيات داكنة). 
<syntaxhighlight lang="xml">StatusBar.styleBlackOpaque();‎</syntaxhighlight> 

=== المنصات المدعومة === 
*iOS 
*Android 6+ 
*Windows Phone 7 
*Windows Phone 8 
*Windows Phone 8.1 

==StatusBar.backgroundColorByName== 

على منصة iOS 7، عند تعيين StatusBar.statusBarOverlaysWebView إلى القيمة false، يمكنك تعيين لون خلفية شريط الحالة حسب اسم اللون. 
<syntaxhighlight lang="xml">StatusBar.backgroundColorByName("red");‎</syntaxhighlight> 

أسماء الألوان المدعومة هي: 
<syntaxhighlight lang="xml">black, darkGray, lightGray, white, gray, red, green, blue, cyan, yellow, magenta, orange, purple, brown‎</syntaxhighlight> 

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

==StatusBar.backgroundColorByHexString== 

يعيّن هذا التابع لون خلفية شريط الحالة عبر إعطائه سلسلة نصية تحتوي لونًا سداسعشريًا (hex). 
<syntaxhighlight lang="xml">StatusBar.backgroundColorByHexString("#C0C0C0");‎</syntaxhighlight> 

اختصارات ألوان CSS مدعومةٌ أيضًا. 
<syntaxhighlight lang="xml">StatusBar.backgroundColorByHexString("#333"); // => #333333
StatusBar.backgroundColorByHexString("#FAB"); // => #FFAABB‎</syntaxhighlight> 

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

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

=== المنصات المدعومة === 
*iOS 
*Android 5+ 
*Windows Phone 7 
*Windows Phone 8 
*Windows Phone 8.1 

==StatusBar.hide== 

يخفي هذا التابع شريط الحالة. 
<syntaxhighlight lang="xml">StatusBar.hide();‎</syntaxhighlight> 

=== المنصات المدعومة === 
*iOS 
*أندرويد 
*Windows Phone 7 
*Windows Phone 8 
*Windows Phone 8.1 

==StatusBar.show== 

يعرض هذا التابع شريط الحالة. 
<syntaxhighlight lang="xml">StatusBar.show();‎</syntaxhighlight> 

=== المنصات المدعومة === 
*iOS 
*أندرويد 
*Windows Phone 7 
*Windows Phone 8 
*Windows Phone 8.1 

==StatusBar.isVisible== 

تحقق من هذه الخاصية لمعرفة ما إذا كان شريط الحالة مرئيًا أم لا. 
<syntaxhighlight lang="xml">if (StatusBar.isVisible) {
    // do something
}‎</syntaxhighlight> 

=== المنصات المدعومة === 
*iOS 
*أندرويد 
*Windows Phone 7 
*Windows Phone 8 
* ويندوز فون 8.1 

==statusTap== 

أنصِت لهذا الحدث لمعرفة ما إذا تم النقر على شريط الحالة. 
<syntaxhighlight lang="xml">window.addEventListener('statusTap', function() {
    // scroll-up with document.body.scrollTop = 0; or do whatever you want
});‎</syntaxhighlight> 

=== المنصات المدعومة === 
*iOS
==مصادر==
*[https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-statusbar/index.html صفحة cordova-plugin-statusbar في توثيق كوردوفا الرسمي.]