localingo 1.0.2

Automatic localization package for Flutter with CLI tool for generating translations using Free Translate API. Features type-safe keys, runtime locale switching, and beautiful terminal UI.

🌍 Localingo 🌍

From Egypt to the World

🌐 Supported Languages

Localingo supports 13+ languages for its first release:

Language	Native Name	Code
🇸🇦 Arabic	العربية	ar
🇩🇪 German	Deutsch	de
🇫🇷 French	Français	fr
🇪🇸 Spanish	Español	es
🇮🇹 Italian	Italiano	it
🇵🇹 Portuguese	Português	pt
🇷🇺 Russian	Русский	ru
🇯🇵 Japanese	日本語	ja
🇰🇷 Korean	한국어	ko
🇨🇳 Chinese (Simplified)	简体中文	zh-CN
🇹🇼 Chinese (Traditional)	繁體中文	zh-TW
🇮🇳 Hindi	हिन्दी	hi
🇹🇷 Turkish	Türkçe	tr
🇳🇱 Dutch	Nederlands	nl
🇵🇱 Polish	Polski	pl

And many more to be added soon

📦 Installation

Add Localingo to your pubspec.yaml:

dependencies:
  Localingo: ^1.1.0
  flutter_localizations:
    sdk: flutter

Install dependencies:

flutter pub get

🚀 Quick Start (3 Steps)

Step 1: Create English Translations

Create assets/l10n/en.json with your app's text:

{
  "app_name": "My Awesome App",
  "welcome": "Welcome!",
  "greeting": "Hello, {name}!",
  "items_count": "{count} items found",
  "login_button": "Login",
  "logout": "Logout"
}

Add to pubspec.yaml:

flutter:
  assets:
    - assets/l10n/

Step 2: Generate Translations

Run the interactive CLI:

dart run localingo:generate

What happens?

1. ✅ Reads your en.json file
2. 🎯 Interactive language selection
3. 🌍 Generates translations (e.g., ar.json, fr.json, es.json)
4. 🔑 Creates lib/locale_keys.dart with type-safe keys

That's it! 🎉

Step 3: Use in Your App

Setup MaterialApp:

import 'package:flutter/material.dart';
import 'package:flutter_localizations/flutter_localizations.dart';
import 'package:Localingo/Localingo.dart';
import 'locale_keys.dart'; // Auto-generated!

void main() => runApp(const MyApp());

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    // 1. Create a global navigator key
    final navigatorKey = GlobalKey<NavigatorState>();
    
    // 2. Register it with Localingo
    Localingo.setNavigatorKey(navigatorKey);

    return MaterialApp(
      title: 'Localingo Demo',
      
      // 3. Pass it to MaterialApp
      navigatorKey: navigatorKey,
      
      // Add localization delegates
      localizationsDelegates: const [
        AppLocalizations.delegate,
        GlobalMaterialLocalizations.delegate,
        GlobalWidgetsLocalizations.delegate,
        GlobalCupertinoLocalizations.delegate,
      ],
      
      // Specify supported locales
      supportedLocales: const [
        Locale('en'), // English
        Locale('ar'), // Arabic
        Locale('fr'), // French
        Locale('es'), // Spanish
        Locale('de'), // German
      ],
      
      home: const HomePage(),
    );
  }
}

Use Type-Safe Keys (No Context Needed!):

import 'package:Localingo/Localingo.dart';
import 'locale_keys.dart'; // Auto-generated!

class HomePage extends StatelessWidget {
  const HomePage({super.key});

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(LocaleKeys.appName), // Simple!
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            Text(LocaleKeys.welcome),
            Text(LocaleKeys.greeting),
            ElevatedButton(
              onPressed: () {},
              child: Text(LocaleKeys.loginButton),
            ),
          ],
        ),
      ),
    );
  }
}

Placeholders & Dynamic Text

Your en.json:

{
  "greeting": "Hello, {name}!",
  "items_count": "{count} items in cart"
}

Usage:

// With LocaleKeys (type-safe)
Text(LocaleKeys.greeting.replaceAll('{name}', 'John'))
Text(LocaleKeys.itemsCount.replaceAll('{count}', '5'))

// Or using the old way with string keys
Text('greeting'.tr().replaceAll('{name}', 'John'))

📖 API Reference

LocaleKeys (Auto-Generated)

Type-safe constants generated from your en.json:

class LocaleKeys {
  static String get appName => 'app_name'.tr();
  static String get welcome => 'welcome'.tr();
  static String get greeting => 'greeting'.tr();
  // ... all your keys
}

Usage:

// Use directly (recommended)
Text(LocaleKeys.appName)

// Or use string keys directly
Text('app_name'.tr())

🔧 Troubleshooting

Q: Translation failed with timeout error?

• A: The free API may be rate-limited. Wait a moment and try again. The package has automatic retry logic.

Q: Some translations look wrong?

• A: Auto-translation is good but not perfect. Review and edit generated JSON files manually for production apps.

Q: Can I edit generated translations?

• A: Yes! Edit the generated ar.json, fr.json, etc. files directly. Re-running the CLI won't overwrite them unless you delete them first.

Q: Do I need an API key?

• A: No! Localingo is 100% free with no API keys required.

🤝 Contributing

We welcome contributions from developers around the world! 🌍

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📞 Support & Community

• 💼 LinkedIn – Connect with the creator
• ▶️ YouTube – Developer Youtube Channel

⭐ Support Localingo

Enjoying Localingo?
Click the link below and tap the 👍 LIKE button on pub.dev — it really helps!

👉 https://pub.dev/packages/Localingo

---

Made with ❤️ in Egypt 🇪🇬 | Spreading across the world 🌍

Breaking language barriers, one app at a time

⬆ Back to Top