oktoast

To use oktoast in your Flutter project, follow these steps:

1. Add the dependency to your pubspec.yaml:

   flutter pub add oktoast

2. Import the library in your Dart files:

   import 'package:oktoast/oktoast.dart';

3. Wrap your app widget with OKToast. This ensures toasts are displayed in front of all other controls and allows the library to cache context so you can call toast methods anywhere without passing a BuildContext.

Important: Handling No MediaQuery widget found errors If you encounter this error, wrap the MaterialApp builder instead of wrapping the MaterialApp itself:

MaterialApp(
  builder: (BuildContext context, Widget? widget) {
    return OKToast(child: widget);
  },
);

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

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return OKToast(
      child: MaterialApp(
        home: MyHomePage(),
      ),
    );
  }
}

The OKToast widget accepts several parameters to define the default style and behavior for all toasts in your application.

Use the showToast method to display a simple text message.

Parameters:

• msg (String, required): The text to display.
• context (BuildContext, optional): The context for the toast.
• duration (Duration, optional): How long the toast stays visible.
• position (ToastPosition, optional): Where to show the toast (e.g., ToastPosition.top, ToastPosition.bottom).
• textStyle (TextStyle, optional): Style for the toast text.
• textPadding (EdgeInsetsGeometry, optional): Outer margin of the text.
• backgroundColor (Color, optional): Background color of the toast.
• radius (double, optional): Corner radius of the toast.
• onDismiss (Function, optional): Callback triggered when the toast is dismissed.
• textDirection (TextDirection, optional): Text direction.
• dismissOtherToast (bool, optional): If true, dismisses other active toasts.
• textAlign (TextAlign, optional): Text alignment when wrapping.
• animationBuilder (OKToastAnimationBuilder, optional): Custom animation.
• animationDuration (Duration, optional): Duration of the animation.
• animationCurve (Curve, optional): Curve of the animation.

Returns a ToastFuture which can be used to manually dismiss the toast.

showToast(
  "$_counter",
  duration: Duration(seconds: 2),
  position: ToastPosition.bottom,
  backgroundColor: Colors.black.withOpacity(0.8),
  radius: 13.0,
  textStyle: TextStyle(fontSize: 18.0),
);

Use showToastWidget to display any custom Flutter widget as a toast.

Parameters:

• widget (Widget, required): The widget you want to display.
• context (BuildContext, optional): The context for the toast.
• duration (Duration, optional): How long the toast stays visible.
• position (ToastPosition, optional): Where to show the toast.
• onDismiss (Function, optional): Callback triggered when the toast is dismissed.
• dismissOtherToast (bool, optional): If true, dismisses other active toasts.
• textDirection (TextDirection, optional): Text direction.
• handleTouch (bool, optional): If true, the toast can respond to touch events.
• animationBuilder (OKToastAnimationBuilder, optional): Custom animation.
• animationDuration (Duration, optional): Duration of the animation.
• animationCurve (Curve, optional): Curve of the animation.

Returns a ToastFuture which can be used to manually dismiss the toast.

ToastFuture toastFuture = showToastWidget(
  Text('hello oktoast'),
  duration: Duration(seconds: 3),
  onDismiss: () {
    print("the toast dismiss");
  },
);

// To dismiss manually:
toastFuture.dismiss();

The ToastTheme class allows you to customize the visual style and behavior of all toasts in your application. It is implemented as an InheritedWidget, meaning you can provide a custom theme higher up in your widget tree to affect all subsequent showToast calls.

Key customization properties include:

• textStyle: The TextStyle for the toast text.
• backgroundColor: The background color of the toast (defaults to Colors.black).
• radius: The corner radius of the toast.
• position: The ToastPosition where the toast appears.
• duration: How long the toast remains visible.
• animationBuilder, animationDuration, and animationCurve: Controls the entry/exit animations.
• dismissOtherOnShow: If true, showing a new toast will dismiss any currently visible toast (defaults to true).
• textPadding, textAlign, textMaxLines, and textOverflow: Controls the layout and styling of the text content.

ToastTheme(
  textStyle: TextStyle(color: Colors.white, fontSize: 14),
  textDirection: TextDirection.ltr,
  handleTouch: true,
  radius: 10.0,
  position: ToastPosition.bottom,
  backgroundColor: Colors.blueAccent,
  duration: Duration(seconds: 2),
  child: YourApp(),
);

The OKToast widget accepts several properties to customize the global toast theme. These settings are passed down to the ToastTheme and apply to all subsequent toast calls.

```dart
const OKToast({
  super.key,
  required this.child,
  this.textStyle,
  this.radius = 10.0,
  this.position = ToastPosition.center,
  this.textDirection = TextDirection.ltr,
  this.dismissOtherOnShow = false,
  this.movingOnWindowChange = true,
  Color? backgroundColor,
  this.textPadding,
  this.textAlign,
  this.handleTouch = false,
  this.animationBuilder,
  this.animationDuration = _defaultAnimDuration,
  this.animationCurve,
  this.duration,
});