WidgetTester class Null safety

Class that programmatically interacts with widgets and the test environment.

For convenience, instances of this class (such as the one provided by testWidgets) can be used as the vsync for AnimationController objects.

Inheritance
Implemented types

Properties

allElements Iterable<Element>
All elements currently in the widget tree (lazy pre-order traversal). [...]
read-only, inherited
allRenderObjects Iterable<RenderObject>
Render objects of all the widgets currently in the widget tree (lazy pre-order traversal). [...]
read-only, inherited
allStates Iterable<State<StatefulWidget>>
All states currently in the widget tree (lazy pre-order traversal). [...]
read-only, inherited
allWidgets Iterable<Widget>
All widgets currently in the widget tree (lazy pre-order traversal). [...]
read-only, inherited
binding TestWidgetsFlutterBinding
The binding instance used by the testing framework.
read-only, override
hashCode int
The hash code for this object. [...]
read-only, inherited
hasRunningAnimations bool
Whether there are any transient callbacks scheduled. [...]
read-only
layers List<Layer>
Returns a list of all the Layer objects in the rendering.
read-only, inherited
nextPointer int
The next available pointer identifier. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
testDescription String
The description string of the test currently being run.
read-only
testTextInput TestTextInput
Returns the TestTextInput singleton. [...]
read-only

Methods

