Deprecated API

Contents

• Terminally Deprecated
• Interfaces
• Classes
• Annotation Interfaces
• Fields
• Methods
• Constructors
• Annotation Interface Elements

Terminally Deprecated Elements

Element	Description
com.vaadin.flow.component.Component.scrollIntoView(ScrollOptions)	Use Component.scrollIntoView(ScrollIntoViewOption...) instead
com.vaadin.flow.component.ComponentUtil.resolveOrGenerateIdLater(Element, Component, String, Consumer<String>)	use ComponentUtil.resolveOrGenerateIdLater(Element, Component, String, SerializableSupplier, SerializableConsumer) instead. Without a getter, a value set after this call is overwritten when the resolution runs, and the target of a superseded resolution is still assigned a generated id. In addition, the pending resolution is stored in the state tree, or as an attach listener while sourceElement is detached, so a consumer that is not serializable makes the session fail to serialize.
com.vaadin.flow.component.HasOrderedComponents	since 25.1, for removal in 26.
com.vaadin.flow.component.page.ExtendedClientDetails.getCurrentDate()	use ExtendedClientDetails.getBrowserTime() instead, which returns a time-zone independent Instant
com.vaadin.flow.component.ScrollOptions	Use Element.scrollIntoView(ScrollIntoViewOption...) with ScrollIntoViewOption.Behavior, ScrollIntoViewOption.Block, and ScrollIntoViewOption.Inline options instead
com.vaadin.flow.component.UI.wrapperElement	Use UIInternals.getWrapperElement() through getInternals().getWrapperElement() instead.
com.vaadin.flow.dom.Element.scrollIntoView(ScrollOptions)	Use Element.scrollIntoView(ScrollIntoViewOption...) instead
com.vaadin.flow.internal.FileIOUtils.deleteFileQuietly(File)	use FileIOUtils.deleteQuietly(File) instead, which also deletes directory contents and logs why a deletion failed instead of failing silently
com.vaadin.flow.internal.hilla.FileRouterRequestUtil.isRouteAllowed(HttpServletRequest)	use FileRouterRequestUtil.isAnonymousRoute(HttpServletRequest) to match requests to anonymous routes
com.vaadin.flow.router.LocationChangeEvent.getRerouteTarget()	the router never reads this value; use BeforeEvent.getRerouteTarget() instead
com.vaadin.flow.router.LocationChangeEvent.rerouteTo(NavigationHandler)	reroute from a BeforeEnterObserver or BeforeLeaveObserver with BeforeEvent.rerouteTo(NavigationHandler, NavigationState) instead
com.vaadin.flow.router.LocationChangeEvent.rerouteTo(NavigationState)	reroute from a BeforeEnterObserver or BeforeLeaveObserver with BeforeEvent.rerouteTo(NavigationState) instead
com.vaadin.flow.server.communication.RpcInvocationEvent	use RpcInvocationStartedEvent, RpcInvocationFailedEvent and RpcInvocationEndedEvent on the service event bus instead
com.vaadin.flow.server.communication.RpcInvocationListener	add listeners for RpcInvocationStartedEvent, RpcInvocationFailedEvent and RpcInvocationEndedEvent on the service event bus instead. The callbacks of this listener are served by those events, one instance each, so an implementation that correlates the callbacks of an invocation has to do so through the thread they are delivered on rather than through the identity of the event
com.vaadin.flow.server.PwaRegistry.getRuntimeServiceWorkerJs()	use PwaRegistry.getRuntimeServiceWorkerJs(VaadinRequest) instead. Without a request the app shell stylesheet URLs cannot be resolved, so those entries are left out.
com.vaadin.flow.server.SessionLockEvent	use SessionLockRequestedEvent, SessionLockAcquiredEvent and SessionLockReleasedEvent on the service event bus instead
com.vaadin.flow.server.SessionLockListener	add listeners for SessionLockRequestedEvent, SessionLockAcquiredEvent and SessionLockReleasedEvent on the service event bus instead
com.vaadin.flow.server.StreamReceiver	use UploadHandler instead
com.vaadin.flow.server.StreamResource	use DownloadHandler instead
com.vaadin.flow.server.StreamVariable	use UploadHandler instead
com.vaadin.flow.server.VaadinService.addRpcInvocationListener(RpcInvocationListener)	add listeners for RpcInvocationStartedEvent, RpcInvocationFailedEvent and RpcInvocationEndedEvent through VaadinService.getEventBus() instead
com.vaadin.flow.server.VaadinService.addSessionLockListener(SessionLockListener)	add listeners for SessionLockRequestedEvent, SessionLockAcquiredEvent and SessionLockReleasedEvent through VaadinService.getEventBus() instead
com.vaadin.flow.server.VaadinService.fireUIInitListeners(UI)	fire a UIInitEvent through VaadinService.getEventBus() instead
com.vaadin.flow.server.VaadinService.reinitializeSession(VaadinRequest)	use HttpServletRequest.changeSessionId() instead, which changes the session id in place without copying the session attributes
com.vaadin.flow.server.VaadinServlet.serveStaticOrWebJarRequest(HttpServletRequest, HttpServletResponse)	The name refers to WebJars, which are not handled here. This method only delegates to StaticFileHandler.serveStaticResource(HttpServletRequest, HttpServletResponse), which VaadinServlet.service(HttpServletRequest, HttpServletResponse) now calls directly, so overriding this method no longer affects request handling. Override VaadinServlet.createStaticFileHandler(VaadinService) to customize how static resources are served.
com.vaadin.flow.shared.ApplicationConstants.CLIENT_ENGINE_PATH	the GWT client engine this folder held has been removed, the client is served as part of the application bundle and nothing writes to or serves this path any more
com.vaadin.flow.signals.shared.AbstractSharedSignal.fromJson(JsonNode, Class<T>)	use AbstractSharedSignal.fromJson(JsonNode, JavaType) instead, which also retains the type arguments of a parameterized type such as Set<String>
com.vaadin.flow.signals.shared.AbstractSharedSignal.nodeValue(Node, Class<T>)	use AbstractSharedSignal.nodeValue(Node, JavaType) instead, which also retains the type arguments of a parameterized type such as Set<String>
com.vaadin.flow.signals.shared.SharedListSignal(SignalTree, Id, CommandValidator, Class<T>)	use SharedListSignal(SignalTree, Id, CommandValidator, JavaType) instead, which also retains the type arguments of a parameterized element type such as Set<String>
com.vaadin.flow.signals.shared.SharedMapSignal(SignalTree, Id, CommandValidator, Class<T>)	use SharedMapSignal(SignalTree, Id, CommandValidator, JavaType) instead, which also retains the type arguments of a parameterized element type such as Set<String>
com.vaadin.flow.signals.shared.SharedValueSignal(SignalTree, Id, CommandValidator, Class<T>)	use SharedValueSignal(SignalTree, Id, CommandValidator, JavaType) instead, which also retains the type arguments of a parameterized value type such as Set<String>
com.vaadin.flow.theme.AbstractTheme.getBaseUrl()	base url will not be translated to the theme url anymore
com.vaadin.flow.theme.AbstractTheme.getThemeUrl()	base url will not be translated to the theme url anymore
com.vaadin.flow.theme.AbstractTheme.translateUrl(String)	No translation of the url will be done in 25
com.vaadin.flow.theme.Theme.variant()	Use ColorScheme annotation instead

