Skip to content

Commit 2d142c5

Browse files
authored
[web] ui.platformViewRegistry => ui_web.platformViewRegistry (#127493)
Now that `platformViewRegistry` is [exposed](flutter-team-archive/engine#41877) through `dart:ui_web`, we can do some cleanup here. Part of flutter/flutter#126831
1 parent ef54879 commit 2d142c5

8 files changed

Lines changed: 28 additions & 42 deletions

File tree

‎dev/benchmarks/macrobenchmarks/lib/src/draw_points.dart‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,10 @@
33
// found in the LICENSE file.
44

55
import 'dart:typed_data';
6+
import 'dart:ui';
67

78
import 'package:flutter/material.dart';
89

9-
import 'web/platform_views/web.dart';
10-
1110
class DrawPointsPage extends StatefulWidget {
1211
const DrawPointsPage({super.key});
1312

‎dev/benchmarks/macrobenchmarks/lib/src/web/bench_platform_view_infinite_scroll.dart‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,16 @@
44

55
import 'dart:async';
66
import 'dart:html' as html;
7+
import 'dart:ui_web' as ui_web;
78

89
import 'package:flutter/material.dart';
910

10-
// TODO(mdebbar): flutter/flutter#55000 Remove this conditional import once
11-
// web-only dart:ui_web APIs are exposed from a dedicated place.
12-
import 'platform_views/non_web.dart'
13-
if (dart.library.html) 'platform_views/web.dart';
1411
import 'recorder.dart';
1512

1613
const String benchmarkViewType = 'benchmark_element';
1714

1815
void _registerFactory() {
19-
platformViewRegistry.registerViewFactory(benchmarkViewType, (int viewId) {
16+
ui_web.platformViewRegistry.registerViewFactory(benchmarkViewType, (int viewId) {
2017
final html.Element htmlElement = html.DivElement();
2118
htmlElement.id = '${benchmarkViewType}_$viewId';
2219
htmlElement.innerText = 'Google';

‎dev/benchmarks/macrobenchmarks/lib/src/web/platform_views/non_web.dart‎

Lines changed: 0 additions & 15 deletions
This file was deleted.

‎dev/benchmarks/macrobenchmarks/lib/src/web/platform_views/web.dart‎

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎dev/integration_tests/web_e2e_tests/test_driver/platform_messages_integration.dart‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@
33
// found in the LICENSE file.
44

55
import 'dart:html' as html;
6-
// platformViewRegistry is exposed in the web version
7-
import 'dart:ui' as ui show platformViewRegistry; // ignore: undefined_shown_name
6+
import 'dart:ui_web' as ui_web;
87

98
import 'package:flutter/material.dart';
109
import 'package:flutter/services.dart';
@@ -37,8 +36,7 @@ void main() {
3736
int viewInstanceCount = 0;
3837

3938
platformViewsRegistry.getNextPlatformViewId();
40-
// ignore: undefined_prefixed_name, avoid_dynamic_calls
41-
ui.platformViewRegistry.registerViewFactory('MyView', (int viewId) {
39+
ui_web.platformViewRegistry.registerViewFactory('MyView', (int viewId) {
4240
viewInstanceCount += 1;
4341
return html.DivElement();
4442
});

‎packages/flutter/lib/src/widgets/_platform_selectable_region_context_menu_io.dart‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@
99
import 'framework.dart';
1010
import 'selection_container.dart';
1111

12+
/// Function signature for `ui_web.platformViewRegistry.registerViewFactory`.
13+
@visibleForTesting
14+
typedef RegisterViewFactory = void Function(String, Object Function(int viewId), {bool isVisible});
15+
1216
/// A widget that provides native selection context menu for its child subtree.
1317
///
1418
/// This widget currently only supports Flutter web. Using this widget in non-web
@@ -36,6 +40,12 @@ class PlatformSelectableRegionContextMenu extends StatelessWidget {
3640
/// Detaches the `client` from the platform-appropriate selection context menus.
3741
static void detach(SelectionContainerDelegate client) => throw UnimplementedError();
3842

43+
/// Override this to provide a custom implementation of `ui_web.platformViewRegistry.registerViewFactory`.
44+
///
45+
/// This should only be used for testing.
46+
@visibleForTesting
47+
static RegisterViewFactory? debugOverrideRegisterViewFactory;
48+
3949
@override
4050
Widget build(BuildContext context) => throw UnimplementedError();
4151
}

‎packages/flutter/lib/src/widgets/_platform_selectable_region_context_menu_web.dart‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// Use of this source code is governed by a BSD-style license that can be
33
// found in the LICENSE file.
44

5-
import 'dart:ui' as ui;
5+
import 'dart:ui_web' as ui_web;
66

77
import 'package:flutter/rendering.dart';
88

@@ -29,7 +29,7 @@ const int _kRightClickButton = 2;
2929

3030
typedef _WebSelectionCallBack = void Function(DomHTMLElement, DomMouseEvent);
3131

32-
/// Function signature for `ui.platformViewRegistry.registerViewFactory`.
32+
/// Function signature for `ui_web.platformViewRegistry.registerViewFactory`.
3333
@visibleForTesting
3434
typedef RegisterViewFactory = void Function(String, Object Function(int viewId), {bool isVisible});
3535

@@ -67,10 +67,15 @@ class PlatformSelectableRegionContextMenu extends StatelessWidget {
6767
// Keeps track if this widget has already registered its view factories or not.
6868
static String? _registeredViewType;
6969

70-
/// See `_platform_selectable_region_context_menu_io.dart`.
70+
static RegisterViewFactory get _registerViewFactory =>
71+
debugOverrideRegisterViewFactory ?? ui_web.platformViewRegistry.registerViewFactory;
72+
73+
/// Override this to provide a custom implementation of [ui_web.platformViewRegistry.registerViewFactory].
74+
///
75+
/// This should only be used for testing.
76+
// See `_platform_selectable_region_context_menu_io.dart`.
7177
@visibleForTesting
72-
// ignore: undefined_prefixed_name, invalid_assignment, avoid_dynamic_calls
73-
static RegisterViewFactory registerViewFactory = ui.platformViewRegistry.registerViewFactory;
78+
static RegisterViewFactory? debugOverrideRegisterViewFactory;
7479

7580
// Registers the view factories for the interceptor widgets.
7681
static void _register() {
@@ -100,7 +105,7 @@ class PlatformSelectableRegionContextMenu extends StatelessWidget {
100105
}
101106

102107
static String _registerWebSelectionCallback(_WebSelectionCallBack callback) {
103-
registerViewFactory(_viewType, (int viewId) {
108+
_registerViewFactory(_viewType, (int viewId) {
104109
final DomHTMLElement htmlElement = createDomHTMLDivElement();
105110
htmlElement
106111
..style.width = '100%'

‎packages/flutter/test/widgets/selectable_region_context_menu_test.dart‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
// Use of this source code is governed by a BSD-style license that can be
33
// found in the LICENSE file.
44

5-
// ignore_for_file: undefined_class, undefined_getter, undefined_setter
6-
75
@TestOn('browser') // This file contains web-only library.
86
library;
97

@@ -16,16 +14,15 @@ import 'package:flutter_test/flutter_test.dart';
1614

1715
void main() {
1816
html.Element? element;
19-
final RegisterViewFactory originalFactory = PlatformSelectableRegionContextMenu.registerViewFactory;
20-
PlatformSelectableRegionContextMenu.registerViewFactory = (String viewType, Object Function(int viewId) fn, {bool isVisible = true}) {
17+
PlatformSelectableRegionContextMenu.debugOverrideRegisterViewFactory = (String viewType, Object Function(int viewId) fn, {bool isVisible = true}) {
2118
element = fn(0) as html.Element;
2219
// The element needs to be attached to the document body to receive mouse
2320
// events.
2421
html.document.body!.append(element!);
2522
};
2623
// This force register the dom element.
2724
PlatformSelectableRegionContextMenu(child: const Placeholder());
28-
PlatformSelectableRegionContextMenu.registerViewFactory = originalFactory;
25+
PlatformSelectableRegionContextMenu.debugOverrideRegisterViewFactory = null;
2926

3027
test('DOM element is set up correctly', () async {
3128
expect(element, isNotNull);

0 commit comments

Comments
 (0)