-
Notifications
You must be signed in to change notification settings - Fork 326
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.
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
Add skeleton for extension screen views and controllers #6054
Merged
kenzieschmoll
merged 7 commits into
flutter:master
from
kenzieschmoll:devtools-extensions-1
Jul 19, 2023
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
3a50842
Add skeleton for extension screen views and controllers
kenzieschmoll a9b4ba8
fixes
kenzieschmoll 97f1a06
add import
kenzieschmoll 9021a54
sort
kenzieschmoll 679c04a
dart doc
kenzieschmoll fd6f8ef
format
kenzieschmoll bd0a566
Merge branch 'master' of github.com:flutter/devtools into devtools-ex…
kenzieschmoll File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
9 changes: 9 additions & 0 deletions
9
packages/devtools_app/lib/src/extensions/embedded/_controller_desktop.dart
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
// Copyright 2023 The Chromium Authors. All rights reserved. | ||
// Use of this source code is governed by a BSD-style license that can be | ||
// found in the LICENSE file. | ||
|
||
import 'controller.dart'; | ||
|
||
class EmbeddedExtensionControllerImpl extends EmbeddedExtensionController { | ||
// TODO(kenz): implement desktop stubs that match the web implementation. | ||
} |
9 changes: 9 additions & 0 deletions
9
packages/devtools_app/lib/src/extensions/embedded/_controller_web.dart
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
// Copyright 2023 The Chromium Authors. All rights reserved. | ||
// Use of this source code is governed by a BSD-style license that can be | ||
// found in the LICENSE file. | ||
|
||
import 'controller.dart'; | ||
|
||
class EmbeddedExtensionControllerImpl extends EmbeddedExtensionController { | ||
// TODO(kenz): implement web controller for embedded extension | ||
} |
24 changes: 24 additions & 0 deletions
24
packages/devtools_app/lib/src/extensions/embedded/_view_desktop.dart
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
// Copyright 2023 The Chromium Authors. All rights reserved. | ||
// Use of this source code is governed by a BSD-style license that can be | ||
// found in the LICENSE file. | ||
|
||
import 'package:flutter/material.dart'; | ||
|
||
import 'controller.dart'; | ||
|
||
class EmbeddedExtension extends StatelessWidget { | ||
const EmbeddedExtension({super.key, required this.controller}); | ||
|
||
final EmbeddedExtensionController controller; | ||
|
||
@override | ||
Widget build(BuildContext context) { | ||
// TODO(kenz): if web view support for desktop is ever added, use that here. | ||
return const Center( | ||
child: Text( | ||
'Cannot display the DevTools plugin.' | ||
' IFrames are not supported on desktop platforms.', | ||
), | ||
); | ||
} | ||
} |
20 changes: 20 additions & 0 deletions
20
packages/devtools_app/lib/src/extensions/embedded/_view_web.dart
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
// Copyright 2023 The Chromium Authors. All rights reserved. | ||
// Use of this source code is governed by a BSD-style license that can be | ||
// found in the LICENSE file. | ||
|
||
import 'package:flutter/material.dart'; | ||
|
||
import 'controller.dart'; | ||
|
||
class EmbeddedExtension extends StatelessWidget { | ||
const EmbeddedExtension({super.key, required this.controller}); | ||
|
||
final EmbeddedExtensionController controller; | ||
|
||
@override | ||
Widget build(BuildContext context) { | ||
return const Center( | ||
child: Text('TODO implement embedded extension web view'), | ||
); | ||
} | ||
} |
12 changes: 12 additions & 0 deletions
12
packages/devtools_app/lib/src/extensions/embedded/controller.dart
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
// Copyright 2023 The Chromium Authors. All rights reserved. | ||
// Use of this source code is governed by a BSD-style license that can be | ||
// found in the LICENSE file. | ||
|
||
import '../../shared/primitives/auto_dispose.dart'; | ||
import '_controller_desktop.dart' if (dart.library.html) '_controller_web.dart'; | ||
|
||
EmbeddedExtensionControllerImpl createEmbeddedExtensionController() { | ||
return EmbeddedExtensionControllerImpl(); | ||
} | ||
|
||
abstract class EmbeddedExtensionController extends DisposableController {} |
27 changes: 27 additions & 0 deletions
27
packages/devtools_app/lib/src/extensions/embedded/view.dart
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
// Copyright 2023 The Chromium Authors. All rights reserved. | ||
// Use of this source code is governed by a BSD-style license that can be | ||
// found in the LICENSE file. | ||
|
||
import 'package:flutter/material.dart'; | ||
|
||
import '_view_desktop.dart' if (dart.library.html) '_view_web.dart'; | ||
import 'controller.dart'; | ||
|
||
/// A widget that displays a DevTools extension in an embedded iFrame. | ||
/// | ||
/// A DevTools extension is provided by a pub package and is served by the | ||
/// DevTools server when present for a connected application. | ||
/// | ||
/// When DevTools is run on Desktop for development, this widget displays a | ||
/// placeholder, since Flutter Desktop does not currently support web views. | ||
class EmbeddedExtensionView extends StatelessWidget { | ||
const EmbeddedExtensionView({Key? key, required this.controller}) | ||
: super(key: key); | ||
|
||
final EmbeddedExtensionController controller; | ||
|
||
@override | ||
Widget build(BuildContext context) { | ||
return EmbeddedExtension(controller: controller); | ||
} | ||
} |
146 changes: 146 additions & 0 deletions
146
packages/devtools_app/lib/src/extensions/extension_screen.dart
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,146 @@ | ||
// Copyright 2023 The Chromium Authors. All rights reserved. | ||
// Use of this source code is governed by a BSD-style license that can be | ||
// found in the LICENSE file. | ||
|
||
import 'package:flutter/foundation.dart'; | ||
import 'package:flutter/material.dart'; | ||
|
||
import '../shared/analytics/constants.dart' as gac; | ||
import '../shared/common_widgets.dart'; | ||
import '../shared/primitives/listenable.dart'; | ||
import '../shared/primitives/utils.dart'; | ||
import '../shared/screen.dart'; | ||
import '../shared/theme.dart'; | ||
import 'embedded/controller.dart'; | ||
import 'embedded/view.dart'; | ||
import 'extension_model.dart'; | ||
|
||
class ExtensionScreen extends Screen { | ||
ExtensionScreen(this.extensionConfig) | ||
: super.conditional( | ||
// TODO(kenz): we may need to ensure this is a unique id. | ||
id: '${extensionConfig.name}-ext', | ||
title: extensionConfig.name.toSentenceCase(), | ||
icon: extensionConfig.icon, | ||
// TODO(kenz): support static DevTools extensions. | ||
requiresConnection: true, | ||
); | ||
|
||
final DevToolsExtensionConfig extensionConfig; | ||
|
||
@override | ||
ValueListenable<bool> get showIsolateSelector => | ||
const FixedValueListenable<bool>(true); | ||
|
||
@override | ||
Widget build(BuildContext context) => | ||
_ExtensionScreenBody(extensionConfig: extensionConfig); | ||
} | ||
|
||
class _ExtensionScreenBody extends StatefulWidget { | ||
const _ExtensionScreenBody({required this.extensionConfig}); | ||
|
||
final DevToolsExtensionConfig extensionConfig; | ||
|
||
@override | ||
State<_ExtensionScreenBody> createState() => __ExtensionScreenBodyState(); | ||
} | ||
|
||
class __ExtensionScreenBodyState extends State<_ExtensionScreenBody> { | ||
late final EmbeddedExtensionController extensionController; | ||
|
||
@override | ||
void initState() { | ||
super.initState(); | ||
extensionController = createEmbeddedExtensionController(); | ||
} | ||
|
||
@override | ||
void dispose() { | ||
extensionController.dispose(); | ||
super.dispose(); | ||
} | ||
|
||
@override | ||
Widget build(BuildContext context) { | ||
return ExtensionView( | ||
controller: extensionController, | ||
extension: widget.extensionConfig, | ||
); | ||
} | ||
} | ||
|
||
class ExtensionView extends StatelessWidget { | ||
const ExtensionView({ | ||
super.key, | ||
required this.controller, | ||
required this.extension, | ||
}); | ||
|
||
final EmbeddedExtensionController controller; | ||
|
||
final DevToolsExtensionConfig extension; | ||
|
||
@override | ||
Widget build(BuildContext context) { | ||
return RoundedOutlinedBorder( | ||
clip: true, | ||
child: Column( | ||
children: [ | ||
EmbeddedExtensionHeader(extension: extension), | ||
Expanded( | ||
child: KeepAliveWrapper( | ||
child: Center( | ||
child: EmbeddedExtensionView(controller: controller), | ||
), | ||
), | ||
), | ||
], | ||
), | ||
); | ||
} | ||
} | ||
|
||
// TODO(kenz): add button to deactivate extension once activate / deactivate | ||
// logic is hooked up. | ||
class EmbeddedExtensionHeader extends StatelessWidget { | ||
const EmbeddedExtensionHeader({super.key, required this.extension}); | ||
|
||
final DevToolsExtensionConfig extension; | ||
|
||
@override | ||
Widget build(BuildContext context) { | ||
final theme = Theme.of(context); | ||
final extensionName = extension.name.toLowerCase(); | ||
return AreaPaneHeader( | ||
title: RichText( | ||
text: TextSpan( | ||
text: 'package:$extensionName extension', | ||
style: theme.regularTextStyle.copyWith(fontWeight: FontWeight.bold), | ||
children: [ | ||
TextSpan( | ||
text: ' (v${extension.version})', | ||
style: theme.subtleTextStyle, | ||
), | ||
], | ||
), | ||
), | ||
includeTopBorder: false, | ||
roundedTopBorder: false, | ||
rightPadding: defaultSpacing, | ||
actions: [ | ||
RichText( | ||
text: LinkTextSpan( | ||
link: Link( | ||
display: 'Report an issue', | ||
url: extension.issueTrackerLink, | ||
gaScreenName: gac.extensionScreenId, | ||
gaSelectedItemDescription: gac.extensionFeedback(extensionName), | ||
), | ||
context: context, | ||
), | ||
), | ||
], | ||
); | ||
} | ||
} |
32 changes: 0 additions & 32 deletions
32
packages/devtools_app/lib/src/extensions/ui/extension_screen.dart
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Doc comment?
Can you explain or reference explanation of difference between embedded and non-embedded extension?