Updated documentation

This commit is contained in:
2026-04-19 15:25:22 +02:00
parent 32e1c587d4
commit 2ad3698067
2 changed files with 17 additions and 12 deletions

View File

@@ -5,22 +5,24 @@ class AnimatedDialogButton extends StatefulWidget {
/// A custom animated button widget that provides a scaling and opacity effect
/// when pressed.
/// - [onPressed]: Callback function that is triggered when the button is pressed.
/// - [child]: The child widget to be displayed inside the button, typically a text or icon.
/// - [buttonText]: The text to be displayed on the button.
/// - [buttonType]: The type of the button, which determines its styling.
const AnimatedDialogButton({
super.key,
required this.onPressed,
required this.text,
required this.buttonText,
this.constraints,
this.buttonType = ButtonType.primary,
});
/// Callback function that is triggered when the button is pressed.
final VoidCallback onPressed;
/// The text to be displayed on the button.
final String text;
final BoxConstraints? constraints;
final ButtonType buttonType;
final String buttonText;
final VoidCallback onPressed;
@override
State<AnimatedDialogButton> createState() => _AnimatedDialogButtonState();
}
@@ -66,12 +68,12 @@ class _AnimatedDialogButtonState extends State<AnimatedDialogButton> {
duration: const Duration(milliseconds: 100),
child: Center(
child: Container(
constraints: const BoxConstraints(minWidth: 300),
constraints: widget.constraints,
decoration: buttonDecoration,
padding: const EdgeInsets.symmetric(horizontal: 16, vertical: 12),
margin: const EdgeInsets.symmetric(vertical: 8),
child: Text(
widget.text,
widget.buttonText,
style: textStyling,
textAlign: TextAlign.center,
),

View File

@@ -3,6 +3,10 @@ import 'package:tallee/core/enums.dart';
import 'package:tallee/presentation/widgets/dialog/animated_dialog_button.dart';
class CustomDialogAction extends StatelessWidget {
/// A custom dialog action widget that represents a button in a dialog.
/// - [text]: The text to be displayed on the button.
/// - [buttonType]: The type of the button, which determines its styling.
/// - [onPressed]: Callback function that is triggered when the button is pressed.
const CustomDialogAction({
super.key,
required this.onPressed,
@@ -10,10 +14,8 @@ class CustomDialogAction extends StatelessWidget {
this.buttonType = ButtonType.primary,
});
// The text displaed on the button
final String text;
// The type of the button, which determines its styling
final ButtonType buttonType;
final VoidCallback onPressed;
@@ -22,8 +24,9 @@ class CustomDialogAction extends StatelessWidget {
Widget build(BuildContext context) {
return AnimatedDialogButton(
onPressed: onPressed,
text: text,
buttonText: text,
buttonType: buttonType,
constraints: const BoxConstraints(minWidth: 300),
);
}
}