Deprecated Interfaces

Interface	Description
com.vaadin.flow.component.HasOrderedComponents	since 25.1, for removal in 26.
com.vaadin.flow.component.template.internal.DeprecatedPolymerPublishedEventHandler	Polymer template support is deprecated - we recommend you to use LitTemplate instead. Read more details from the Vaadin blog.
com.vaadin.flow.component.template.internal.DeprecatedPolymerTemplate	Polymer template support is deprecated - we recommend you to use LitTemplate instead. Read more details from the Vaadin blog.
com.vaadin.flow.server.communication.RpcInvocationListener	add listeners for RpcInvocationStartedEvent, RpcInvocationFailedEvent and RpcInvocationEndedEvent on the service event bus instead. The callbacks of this listener are served by those events, one instance each, so an implementation that correlates the callbacks of an invocation has to do so through the thread they are delivered on rather than through the identity of the event
com.vaadin.flow.server.SessionLockListener	add listeners for SessionLockRequestedEvent, SessionLockAcquiredEvent and SessionLockReleasedEvent on the service event bus instead
com.vaadin.flow.server.StreamVariable	use UploadHandler instead

Deprecated Classes

Class	Description
com.vaadin.flow.component.ScrollOptions	Use Element.scrollIntoView(ScrollIntoViewOption...) with ScrollIntoViewOption.Behavior, ScrollIntoViewOption.Block, and ScrollIntoViewOption.Inline options instead
com.vaadin.flow.internal.BrowserLiveReloadAccess	Use BrowserLiveReloadAccessor instead
com.vaadin.flow.internal.nodefeature.PolymerServerEventHandlers	Polymer template support is deprecated - we recommend you to use LitTemplate instead. Read more details from the Vaadin blog.
com.vaadin.flow.server.communication.RpcInvocationEvent	use RpcInvocationStartedEvent, RpcInvocationFailedEvent and RpcInvocationEndedEvent on the service event bus instead
com.vaadin.flow.server.SessionLockEvent	use SessionLockRequestedEvent, SessionLockAcquiredEvent and SessionLockReleasedEvent on the service event bus instead
com.vaadin.flow.server.StreamReceiver	use UploadHandler instead
com.vaadin.flow.server.StreamResource	use DownloadHandler instead
com.vaadin.flow.shared.BrowserDetails	For browser information users should parse the user-agent using a parsing library like ua-parser/uap-java

