Skip to content

Add frame builder, add possibility to smoothly change placeholder to RawPicture #822

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add frame builder, add possibility to smoothly change placeholder to RawPicture #822

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions lib/svg.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,14 @@ Future<void> precachePicture(
return completer.future;
}

/// Signature used by [SvgPicture.frameBuilder] to control the widget that will be
/// used when an [SvgPicture] is built.
typedef PictureFrameBuilder = Widget Function(
BuildContext context,
Widget child,
PictureInfo? pictureInfo,
);

/// A widget that will parse SVG data into a [Picture] using a [PictureProvider].
///
/// The picture will be cached using the [PictureCache], incorporating any color
Expand Down Expand Up @@ -237,6 +245,7 @@ class SvgPicture extends StatefulWidget {
this.alignment = Alignment.center,
this.matchTextDirection = false,
this.allowDrawingOutsideViewBox = false,
this.frameBuilder,
this.placeholderBuilder,
this.colorFilter,
this.semanticsLabel,
Expand Down Expand Up @@ -337,6 +346,7 @@ class SvgPicture extends StatefulWidget {
this.fit = BoxFit.contain,
this.alignment = Alignment.center,
this.allowDrawingOutsideViewBox = false,
this.frameBuilder,
this.placeholderBuilder,
Color? color,
BlendMode colorBlendMode = BlendMode.srcIn,
Expand Down Expand Up @@ -401,6 +411,7 @@ class SvgPicture extends StatefulWidget {
this.alignment = Alignment.center,
this.matchTextDirection = false,
this.allowDrawingOutsideViewBox = false,
this.frameBuilder,
this.placeholderBuilder,
Color? color,
BlendMode colorBlendMode = BlendMode.srcIn,
Expand Down Expand Up @@ -461,6 +472,7 @@ class SvgPicture extends StatefulWidget {
this.alignment = Alignment.center,
this.matchTextDirection = false,
this.allowDrawingOutsideViewBox = false,
this.frameBuilder,
this.placeholderBuilder,
Color? color,
BlendMode colorBlendMode = BlendMode.srcIn,
Expand Down Expand Up @@ -517,6 +529,7 @@ class SvgPicture extends StatefulWidget {
this.alignment = Alignment.center,
this.matchTextDirection = false,
this.allowDrawingOutsideViewBox = false,
this.frameBuilder,
this.placeholderBuilder,
Color? color,
BlendMode colorBlendMode = BlendMode.srcIn,
Expand Down Expand Up @@ -573,6 +586,7 @@ class SvgPicture extends StatefulWidget {
this.alignment = Alignment.center,
this.matchTextDirection = false,
this.allowDrawingOutsideViewBox = false,
this.frameBuilder,
this.placeholderBuilder,
Color? color,
BlendMode colorBlendMode = BlendMode.srcIn,
Expand Down Expand Up @@ -687,6 +701,9 @@ class SvgPicture extends StatefulWidget {
/// The [PictureProvider] used to resolve the SVG.
final PictureProvider pictureProvider;

/// A builder function responsible for creating the widget that represents this picture.
final PictureFrameBuilder? frameBuilder;

/// The placeholder to use while fetching, decoding, and parsing the SVG data.
final WidgetBuilder? placeholderBuilder;

Expand Down Expand Up @@ -908,6 +925,12 @@ class _SvgPictureState extends State<SvgPicture> {
? _getDefaultPlaceholder(context, widget.width, widget.height)
: widget.placeholderBuilder!(context);
}

final PictureFrameBuilder? frameBuilder = widget.frameBuilder;
if (frameBuilder != null) {
child = frameBuilder.call(context, child, _picture);
}

if (!widget.excludeFromSemantics) {
child = Semantics(
container: widget.semanticsLabel != null,
Expand Down