Deprecate `OverlayPortal.targetsRootOverlay`

The OverlayPortal.targetsRootOverlay property was deprecated and replaced with overlayLocation.

A overlayLocation parameter was added to the OverlayPortal default constructor to control where the overlay child renders. As a result, the OverlayPortal.targetsRootOverlay constructor is no longer useful.

The OverlayPortal.targetsRootOverlay constructor is deprecated.

If you are using OverlayPortal.targetsRootOverlay, use OverlayPortal with overlayLocation instead.

Code before migration:

Widget build(BuildContext context) {
  return OverlayPortal.targetsRootOverlay(
    controller: myController,
    overlayChildBuilder: _myBuilder,
    child: myChild,
  );
}

Code after migration:

Widget build(BuildContext context) {
  return OverlayPortal(
    overlayLocation: OverlayChildLocation.rootOverlay,
    controller: myController,
    overlayChildBuilder: _myBuilder,
    child: myChild,
  );
}

Landed in version: 3.38.0-0.1.pre
In stable release: 3.38

API documentation:

• OverlayPortal

Relevant issue:

• Issue 168785

Relevant PR:

• PR 174239