Base URL Switcher #

A beautiful and easy-to-use Flutter package for switching between base URLs with a stunning UI switcher.

Features #

🚀 Ultra Simple Usage - Just wrap your widget, that's it!
🔐 Hidden Access - Tap multiple times to access settings
🔒 Password Protection - Secure access with customizable password
🎨 Beautiful UI Switcher - Elegant environment switcher widget
📱 Ready-to-Use Screen - Complete settings page included
🔧 Easy Configuration - Simple setup with default environments
💾 Persistent Storage - Remembers your environment choice
🎯 Type Safety - Full type safety with Dart
🧪 Well Tested - Comprehensive test coverage
📱 Responsive Design - Works on all screen sizes
🚀 Lightweight - Minimal dependencies

Installation #

Add this to your package's pubspec.yaml file:

dependencies:
  base_url_switcher: ^1.0.0

Then run:

flutter pub get

Quick Start #

1. Initialize the Service #

import 'package:base_url_switcher/base_url_switcher.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  
  // Initialize the EnvService
  await EnvService.initialize();
  
  runApp(MyApp());
}

2. Use the Ready-to-Use Screen (Easiest Way) #

import 'package:base_url_switcher/base_url_switcher.dart';

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('My App'),
          actions: [
            // زر للذهاب إلى صفحة تبديل البيئات
            IconButton(
              icon: Icon(Icons.settings),
              onPressed: () {
                Navigator.push(
                  context,
                  MaterialPageRoute(
                    builder: (context) => EnvSwitcherScreen(
                      title: 'Environment Settings',
                      icon: Icons.swap_horiz,
                      primaryColor: Colors.blue,
                      onEnvironmentChanged: (env) {
                        print('Switched to ${env.name}');
                      },
                    ),
                  ),
                );
              },
            ),
          ],
        ),
        body: MyHomePage(),
      ),
    );
  }
}

3. Access Current Base URL (Super Easy) #

import 'package:base_url_switcher/base_url_switcher.dart';

// الحصول على الـ Base URL الحالي
final currentUrl = BaseUrlManager.instance.currentBaseUrl;
print('Current Base URL: $currentUrl');

// الحصول على اسم البيئة الحالية
final envName = BaseUrlManager.instance.currentEnvironmentName;
print('Current Environment: $envName');

// استخدام الـ URL في API calls
final response = await http.get(
  Uri.parse('${BaseUrlManager.instance.currentBaseUrl}/api/users'),
);

4. Use the Widget (Alternative) #

import 'package:base_url_switcher/base_url_switcher.dart';

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('My App'),
          actions: [
            // Add environment switcher to app bar
            EnvSwitcher(
              onEnvironmentChanged: (env) {
                print('Switched to ${env.name}');
              },
            ),
          ],
        ),
        body: MyHomePage(),
      ),
    );
  }
}

Default Environments #

The package comes with three default environments:

Development - https://dev-api.example.com
Staging - https://staging-api.example.com
Production - https://api.example.com

🚀 Ultra Simple Usage (Recommended) #

Just Wrap Your Widget - That's It! #

import 'package:base_url_switcher/base_url_switcher.dart';

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('My App')),
        body: SimpleBaseUrlWrapper(
          // فقط wrap الـ body - الباقي تلقائي!
          child: YourWidget(),
        ),
      ),
    );
  }
}

How It Works: #

Wrap your widget with SimpleBaseUrlWrapper
Tap anywhere 7 times quickly to access settings
Enter password (default: "admin")
Change environment and use the new Base URL

Customize Access: #

SimpleBaseUrlWrapper(
  password: "myapp123", // باسورد مخصص
  tapCount: 5, // 5 ضغطات بدلاً من 7
  child: YourWidget(),
)

Show Current Environment: #

AppBar(
  title: Text('My App'),
  actions: [
    EnvironmentIndicator(), // مؤشر البيئة الحالية
  ],
)

Get Base URL Anywhere: #

// في أي مكان في التطبيق
final url = BaseUrlManager.instance.currentBaseUrl;
final response = await http.get(Uri.parse('$url/api/users'));

Alternative Usage #

Add Settings Screen Manually #

// في أي مكان في التطبيق
Navigator.push(
  context,
  MaterialPageRoute(
    builder: (context) => EnvSwitcherScreen(),
  ),
);

Set Your Own Default Base URL #

// في main() قبل runApp()
await EnvService.initialize();

// إضافة بيئة مخصصة كافتراضي
final customEnv = BaseUrlManager.createDevelopmentEnv(
  baseUrl: 'https://your-api.com',
  description: 'Your custom API',
);

await BaseUrlManager.instance.addEnvironment(customEnv);
await BaseUrlManager.instance.setEnvironment('Development');

Customization #

Custom Environments #

final envService = EnvService.instance;

// Add custom environment
const customEnv = Environment(
  name: 'Custom',
  baseUrl: 'https://custom-api.com',
  description: 'Custom environment for testing',
  config: {
    'timeout': 30,
    'retries': 3,
  },
);

await envService.addEnvironment(customEnv);

Custom Styling #

EnvSwitcher(
  style: EnvSwitcherStyle(
    backgroundColor: Colors.blue,
    iconColor: Colors.white,
    borderRadius: BorderRadius.circular(12),
    elevation: 4,
    titleTextStyle: TextStyle(
      color: Colors.white,
      fontWeight: FontWeight.bold,
    ),
  ),
  onEnvironmentChanged: (env) {
    // Handle environment change
  },
)

