التوثيق: دالة getLocalizedUrl في intlayer

الوصف

تقوم دالة getLocalizedUrl بإنشاء عنوان URL محلي عن طريق إضافة بادئة اللغة المحددة إلى عنوان URL المعطى. تتعامل مع عناوين URL المطلقة والنسبية على حد سواء، مما يضمن تطبيق بادئة اللغة الصحيحة بناءً على التكوين.

المعاملات

• url: string

  • الوصف: سلسلة عنوان URL الأصلية التي سيتم إضافة بادئة اللغة إليها.
  • النوع: string

• currentLocale: Locales

  • الوصف: اللغة الحالية التي يتم تعريب العنوان لها.
  • النوع: Locales

• locales: Locales[]

  • الوصف: مصفوفة اختيارية من اللغات المدعومة. بشكل افتراضي، يتم توفير اللغات المكونة في المشروع.
  • النوع: Locales[]
  • الافتراضي: تكوين المشروع

• defaultLocale: Locales

  • الوصف: اللغة الافتراضية للتطبيق. بشكل افتراضي، يتم توفير اللغة الافتراضية المكونة في المشروع.
  • النوع: Locales
  • الافتراضي: تكوين المشروع

• prefixDefault: boolean

  • الوصف: ما إذا كان يجب إضافة بادئة للعنوان الافتراضي. بشكل افتراضي، يتم توفير القيمة المكونة في المشروع.
  • النوع: boolean
  • الافتراضي: تكوين المشروع

الإرجاع

• النوع: string
• الوصف: عنوان URL المحلي للغة المحددة.

مثال على الاستخدام

عناوين URL النسبية

import { getLocalizedUrl, Locales } from "intlayer";

getLocalizedUrl(
  "/about",
  Locales.FRENCH,
  [Locales.ENGLISH, Locales.FRENCH],
  Locales.ENGLISH,
  false
);

// الناتج: "/fr/about" للغة الفرنسية
// الناتج: "/about" للغة الافتراضية (الإنجليزية)

عناوين URL المطلقة

getLocalizedUrl(  "https://example.com/about",  Locales.FRENCH, // اللغة الحالية  [Locales.ENGLISH, Locales.FRENCH], // اللغات المدعومة  Locales.ENGLISH, // اللغة الافتراضية  false // بادئة اللغة الافتراضية); // الناتج: "https://example.com/fr/about" للغة الفرنسيةgetLocalizedUrl(  "https://example.com/about",  Locales.ENGLISH, // اللغة الحالية  [Locales.ENGLISH, Locales.FRENCH], // اللغات المدعومة  Locales.ENGLISH, // اللغة الافتراضية  false // بادئة اللغة الافتراضية); // الناتج: "https://example.com/about" للغة الإنجليزيةgetLocalizedUrl(  "https://example.com/about",  Locales.ENGLISH, // اللغة الحالية  [Locales.ENGLISH, Locales.FRENCH], // اللغات المدعومة  Locales.ENGLISH, // اللغة الافتراضية  true // بادئة اللغة الافتراضية); // الناتج: "https://example.com/en/about" للغة الإنجليزية

لغة غير مدعومة

getLocalizedUrl(  "/about",  Locales.ITALIAN, // اللغة الحالية  [Locales.ENGLISH, Locales.FRENCH], // اللغات المدعومة  Locales.ENGLISH // اللغة الافتراضية); // الناتج: "/about" (لا يتم تطبيق بادئة للغة غير المدعومة)

الحالات الخاصة

• عدم وجود جزء اللغة:

  • إذا لم يحتوي عنوان URL على جزء اللغة، تقوم الدالة بإضافة بادئة اللغة المناسبة بأمان.

• اللغة الافتراضية:

  • عندما تكون قيمة prefixDefault هي false، لا تضيف الدالة بادئة للغة الافتراضية في عنوان URL.

• اللغات غير المدعومة:

  • بالنسبة للغات غير المدرجة في locales، لا تطبق الدالة أي بادئة.

الاستخدام في التطبيقات

في تطبيق متعدد اللغات، يعد تكوين إعدادات التدويل باستخدام locales و defaultLocale أمرًا حيويًا لضمان عرض اللغة الصحيحة. فيما يلي مثال على كيفية استخدام getLocalizedUrl في إعداد التطبيق:

import { Locales, type IntlayerConfig } from "intlayer";

// تكوين اللغات المدعومة واللغة الافتراضية
export default {
  internationalization: {
    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
    defaultLocale: Locales.ENGLISH,
  },
} satisfies IntlayerConfig;

export default config;

يضمن التكوين أعلاه أن يتعرف التطبيق على اللغات ENGLISH و FRENCH و SPANISH كلغات مدعومة ويستخدم ENGLISH كلغة احتياطية.

باستخدام هذا التكوين، يمكن لدالة getLocalizedUrl إنشاء روابط URL محلية ديناميكيًا بناءً على تفضيل لغة المستخدم:

getLocalizedUrl("/about", Locales.FRENCH); // الناتج: "/fr/about"getLocalizedUrl("/about", Locales.SPANISH); // الناتج: "/es/about"getLocalizedUrl("/about", Locales.ENGLISH); // الناتج: "/about"

من خلال دمج دالة getLocalizedUrl، يمكن للمطورين الحفاظ على هياكل روابط URL متسقة عبر لغات متعددة، مما يعزز تجربة المستخدم وتحسين محركات البحث (SEO).