Wiredash SDK Documentation

Wasm builds require specific COOP/COEP headers to support SharedArrayBuffer. Use the provided serve.py script to host the build with the necessary headers.

1. Build the project: ../../wiresdk flutter build web --wasm --strip-wasm
2. Start the server: python3 serve.py 8123
3. Access the app at http://127.0.0.1:8123/

To initialize the Wiredash SDK, wrap your application's root widget with the Wiredash widget. You must provide your projectId and SDK secret, which can be found in the Wiredash Console under Your project > Settings > General Settings.

The Wiredash widget can wrap any root widget, such as MaterialApp or WidgetsApp.

import 'package:flutter/material.dart';
import 'package:wiredash/wiredash.dart';

class MyApp extends StatelessWidget {

  @override
  Widget build(BuildContext context) {
    return Wiredash(
      projectId: 'YOUR-PROJECT-ID',
      secret: 'YOUR-SECRET',
      child: MaterialApp(
        // Your Flutter app is basically Wiredash's direct child.
      ),
    );
  }
}

After modifying .arb files in lib/assets/l10n/, you must run the localization tool to convert them into Dart code.

./tool/localize.sh

To start using Wiredash, wrap your application's root widget with the Wiredash widget. You must provide your projectId and SDK secret, which can be found in the Wiredash Console under Your project > Settings > General Settings.

The Wiredash widget can wrap any root widget, such as MaterialApp or WidgetsApp.

import 'package:flutter/material.dart';
import 'package:wiredash/wiredash.dart';

class MyApp extends StatelessWidget {

  @override
  Widget build(BuildContext context) {
    return Wiredash(
      projectId: 'YOUR-PROJECT-ID',
      secret: 'YOUR-SECRET',
      child: MaterialApp(
        // Your Flutter app is basically Wiredash's direct child.
      ),
    );
  }
}

To add Wiredash to your Flutter project, use the flutter pub add command or manually add it to your pubspec.yaml file.

Run the following command in your terminal:

flutter pub add wiredash:^2.7.0

Alternatively, update your pubspec.yaml dependencies:

dependencies:
  flutter:
    sdk: flutter
  ...
  wiredash: ^2.7.0

To change the launch screen image in the iOS version of the example project, you can either replace the image files directly in the LaunchImage.imageset directory or use Xcode to manage the assets.

Method 1: Direct File Replacement Replace the existing image files within the examples/localization/ios/Runner/Assets.xcassets/LaunchImage.imageset/ directory with your own assets.

Method 2: Using Xcode

1. Open the iOS project workspace using the command: open ios/Runner.xcworkspace.
2. In the Xcode Project Navigator, navigate to Runner/Assets.xcassets.
3. Drag and drop your desired images into the asset catalog to replace the existing launch screen assets.

The Wiredash localization system allows you to customize the user experience by:

1. Overriding existing wording: Change the text used by built-in Wiredash components (e.g., button labels or headers).
2. Adding support for new languages: Extend the SDK to support languages not included by default.
3. Localizing labels: Ensure all user-facing strings are presented in the user's preferred language.

To implement this, you typically provide a custom localization implementation to the Wiredash widget configuration.

To update or add translations for an existing language:

1. Open the corresponding .arb file in lib/assets/l10n/.
2. Use lib/wiredash_en.arb as a template to identify all available translation keys.
3. Update the keys and values to your liking.

CRITICAL: Do not edit any .g.dart files manually; these are generated files.

To support a new language in the SDK, follow these steps:

1. Create a new language file in lib/assets/l10n/.
2. Export the new language file in lib/wiredash.dart to ensure developers can extend it.
3. Run the localization generation command to convert the .arb files into Dart code.

To verify that Wiredash and its dependencies are compatible with WebAssembly without relying on dart:html or dart:js fallbacks, use the --strip-wasm flag. This flag ensures that any non-wasm compatible code path results in a hard build error instead of a silent downgrade to JavaScript.

../../wiresdk flutter build web --wasm --strip-wasm

To confirm that the main.dart.wasm module is successfully loaded by the browser, you can check the Network tab in DevTools or run the following command in the browser console:

performance.getEntriesByType('resource').filter(r => r.name.endsWith('.wasm'))