@localey/dart

@localey/dart

Dart and Flutter Runtime SDK for Localey.

The @localey/dart package provides the runtime localization engine for Flutter applications. It facilitates efficient string lookups and interpolation within the Dart environment, maintaining a single source of truth for translations across platforms.

Initialization

The SDK should be initialized at the application entry point (typically the main() function).

import 'package:localey/localey.dart';

void main() {
  Localey.init(
    translations: {
      'common': {
        'confirm': 'OK',
        'cancel': 'Cancel'
      }
    }
  );
}

Runtime Global API

The Localey class provides a static interface for localization.

t(String key, [Map<String, dynamic>? params])

The primary method for resolving translation keys.

• Dot Notation: Supports hierarchical keys (e.g., auth.errors.invalid_password).
• Dynamic Parameters: Supports variable replacement within strings using curly brace syntax (e.g., Hello {user}).

Example Usage in a Widget

Text(Localey.t("common.confirm"))

Features and Integration

• Dart Implementation: Pure Dart implementation with no platform-specific dependencies.
• Nested Object Support: Deeply nested JSON structures are resolved recursively.
• Performance: Optimized for the Flutter build cycle to ensure minimal impact on frame rendering times.