Environment Configuration #

// Set configuration values
await envService.setConfigValue('api_key', 'your-api-key');
await envService.setConfigValue('timeout', 30);

// Get configuration values
final apiKey = envService.getConfigValue<String>('api_key');
final timeout = envService.getConfigValue<int>('timeout');

Advanced Usage #

Programmatic Environment Switching #

// Switch environment programmatically
await envService.setEnvironment('staging');

// Get specific environment
final stagingEnv = envService.getEnvironment('staging');

// Check if environment exists
if (envService.hasEnvironment('custom')) {
  // Do something
}

Environment Management #

// Update existing environment
const updatedEnv = Environment(
  name: 'development',
  baseUrl: 'https://new-dev-api.com',
  description: 'Updated development environment',
);

await envService.updateEnvironment('development', updatedEnv);

// Remove environment
await envService.removeEnvironment('old-environment');

// Reset to defaults
await envService.resetToDefaults();

Show in Release Mode #

By default, the environment switcher only shows in debug mode. To show it in release mode:

EnvSwitcher(
  showInRelease: true, // Show in release mode
  onEnvironmentChanged: (env) {
    // Handle environment change
  },
)

API Reference #

Environment Class #

class Environment {
  final String name;           // Environment name
  final String baseUrl;        // Base URL for API calls
  final Map<String, dynamic> config;  // Additional configuration
  final bool isDefault;        // Whether this is the default environment
  final String? description;   // Optional description
}

EnvService Class #

class EnvService {
  // Singleton instance
  static EnvService get instance;
  
  // Initialize the service
  static Future<void> initialize();
  
  // Environment management
  Map<String, Environment> get environments;
  Environment get currentEnvironment;
  Future<void> setEnvironment(String envName);
  
  // Environment CRUD operations
  Future<void> addEnvironment(Environment environment);
  Future<void> updateEnvironment(String envName, Environment environment);
  Future<void> removeEnvironment(String envName);
  
  // Utility methods
  Environment? getEnvironment(String envName);
  bool hasEnvironment(String envName);
  String get currentBaseUrl;
  String get currentEnvironmentName;
  
  // Configuration management
  T? getConfigValue<T>(String key);
  Future<void> setConfigValue(String key, dynamic value);
  
  // Data management
  Future<void> resetToDefaults();
  Future<void> clear();
}

EnvSwitcher Widget #

class EnvSwitcher extends StatefulWidget {
  final Function(Environment)? onEnvironmentChanged;
  final bool showInRelease;
  final EnvSwitcherStyle? style;
  final bool showDescriptions;
  final IconData? icon;
}

EnvSwitcherStyle Class #

class EnvSwitcherStyle {
  final EdgeInsets margin;
  final EdgeInsets padding;
  final Color backgroundColor;
  final Color iconColor;
  final double iconSize;
  final BorderRadius borderRadius;
  final Border? border;
  final double elevation;
  final TextStyle titleTextStyle;
  final TextStyle descriptionTextStyle;
  final TextStyle dialogTitleStyle;
}

SimpleBaseUrlWrapper Class #

class SimpleBaseUrlWrapper extends StatelessWidget {
  final Widget child;           // Widget to wrap
  final String? password;       // Password for access (default: "admin")
  final int? tapCount;         // Number of taps required (default: 7)
}

BaseUrlWrapper Class #

class BaseUrlWrapper extends StatefulWidget {
  final Widget child;                    // Widget to wrap
  final int tapCount;                    // Number of taps required
  final String password;                 // Password for access
  final String? settingsTitle;           // Settings screen title
  final IconData? settingsIcon;          // Settings screen icon
  final Color? primaryColor;             // Primary color
  final Function(Environment)? onEnvironmentChanged; // Callback
  final bool showInRelease;              // Show in release mode
}

EnvironmentIndicator Class #

class EnvironmentIndicator extends StatelessWidget {
  final Color? color;          // Indicator color
  final double? fontSize;      // Text size
}

EnvironmentInfo Class #

class EnvironmentInfo extends StatelessWidget {
  final bool showBaseUrl;      // Show base URL
  final bool showDescription;  // Show description
  final TextStyle? textStyle;  // Text style
}

Example App #

Check out the example app in the example/ directory to see the package in action.

cd example
flutter run

Testing #

Run the tests:

flutter test

Contributing #

Contributions are welcome! Please feel free to submit a Pull Request.

License #

This project is licensed under the MIT License - see the LICENSE file for details.

Support #

If you find this package helpful, please give it a ⭐ on pub.dev!

Changelog #

2.0.0 #

🚀 Ultra Simple Usage - Just wrap your widget with SimpleBaseUrlWrapper
🔐 Hidden Access - Tap multiple times to access settings
🔒 Password Protection - Secure access with customizable password
📱 Ready-to-Use Screen - Complete EnvSwitcherScreen included
🎯 Environment Indicator - Show current environment in UI
📊 Environment Info Widget - Display environment details
🔧 BaseUrlManager - Simplified API for accessing current Base URL
🎨 Enhanced UI - Beautiful and responsive design
📚 Comprehensive Examples - Multiple usage examples included

1.0.0 #

Initial release
Environment management with persistent storage
Beautiful UI switcher widget
Comprehensive test coverage
Full documentation

Made with ❤️ for the Flutter community

base_url_switcher 2.0.0 base_url_switcher: ^2.0.0 copied to clipboard

Metadata