Skip to content

allow targeting specific/root overlay for rendering guides #34

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
Yegair wants to merge 1 commit into
base: master
Choose a base branch
from
Open

allow targeting specific/root overlay for rendering guides #34

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
27 changes: 24 additions & 3 deletions lib/flutter_intro.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ class Intro extends InheritedWidget {
static const bool defaultAnimate = false;
static const Duration defaultAnimationDuration = Duration(milliseconds: 300);
static const bool defaultMaskClosable = false;
static const bool defaultUseRootOverlay = false;

final List<String> _finishedGroups = [];

Expand Down Expand Up @@ -73,6 +74,13 @@ class Intro extends InheritedWidget {
/// [bool] for whether the mask can be closed (default false)
final bool maskClosable;

/// [bool] for whether to use the root overlay (default false)
final bool useRootOverlay;

/// The overlay that should be used to display the intro steps.
/// If not provided, the overlay of the context will be used.
final OverlayState? overlay;

/// [ValueNotifier] of [IntroStatus], which can be used with
/// [ValueListenableBuilder] for instant UI updates. See readme for example.
/// Default is not open.
Expand Down Expand Up @@ -100,6 +108,8 @@ class Intro extends InheritedWidget {
this.maskColor = defaultMaskColor,
this.noAnimation = defaultAnimate,
this.maskClosable = defaultMaskClosable,
this.useRootOverlay = defaultUseRootOverlay,
this.overlay,
this.buttonBuilder,
@Deprecated(
'Use [buttonBuilder] instead'
Expand Down Expand Up @@ -254,6 +264,8 @@ class Intro extends InheritedWidget {
);
}

final renderOverlay = overlay?.context.findRenderObject();

RenderBox renderBox = currentContext.findRenderObject() as RenderBox;

_screenSize = MediaQuery.of(_context!).size;
Expand All @@ -262,9 +274,9 @@ class Intro extends InheritedWidget {
renderBox.size.height + (step.padding?.vertical ?? padding.vertical),
);
_widgetOffset = Offset(
renderBox.localToGlobal(Offset.zero).dx -
renderBox.localToGlobal(Offset.zero, ancestor: renderOverlay).dx -
(step.padding?.left ?? padding.left),
renderBox.localToGlobal(Offset.zero).dy -
renderBox.localToGlobal(Offset.zero, ancestor: renderOverlay).dy -
(step.padding?.top ?? padding.top),
);

Expand Down Expand Up @@ -432,7 +444,16 @@ class Intro extends InheritedWidget {
);
},
));
Overlay.of(_context!).insert(_overlayEntry!);

final OverlayState overlayState;

if (overlay != null) {
overlayState = overlay!;
} else {
overlayState = Overlay.of(_context!, rootOverlay: useRootOverlay);
}

overlayState.insert(_overlayEntry!);
}

/// Begin the intro for [group] (default is `default`). If the group has
Expand Down