Deprecated Annotation Interfaces

Annotation Interface	Description
com.vaadin.flow.theme.NoTheme	As of Vaadin 25, this annotation is deprecated together with Theme, since the theming system has been reworked and no theme is applied to the application unless it is explicitly requested. Omitting Theme has the same effect as using this annotation, so it can simply be removed. Styles are now loaded with StyleSheet from public static resources locations or CssImport from a src/main/frontend/ folder, together with mechanisms native to HTML, CSS and React (e.g. @import url("morestyles.css") in CSS).
com.vaadin.flow.theme.Theme	As of Vaadin 25, this annotation is deprecated. The theming system has been reworked to use StyleSheet to load one or more stylesheets from public static resources locations or CssImport to load one or more stylesheets from a src/main/frontend/ folder and use mechanisms native to HTML, CSS and React (e.g. @import url("morestyles.css") in CSS).

Deprecated Fields

Field	Description
com.vaadin.flow.component.UI.wrapperElement	Use UIInternals.getWrapperElement() through getInternals().getWrapperElement() instead.
com.vaadin.flow.server.InitParameters.URL_SAFE_SCHEMES_LEGACY	use InitParameters.URL_SAFE_SCHEMES instead
com.vaadin.flow.shared.ApplicationConstants.CLIENT_ENGINE_PATH	the GWT client engine this folder held has been removed, the client is served as part of the application bundle and nothing writes to or serves this path any more

Deprecated Methods