any(Finder finder) bool
Checks if finder exists in the tree.
inherited
createGesture({int? pointer, PointerDeviceKind kind = PointerDeviceKind.touch, int buttons = kPrimaryButton}) Future<TestGesture>
Creates gesture and returns the TestGesture object which you can use to continue the gesture using calls on the TestGesture object. [...]
inherited
createTicker(TickerCallback onTick) Ticker
Creates a ticker with the given callback. [...]
override
dispatchEvent(PointerEvent event, HitTestResult result) → void
Handler for device events caught by the binding in live test mode.
override
drag(Finder finder, Offset offset, {int? pointer, int buttons = kPrimaryButton, double touchSlopX = kDragSlopDefault, double touchSlopY = kDragSlopDefault, bool warnIfMissed = true, PointerDeviceKind kind = PointerDeviceKind.touch}) Future<void>
Attempts to drag the given widget by the given offset, by starting a drag in the middle of the widget. [...]
inherited
dragFrom(Offset startLocation, Offset offset, {int? pointer, int buttons = kPrimaryButton, double touchSlopX = kDragSlopDefault, double touchSlopY = kDragSlopDefault, PointerDeviceKind kind = PointerDeviceKind.touch}) Future<void>
Attempts a drag gesture consisting of a pointer down, a move by the given offset, and a pointer up. [...]
inherited
dragUntilVisible(Finder finder, Finder view, Offset moveStep, {int maxIteration = 50, Duration duration = const Duration(milliseconds: 50)}) Future<void>
Repeatedly drags view by moveStep until finder is visible. [...]
inherited
element<T extends Element>(Finder finder) → T
The matching element in the widget tree. [...]
inherited
elementList<T extends Element>(Finder finder) Iterable<T>
The matching elements in the widget tree. [...]
inherited
ensureSemantics() SemanticsHandle
Enable semantics in a test by creating a SemanticsHandle. [...]
inherited
ensureVisible(Finder finder) Future<void>
Given a widget W specified by finder and a Scrollable widget S in its ancestry tree, this scrolls S so as to make W visible. [...]
inherited
enterText(Finder finder, String text) Future<void>
Give the text input widget specified by finder the focus and replace its content with text, as if it had been provided by the onscreen keyboard. [...]
firstElement<T extends Element>(Finder finder) → T
The first matching element according to a depth-first pre-order traversal of the widget tree. [...]
inherited
firstRenderObject<T extends RenderObject>(Finder finder) → T
The render object of the first matching widget according to a depth-first pre-order traversal of the widget tree. [...]
inherited
firstState<T extends State<StatefulWidget>>(Finder finder) → T
The first matching state according to a depth-first pre-order traversal of the widget tree. [...]
inherited
firstWidget<T extends Widget>(Finder finder) → T
The first matching widget according to a depth-first pre-order traversal of the widget tree. [...]
inherited
fling(Finder finder, Offset offset, double speed, {int? pointer, int buttons = kPrimaryButton, Duration frameInterval = const Duration(milliseconds: 16), Offset initialOffset = Offset.zero, Duration initialOffsetDelay = const Duration(seconds: 1), bool warnIfMissed = true}) Future<void>
Attempts a fling gesture starting from the center of the given widget, moving the given distance, reaching the given speed. [...]
inherited
flingFrom(Offset startLocation, Offset offset, double speed, {int? pointer, int buttons = kPrimaryButton, Duration frameInterval = const Duration(milliseconds: 16), Offset initialOffset = Offset.zero, Duration initialOffsetDelay = const Duration(seconds: 1)}) Future<void>
Attempts a fling gesture starting from the given location, moving the given distance, reaching the given speed. [...]
inherited
getBottomLeft(Finder finder, {bool warnIfMissed = false, String callee = 'getBottomLeft'}) Offset
Returns the point at the bottom left of the given widget. This point is not inside the object's hit test area. [...]
inherited
getBottomRight(Finder finder, {bool warnIfMissed = false, String callee = 'getBottomRight'}) Offset
Returns the point at the bottom right of the given widget. This point is not inside the object's hit test area. [...]
inherited
getCenter(Finder finder, {bool warnIfMissed = false, String callee = 'getCenter'}) Offset
Returns the point at the center of the given widget. [...]
inherited
getRect(Finder finder) Rect
Returns the rect of the given widget. This is only valid once the widget's render object has been laid out at least once.
inherited
getRestorationData() Future<TestRestorationData>
Retrieves the current restoration data from the RestorationManager. [...]
getSemantics(Finder finder) SemanticsNode
Attempts to find the SemanticsNode of first result from finder. [...]
inherited
getSize(Finder finder) Size
Returns the size of the given widget. This is only valid once the widget's render object has been laid out at least once.
inherited
getTopLeft(Finder finder, {bool warnIfMissed = false, String callee = 'getTopLeft'}) Offset
Returns the point at the top left of the given widget. [...]
inherited
getTopRight(Finder finder, {bool warnIfMissed = false, String callee = 'getTopRight'}) Offset
Returns the point at the top right of the given widget. This point is not inside the object's hit test area. [...]
inherited
handlePointerEventRecord(Iterable<PointerEventRecord> records) Future<List<Duration>>
A simulator of how the framework handles a series of PointerEvents received from the Flutter engine. [...]
override
hitTestOnBinding(Offset location) HitTestResult
Forwards the given location to the binding's hitTest logic.
override
idle() Future<void>
Acts as if the application went idle. [...]
longPress(Finder finder, {int? pointer, int buttons = kPrimaryButton, bool warnIfMissed = true}) Future<void>
Dispatch a pointer down / pointer up sequence (with a delay of kLongPressTimeout + kPressTimeout between the two events) at the center of the given widget, assuming it is exposed. [...]
inherited
longPressAt(Offset location, {int? pointer, int buttons = kPrimaryButton}) Future<void>
Dispatch a pointer down / pointer up sequence at the given location with a delay of kLongPressTimeout + kPressTimeout between the two events.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
pageBack() Future<void>
Makes an effort to dismiss the current page with a Material Scaffold or a CupertinoPageScaffold. [...]
press(Finder finder, {int? pointer, int buttons = kPrimaryButton, bool warnIfMissed = true}) Future<TestGesture>
Dispatch a pointer down at the center of the given widget, assuming it is exposed. [...]
inherited
printToConsole(String message) → void
Calls debugPrint with the given message. [...]
override
pump([Duration? duration, EnginePhase phase = EnginePhase.sendSemanticsUpdate]) Future<void>
Triggers a frame after duration amount of time. [...]
override
pumpAndSettle([Duration duration = const Duration(milliseconds: 100), EnginePhase phase = EnginePhase.sendSemanticsUpdate, Duration timeout = const Duration(minutes: 10)]) Future<int>
Repeatedly calls pump with the given duration until there are no longer any frames scheduled. This will call pump at least once, even if no frames are scheduled when the function is called, to flush any pending microtasks which may themselves schedule a frame. [...]
override
pumpBenchmark(Duration duration) Future<void>
Triggers a frame after duration amount of time, return as soon as the frame is drawn. [...]
pumpFrames(Widget target, Duration maxDuration, [Duration interval = const Duration(milliseconds: 16, microseconds: 683)]) Future<void>
Repeatedly pump frames that render the target widget with a fixed time interval as many as maxDuration allows. [...]
pumpWidget(Widget widget, [Duration? duration, EnginePhase phase = EnginePhase.sendSemanticsUpdate]) Future<void>
Renders the UI from the given widget. [...]
renderObject<T extends RenderObject>(Finder finder) → T
The render object of the matching widget in the widget tree. [...]
inherited
renderObjectList<T extends RenderObject>(Finder finder) Iterable<T>
The render objects of the matching widgets in the widget tree. [...]
inherited
restartAndRestore() Future<void>
Simulates restoring the state of the widget tree after the application is restarted. [...]
restoreFrom(TestRestorationData data) Future<void>
Restores the widget tree under test to the state described by the provided TestRestorationData. [...]
runAsync<T>(Future<T> callback(), {Duration additionalTime = const Duration(milliseconds: 1000)}) Future<T?>
Runs a callback that performs real asynchronous work. [...]
scrollUntilVisible(Finder finder, double delta, {Finder? scrollable, int maxScrolls = 50, Duration duration = const Duration(milliseconds: 50)}) Future<void>
Repeatedly scrolls a Scrollable by delta in the Scrollable.axisDirection direction until a widget matching finder is visible. [...]
inherited
sendEventToBinding(PointerEvent event) Future<void>
Forwards the given pointer event to the binding.
override
sendKeyDownEvent(LogicalKeyboardKey key, {String? character, String platform = _defaultPlatform}) Future<bool>
Simulates sending a physical key down event. [...]
inherited
sendKeyEvent(LogicalKeyboardKey key, {String platform = _defaultPlatform}) Future<bool>
Simulates sending physical key down and up events. [...]
inherited
sendKeyRepeatEvent(LogicalKeyboardKey key, {String? character, String platform = _defaultPlatform}) Future<bool>
Simulates sending a physical key repeat event. [...]
inherited
sendKeyUpEvent(LogicalKeyboardKey key, {String platform = _defaultPlatform}) Future<bool>
Simulates sending a physical key up event through the system channel. [...]
inherited
showKeyboard(Finder finder) Future<void>
Give the text input widget specified by finder the focus, as if the onscreen keyboard had appeared. [...]
startGesture(Offset downLocation, {int? pointer, PointerDeviceKind kind = PointerDeviceKind.touch, int buttons = kPrimaryButton}) Future<TestGesture>
Creates a gesture with an initial down gesture at a particular point, and returns the TestGesture object which you can use to continue the gesture. [...]
inherited
state<T extends State<StatefulWidget>>(Finder finder) → T
The matching state in the widget tree. [...]
inherited
stateList<T extends State<StatefulWidget>>(Finder finder) Iterable<T>
The matching states in the widget tree. [...]
inherited
takeException() → dynamic
Returns the exception most recently caught by the Flutter framework. [...]
tap(Finder finder, {int? pointer, int buttons = kPrimaryButton, bool warnIfMissed = true}) Future<void>
Dispatch a pointer down / pointer up sequence at the center of the given widget, assuming it is exposed. [...]
inherited
tapAt(Offset location, {int? pointer, int buttons = kPrimaryButton}) Future<void>
Dispatch a pointer down / pointer up sequence at the given location.
inherited
timedDrag(Finder finder, Offset offset, Duration duration, {int? pointer, int buttons = kPrimaryButton, double frequency = 60.0, bool warnIfMissed = true}) Future<void>
Attempts to drag the given widget by the given offset in the duration time, starting in the middle of the widget. [...]
inherited
timedDragFrom(Offset startLocation, Offset offset, Duration duration, {int? pointer, int buttons = kPrimaryButton, double frequency = 60.0}) Future<void>
Attempts a series of PointerEvents to simulate a drag operation in the duration time. [...]
inherited
toString() String
A string representation of this object. [...]
inherited
verifyTickersWereDisposed([String when = 'when none should have been']) → void
Throws an exception if any tickers created by the WidgetTester are still active when the method is called. [...]
widget<T extends Widget>(Finder finder) → T
The matching widget in the widget tree. [...]
inherited
widgetList<T extends Widget>(Finder finder) Iterable<T>
The matching widgets in the widget tree. [...]
inherited

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited