Releases: passsy/spot
v0.10.0
High-level API changes
- Breaking
spotText('dash')
can now return multiple widgets - New:
.atLeast(n)
and.atMost(n)
and.amount(n)
to force the number of expected widgets.
.atMost(0)
can be used to test that a widget does not exist! - Deprecated:
spotSingle<W>()
is now deprecated. Usespot<W>()
instead, orspot<W>().atMost(1)
to indicate that only a single widget is expected. - Fix:
.first()
and.last()
- New:
.atIndex(n)
allows to get the widget at a specific index (when multiple are found) - Deprecate:
allWidgets
in favor ofspotAllWidgets()
to avoid conflicts with local variables - New:
getDiagnosticProp<T>('name')
for easy access to the values of a diagnostic property #40 - New:
hasEffectiveTextStyle
,withEffectiveTextStyleMatching()
,withEffectiveTextStyle()
#36, #38 - Improve:
WidgetSelector.toString()
has been improved, has now separators for stages and adds braces.
Example:Center with child SizedBox ❯ with parent (Scaffold ᗕ Row)
- Added tons of documentation and examples
Advanced API changes
Those changes can be breaking for packages that depend on spot
or advanced usages, but should not affect most users.
- Breaking
WidgetSelector
now hasList<ElementFilter> stages
, replacing the previousprops
,parents
,children
andelementFilters
. - Breaking
WidgetSelector
constructor andcopyWith
signature changed, reflecting the new properties.
createElementFilters()
,createCandidateGenerator()
andtoStringWithoutParents()
have been removed. WidgetSelector
now has aquantityConstraint
property (deprecatesexpectedQuantity
) that allows setting themin
andmax
number of expected widgets.WidgetSelector
replacesSingleWidgetSelector
andMultiWidgetSelector
- Breaking Quantity assertions like
.doesNotExist()
or.existsOnce()
now returnWidgetMatcher
/MultiWidgetMatcher
instead ofWidgetSnapshot
.
To get theWidgetSnapshot
usesnapshot()
instead. - Breaking Remove
WidgetSelector.cast
because it lost information and was untested - Breaking
PropFilter
has been renamed toPredicateFilter
- Breaking
PredicateWithDescription
has been removed - Breaking
CandidateGenerator
has been removed - Explicitly export all classes/extensions/functions to prevent accidental leaks of internal APIs
v0.7.0
-
New prop API with
hasWidgetProp()
makes it easy to filter and assert properties of Widgets.
This replaces the oldhasProp()
method which was based on way to complicated package:checks context.// Old ⛈️ spotSingle<Checkbox>().existsOnce().hasProp( selector: (e) => e.context.nest( () => ['Checkbox', 'value'], (e) => Extracted.value((e.widget as Checkbox).value), ), match: (it) => it.equals(true), );
// New ✨ spotSingle<Checkbox>().existsOnce().hasWidgetProp( prop: widgetProp('value', (widget) => widget.value), match: (value) => value.isTrue(), );
The prop API is also available for
Element
andRenderObject
.New API methods for the prop API ├── Interface "NamedWidgetProp" added ├── Interface "NamedElementProp" added ├── Interface "NamedRenderObjectProp" added ├── Function "widgetProp" added ├── Function "elementProp" added ├── Function "renderObjectProp" added ├─┬ Class SelectorQueries │ ├── Method "whereWidgetProp" added │ ├── Method "whereElementProp" added │ └── Method "whereRenderObjectProp" added └─┬ Class WidgetMatcherExtensions ├── Method "getWidgetProp" added ├── Method "hasWidgetProp" added ├── Method "getElementProp" added ├── Method "hasElementProp" added ├── Method "getRenderObjectProp" added └── Method "hasRenderObjectProp" added
-
Never miss asserting your
WidgetSelector
.
All methods returning aWidgetSelector
are now annotated with@useResult
.
This will cause a lint warning when you only define aWidgetSelector
without asserting it.spot<FloatingActionButton>().withChild(spotIcons(Icons.add)); // warning, no assertion final plusFab = spot<FloatingActionButton>().withChild(spotIcons(Icons.add)); // ok, assigned spot<FloatingActionButton>().withChild(spotIcons(Icons.add)).existsOnce(); // ok, asserted
-
It is now easy to directly access the Widget of a
SingleWidgetSelector
withsnapshotWidget()
.
It also works for the associatedElement
andRenderObject
. UsesnapshotElement()
andsnapshotRenderObject()
.-final checkbox = spotSingle<Checkbox>().snapshot().widget; +final checkbox = spotSingle<Checkbox>().snapshotWidget(); print(checkbox.checkColor);
v0.6.0
- Add matchers
.existsAtMostOnce()
and.existsAtMostNTimes(x)
#19 - Add selector
.withParent(parent)
/.withParents([...])
#21 - Add selector
.withChild(child)
/.withChildren([...])
#21 - Child selectors now only match children #22
- You can call
act.tap()
now with anyWidgetSelector
that returns a single widget #23
v0.5.0
- Breaking
act.tap
is now async, useawait act.tap()
#17 - New:
spotText('foo')
finds any text on screen using "contains". The newAnyText
widget combinesText
,SelectableText
,RichText
andEditableText
#18 - New:
spotTextWhere((text) => )
allows to match text with custom logic #18 - Deprecated:
spotSingleText
andspotTexts
are deprecated in favor ofspotText
and the basicspot<Text>()
,spot<SelectableText>()
, ... #18 - Fix:
hasProp
matcher can now check for null values with(it) => it.isNull()
#18 - Improvement:
withDiagnosticProp
now falls back to the default value of aDiagnosticNode
#18
// deprecated
spotSingleText("Hello");
spotSingleText<Text>("Hello");
spotTexts<EditableText>("Hello");
// New
spotText("Hello");
spotText("Hello", exact: true);
spotTextWhere((it) => it.startsWith("He"));
// With exact widget type
spot<Text>().whereText((it) => it.equals("Hello")).first();
v0.4.1
- Added screenshot methods #14
/// Takes a screenshot of the entire window await takeScreenshot(); /// Takes a screenshot of a single Screen/Widget final homePage = spotSingle<HomePage>(); await takeScreenshot(selector: homePage); /// Use it as extension await spotSingle<HomePage>().takeScreenshot();
- Export all types from
checks.dart
which are required to usehasProp
- Update for Flutter 3.13
v0.3.2
v0.4.0
v0.3.1
v0.3.0
spotTexts
now matchesEditableText
andSelectableText
#5spotTexts
now has generic type<W>
instead of staticText
. This changes the return type fromMultiWidgetSelector<Text>
->MultiWidgetSelector<W>
#5- Changed signature of
SingleWidgetSelector.withProp
andMultiWidgetSelector.withProp
. - New matchers for
EditableText
,ListTile
,SelectableText
v0.2.0
- Reworked spot API #3
- Allow defining
WidgetSelector
with children - Allow defining
WidgetSelector
with parents - Interop with
Finder
API - Match properties of widgets (via
DiagnosticsNode
) - Allow matching of nested properties (with checks API)
- Generate code for custom properties for Flutter widgets
- Allow generating code for properties of 3rd party widgets