Method	Description
com.vaadin.flow.component.Component.getTranslation(Object, Locale, Object...)	Use Component.getTranslation(Locale, String, Object...) instead
com.vaadin.flow.component.Component.getTranslation(String, Locale, Object...)	Use Component.getTranslation(Locale, String, Object...) instead
com.vaadin.flow.component.Component.scrollIntoView(ScrollOptions)	Use Component.scrollIntoView(ScrollIntoViewOption...) instead
com.vaadin.flow.component.ComponentUtil.resolveOrGenerateIdLater(Element, Component, String, Consumer<String>)	use ComponentUtil.resolveOrGenerateIdLater(Element, Component, String, SerializableSupplier, SerializableConsumer) instead. Without a getter, a value set after this call is overwritten when the resolution runs, and the target of a superseded resolution is still assigned a generated id. In addition, the pending resolution is stored in the state tree, or as an attach listener while sourceElement is detached, so a consumer that is not serializable makes the session fail to serialize.
com.vaadin.flow.component.dependency.CssImport.id()	The generated 'dom-module' relies on the legacy Polymer styling mechanism. Component styling can be done entirely with normal "light DOM" CSS: drop this attribute and import the CSS file given as CssImport.value() as plain CSS.
com.vaadin.flow.component.dependency.CssImport.include()	The generated 'custom-style' relies on the legacy Polymer styling mechanism. Component styling can be done entirely with normal "light DOM" CSS: drop this attribute and put the rules that were pulled in from the included module into the CSS file given as CssImport.value().
com.vaadin.flow.component.dependency.CssImport.themeFor()	Component styling can be done entirely with normal "light DOM" CSS.
com.vaadin.flow.component.page.ExtendedClientDetails.getCurrentDate()	use ExtendedClientDetails.getBrowserTime() instead, which returns a time-zone independent Instant
com.vaadin.flow.component.page.ExtendedClientDetails.isIOS()	use feature detection instead of platform detection, or inspect ExtendedClientDetails.getNavigatorPlatform() directly
com.vaadin.flow.component.page.ExtendedClientDetails.isIPad()	use feature detection instead of platform detection, or inspect ExtendedClientDetails.getNavigatorPlatform() directly
com.vaadin.flow.component.page.Page.addJsModule(String)	use Page.addJavaScript(String, LoadMode, JavaScript.Type) with JavaScript.Type.MODULE instead. The new overload also accepts a LoadMode.
com.vaadin.flow.component.page.Page.executeJs(String, Serializable[])	Use Page.executeJs(String, Object...) instead. This method exists only for binary compatibility.
com.vaadin.flow.component.page.Page.retrieveExtendedClientDetails(Page.ExtendedClientDetailsReceiver)	Use Page.getExtendedClientDetails() to get the cached details, or ExtendedClientDetails.refresh(SerializableConsumer) to refresh the cached values.
com.vaadin.flow.dom.Element.callJsFunction(String, Serializable[])	Use Element.callJsFunction(String, Object...) instead. This method exists only for binary compatibility.
com.vaadin.flow.dom.Element.executeJs(String, Serializable[])	Use Element.executeJs(String, Object...) instead. This method exists only for binary compatibility.
com.vaadin.flow.dom.Element.scrollIntoView(ScrollOptions)	Use Element.scrollIntoView(ScrollIntoViewOption...) instead
com.vaadin.flow.internal.FileIOUtils.deleteFileQuietly(File)	use FileIOUtils.deleteQuietly(File) instead, which also deletes directory contents and logs why a deletion failed instead of failing silently
com.vaadin.flow.internal.hilla.FileRouterRequestUtil.isRouteAllowed(HttpServletRequest)	use FileRouterRequestUtil.isAnonymousRoute(HttpServletRequest) to match requests to anonymous routes
com.vaadin.flow.internal.UrlUtil.isSafeUrl(String)	use UrlUtil.validateUrl(Component, String, String, String, SerializableRunnable) instead, as it uses the configuration of the application that the component belongs to instead of relying on the current thread having a locked session
com.vaadin.flow.router.LocationChangeEvent.getRerouteTarget()	the router never reads this value; use BeforeEvent.getRerouteTarget() instead
com.vaadin.flow.router.LocationChangeEvent.rerouteTo(NavigationHandler)	reroute from a BeforeEnterObserver or BeforeLeaveObserver with BeforeEvent.rerouteTo(NavigationHandler, NavigationState) instead
com.vaadin.flow.router.LocationChangeEvent.rerouteTo(NavigationState)	reroute from a BeforeEnterObserver or BeforeLeaveObserver with BeforeEvent.rerouteTo(NavigationState) instead
com.vaadin.flow.server.PwaRegistry.getRuntimeServiceWorkerJs()	use PwaRegistry.getRuntimeServiceWorkerJs(VaadinRequest) instead. Without a request the app shell stylesheet URLs cannot be resolved, so those entries are left out.
com.vaadin.flow.server.VaadinService.addRpcInvocationListener(RpcInvocationListener)	add listeners for RpcInvocationStartedEvent, RpcInvocationFailedEvent and RpcInvocationEndedEvent through VaadinService.getEventBus() instead
com.vaadin.flow.server.VaadinService.addSessionLockListener(SessionLockListener)	add listeners for SessionLockRequestedEvent, SessionLockAcquiredEvent and SessionLockReleasedEvent through VaadinService.getEventBus() instead
com.vaadin.flow.server.VaadinService.fireUIInitListeners(UI)	fire a UIInitEvent through VaadinService.getEventBus() instead
com.vaadin.flow.server.VaadinService.reinitializeSession(VaadinRequest)	use HttpServletRequest.changeSessionId() instead, which changes the session id in place without copying the session attributes
com.vaadin.flow.server.VaadinServlet.serveStaticOrWebJarRequest(HttpServletRequest, HttpServletResponse)	The name refers to WebJars, which are not handled here. This method only delegates to StaticFileHandler.serveStaticResource(HttpServletRequest, HttpServletResponse), which VaadinServlet.service(HttpServletRequest, HttpServletResponse) now calls directly, so overriding this method no longer affects request handling. Override VaadinServlet.createStaticFileHandler(VaadinService) to customize how static resources are served.
com.vaadin.flow.server.WebBrowser.getBrowserApplication()	use WebBrowser.getUserAgent() method to get user-agent string
com.vaadin.flow.server.WebBrowser.getBrowserMajorVersion()	use a parsing library like ua-parser/uap-java to parse the user agent from WebBrowser.getUserAgent()
com.vaadin.flow.server.WebBrowser.getBrowserMinorVersion()	use a parsing library like ua-parser/uap-java to parse the user agent from WebBrowser.getUserAgent()
com.vaadin.flow.server.WebBrowser.isAndroid()	use a parsing library like ua-parser/uap-java to parse the user agent from WebBrowser.getUserAgent()
com.vaadin.flow.server.WebBrowser.isChrome()	use a parsing library like ua-parser/uap-java to parse the user agent from WebBrowser.getUserAgent()
com.vaadin.flow.server.WebBrowser.isChromeOS()	use a parsing library like ua-parser/uap-java to parse the user agent from WebBrowser.getUserAgent()
com.vaadin.flow.server.WebBrowser.isEdge()	use a parsing library like ua-parser/uap-java to parse the user agent from WebBrowser.getUserAgent()
com.vaadin.flow.server.WebBrowser.isFirefox()	use a parsing library like ua-parser/uap-java to parse the user agent from WebBrowser.getUserAgent()
com.vaadin.flow.server.WebBrowser.isIE()	use a parsing library like ua-parser/uap-java to parse the user agent from WebBrowser.getUserAgent()
com.vaadin.flow.server.WebBrowser.isIPhone()	use a parsing library like ua-parser/uap-java to parse the user agent from WebBrowser.getUserAgent()
com.vaadin.flow.server.WebBrowser.isLinux()	use a parsing library like ua-parser/uap-java to parse the user agent from WebBrowser.getUserAgent()
com.vaadin.flow.server.WebBrowser.isMacOSX()	use a parsing library like ua-parser/uap-java to parse the user agent from WebBrowser.getUserAgent()
com.vaadin.flow.server.WebBrowser.isOpera()	use a parsing library like ua-parser/uap-java to parse the user agent from WebBrowser.getUserAgent()
com.vaadin.flow.server.WebBrowser.isSafari()	use a parsing library like ua-parser/uap-java to parse the user agent from WebBrowser.getUserAgent()
com.vaadin.flow.server.WebBrowser.isWindows()	use a parsing library like ua-parser/uap-java to parse the user agent from WebBrowser.getUserAgent()
com.vaadin.flow.server.WebBrowser.isWindowsPhone()	use a parsing library like ua-parser/uap-java to parse the user agent from WebBrowser.getUserAgent()
com.vaadin.flow.signals.shared.AbstractSharedSignal.fromJson(JsonNode, Class<T>)	use AbstractSharedSignal.fromJson(JsonNode, JavaType) instead, which also retains the type arguments of a parameterized type such as Set<String>
com.vaadin.flow.signals.shared.AbstractSharedSignal.nodeValue(Node, Class<T>)	use AbstractSharedSignal.nodeValue(Node, JavaType) instead, which also retains the type arguments of a parameterized type such as Set<String>
com.vaadin.flow.theme.AbstractTheme.getBaseUrl()	base url will not be translated to the theme url anymore
com.vaadin.flow.theme.AbstractTheme.getThemeUrl()	base url will not be translated to the theme url anymore
com.vaadin.flow.theme.AbstractTheme.translateUrl(String)	No translation of the url will be done in 25
com.vaadin.flow.theme.Theme.variant()	Use ColorScheme annotation instead

