From 101a2ebf443d95cc20aef53567880298ccabb957 Mon Sep 17 00:00:00 2001 From: Marco Collovati Date: Fri, 22 Dec 2023 11:35:32 +0100 Subject: [PATCH 1/5] docs: add instructions to disable component tracker Part of vaadin/flow#18130 --- .../development-mode/dev-tools/component-locator.adoc | 6 ++++++ articles/configuration/properties.adoc | 5 +++++ 2 files changed, 11 insertions(+) diff --git a/articles/configuration/development-mode/dev-tools/component-locator.adoc b/articles/configuration/development-mode/dev-tools/component-locator.adoc index 295be95969..a640863515 100644 --- a/articles/configuration/development-mode/dev-tools/component-locator.adoc +++ b/articles/configuration/development-mode/dev-tools/component-locator.adoc @@ -39,3 +39,9 @@ image::/images/code-view.png[The Button component and corresponding source code. [class^=PageHeader-module--descriptionContainer] {display: none;} ++++ + +== Disable Component Tracking + +Component tracking is not an expensive operation, but sometimes it may be useful to disable it. +To disable tracking, set the `vaadin.devmode.componentTracker.enabled` configuration parameter to `false`. +See <<{articles}/configuration/properties#,Configuration Properties>> for more information about setting configuration parameters. diff --git a/articles/configuration/properties.adoc b/articles/configuration/properties.adoc index 3e9e57626c..05eb07a28d 100644 --- a/articles/configuration/properties.adoc +++ b/articles/configuration/properties.adoc @@ -121,6 +121,11 @@ The following table contains the properties that are defined in the [classname]` |`false` |Enables session serialization. When session serialization is enabled, [classname]`UI` instances and registered [classname]`StreamResource` instances are serialized or deserialized when restarting the development server. When set to `true`, for example, access control information can be preserved during development so that you don't need to log in for each change. This applies only to development mode. +|`devmode.componentTracker.enabled` +|`true` +|Enables the <> tracker utility. Set to `false` to disable component tracking. This applies only to development mode. + + |`devmode.usageStatistics.enabled` |`true` |Enables Vaadin to collect usage statistics that can guide further development. Statistics are collected based on features that are used in the application. No data is collected in production mode. Some usage statistics are collected through the web browser. See the https://github.com/vaadin/vaadin-usage-statistics[client-side collector repository] for instructions on how to opt out. This applies only to development mode. From b9e8a73b7bb37a23ebd48ab99a7afebb7d31470d Mon Sep 17 00:00:00 2001 From: Marco Collovati Date: Fri, 22 Dec 2023 12:53:15 +0100 Subject: [PATCH 2/5] Apply suggestions from code review Co-authored-by: Tarek Oraby <42799254+tarekoraby@users.noreply.github.com> --- .../development-mode/dev-tools/component-locator.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/articles/configuration/development-mode/dev-tools/component-locator.adoc b/articles/configuration/development-mode/dev-tools/component-locator.adoc index a640863515..144e8a2a47 100644 --- a/articles/configuration/development-mode/dev-tools/component-locator.adoc +++ b/articles/configuration/development-mode/dev-tools/component-locator.adoc @@ -40,6 +40,7 @@ image::/images/code-view.png[The Button component and corresponding source code. ++++ +[since:com.vaadin:vaadin@V24.4] == Disable Component Tracking Component tracking is not an expensive operation, but sometimes it may be useful to disable it. From 1d748e8c03c7ee0069f96d2067dfaa68f1066e2a Mon Sep 17 00:00:00 2001 From: Marco Collovati Date: Fri, 29 Dec 2023 09:21:11 +0100 Subject: [PATCH 3/5] apply review suggestions --- .../development-mode/dev-tools/component-locator.adoc | 1 + articles/configuration/properties.adoc | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/articles/configuration/development-mode/dev-tools/component-locator.adoc b/articles/configuration/development-mode/dev-tools/component-locator.adoc index 144e8a2a47..63215804eb 100644 --- a/articles/configuration/development-mode/dev-tools/component-locator.adoc +++ b/articles/configuration/development-mode/dev-tools/component-locator.adoc @@ -44,5 +44,6 @@ image::/images/code-view.png[The Button component and corresponding source code. == Disable Component Tracking Component tracking is not an expensive operation, but sometimes it may be useful to disable it. +Be aware that with component tracking disabled, the Component Locator tool cannot identify any components. To disable tracking, set the `vaadin.devmode.componentTracker.enabled` configuration parameter to `false`. See <<{articles}/configuration/properties#,Configuration Properties>> for more information about setting configuration parameters. diff --git a/articles/configuration/properties.adoc b/articles/configuration/properties.adoc index 05eb07a28d..f19dc3b134 100644 --- a/articles/configuration/properties.adoc +++ b/articles/configuration/properties.adoc @@ -123,7 +123,7 @@ The following table contains the properties that are defined in the [classname]` |`devmode.componentTracker.enabled` |`true` -|Enables the <> tracker utility. Set to `false` to disable component tracking. This applies only to development mode. +|Enables the <> tracker utility. Set to `false` to disable component tracking. With component tracking disabled, the Component Locator tool cannot identify any components. This applies only to development mode. |`devmode.usageStatistics.enabled` From bb935d090963f6a9c86a4f98f643bfaefe376b44 Mon Sep 17 00:00:00 2001 From: russelljtdyer <6652767+russelljtdyer@users.noreply.github.com> Date: Wed, 10 Jan 2024 13:16:53 +0100 Subject: [PATCH 4/5] First pass at editing touched files. --- .../dev-tools/component-locator.adoc | 20 ++++++++++++------- articles/configuration/properties.adoc | 3 +-- 2 files changed, 14 insertions(+), 9 deletions(-) diff --git a/articles/configuration/development-mode/dev-tools/component-locator.adoc b/articles/configuration/development-mode/dev-tools/component-locator.adoc index 63215804eb..4149c40c7e 100644 --- a/articles/configuration/development-mode/dev-tools/component-locator.adoc +++ b/articles/configuration/development-mode/dev-tools/component-locator.adoc @@ -1,18 +1,18 @@ --- title: Component Locator -description: Use Component Locator to identify components in views and find their source code in your IDE. +description: Use Component Locator to identify components in views and find their source code in an IDE. order: 1 --- = [since:com.vaadin:vaadin@V24]#Component Locator# -You can use the component locator to identify components and to find their code when running applications in <<../#,development mode>>. The component locator opens the corresponding source code in your IDE when you click a component (for example, a Button in a view). +You can use the component locator to identify components, and to find their code when running applications in <<../#,development mode>>. The component locator opens the corresponding source code in your IDE when you click a component (e.g., a Button in a view). == Enabling Component Locator -Start by running your Vaadin application project in development mode. Click on the Vaadin symbol [guilabel]*}>* at the bottom right-hand corner of your browser window -- as indicated in the screenshot here. +Start by running your Vaadin Flow application project in development mode. Click on the Vaadin symbol [guilabel]*}>* at the bottom right-hand corner of your browser window -- as indicated in the screenshot here. [.device] image::/images/dev-tools-location.png[The Vaadin symbol location in development mode.] @@ -25,7 +25,7 @@ image::/images/code-menu.png[The Code tab viewed in the Dev tools menu.] == Using Component Locator -Now that the Component Locator has been enabled, you're ready to use it. To highlight a component in red and identify it, hover your pointer over one in the view. The component names appear in a list at the bottom right-hand corner of your browser window. You can use the arrow keys to navigate that list. +Now that the Component Locator has been enabled, it's ready to be used. To highlight a component in red and identify it, hover your pointer over one in the view. The component names appear in a list at the bottom right-hand corner of your browser window. You can use the arrow keys to navigate that list. [.device] image::/images/component-locator.png[Component Locator highlighting and identifying the Button component.] @@ -40,10 +40,16 @@ image::/images/code-view.png[The Button component and corresponding source code. ++++ + [since:com.vaadin:vaadin@V24.4] == Disable Component Tracking -Component tracking is not an expensive operation, but sometimes it may be useful to disable it. -Be aware that with component tracking disabled, the Component Locator tool cannot identify any components. -To disable tracking, set the `vaadin.devmode.componentTracker.enabled` configuration parameter to `false`. +Component tracking isn't an expensive operation, but it may at times be useful to disable it. Be aware that with component tracking disabled, the Component Locator tool cannot identify any components. To disable tracking, set the `vaadin.devmode.componentTracker.enabled` configuration parameter to `false`. See <<{articles}/configuration/properties#,Configuration Properties>> for more information about setting configuration parameters. + + +++++ + +++++ \ No newline at end of file diff --git a/articles/configuration/properties.adoc b/articles/configuration/properties.adoc index f19dc3b134..4f9395ee0d 100644 --- a/articles/configuration/properties.adoc +++ b/articles/configuration/properties.adoc @@ -123,8 +123,7 @@ The following table contains the properties that are defined in the [classname]` |`devmode.componentTracker.enabled` |`true` -|Enables the <> tracker utility. Set to `false` to disable component tracking. With component tracking disabled, the Component Locator tool cannot identify any components. This applies only to development mode. - +|Enables the <> tracker utility. Set to `false` to disable. With it disabled, the Component Locator tool cannot identify any components. This applies only to development mode. |`devmode.usageStatistics.enabled` |`true` From e9e492d09f73b6f1cfcab5ce3c9c5f37e3142d81 Mon Sep 17 00:00:00 2001 From: russelljtdyer <6652767+russelljtdyer@users.noreply.github.com> Date: Wed, 10 Jan 2024 13:26:46 +0100 Subject: [PATCH 5/5] Second pass at editing touched files. --- articles/configuration/properties.adoc | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/articles/configuration/properties.adoc b/articles/configuration/properties.adoc index 3b0f398e03..7edabbf1af 100644 --- a/articles/configuration/properties.adoc +++ b/articles/configuration/properties.adoc @@ -7,7 +7,7 @@ order: 10 = Configuration Properties -You can change the behavior of Vaadin applications by setting the configuration properties. You can use either system properties, or servlet initialization parameters to set them. See the <> for details. +You can change the behavior of Vaadin applications by setting the configuration properties. You can set them either through the system properties, or the servlet initialization parameters. See the <> for details. See also the <<{articles}/integrations/spring/configuration#, Spring-specific instructions>> for Spring-based applications. @@ -96,7 +96,6 @@ When a system property and a servlet parameter have the same name, the system pr The following table contains the properties that are defined in the [classname]`com.vaadin.server.DeploymentConfiguration` and [classname]`com.vaadin.server.Constants` classes. They're listed in alphabetical order. If you use Spring Boot, you should add the `vaadin.` prefix to them (e.g., change `brotli` to `vaadin.brotli`). - [cols="1,1,4"] |=== |Property Name |Default Value |Description