Deprecated Constructors

Constructor	Description
com.vaadin.flow.signals.shared.SharedListSignal(SignalTree, Id, CommandValidator, Class<T>)	use SharedListSignal(SignalTree, Id, CommandValidator, JavaType) instead, which also retains the type arguments of a parameterized element type such as Set<String>
com.vaadin.flow.signals.shared.SharedMapSignal(SignalTree, Id, CommandValidator, Class<T>)	use SharedMapSignal(SignalTree, Id, CommandValidator, JavaType) instead, which also retains the type arguments of a parameterized element type such as Set<String>
com.vaadin.flow.signals.shared.SharedValueSignal(SignalTree, Id, CommandValidator, Class<T>)	use SharedValueSignal(SignalTree, Id, CommandValidator, JavaType) instead, which also retains the type arguments of a parameterized value type such as Set<String>

Deprecated Annotation Interface Elements

Annotation Interface Element	Description
com.vaadin.flow.component.dependency.CssImport.id()	The generated 'dom-module' relies on the legacy Polymer styling mechanism. Component styling can be done entirely with normal "light DOM" CSS: drop this attribute and import the CSS file given as CssImport.value() as plain CSS.
com.vaadin.flow.component.dependency.CssImport.include()	The generated 'custom-style' relies on the legacy Polymer styling mechanism. Component styling can be done entirely with normal "light DOM" CSS: drop this attribute and put the rules that were pulled in from the included module into the CSS file given as CssImport.value().
com.vaadin.flow.component.dependency.CssImport.themeFor()	Component styling can be done entirely with normal "light DOM" CSS.
com.vaadin.flow.theme.Theme.variant()	Use ColorScheme annotation instead