Deprecated API

Contents

• Deprecated Interfaces
• Deprecated Classes
• Deprecated Annotation Types
• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors
• Deprecated Enum Constants
• Deprecated Annotation Type Elements

Deprecated Interfaces

Interface and Description
com.vaadin.flow.server.FallibleCommand this command is an internal command and is not supposed to be used in application code
com.vaadin.flow.component.page.Page.ExecutionCanceler superseded by PendingJavaScriptResult

Deprecated Classes

Class and Description
com.vaadin.flow.component.internal.HtmlDependencyParser Due for removal because of additional cache layer
com.vaadin.flow.router.internal.RouterUtil This is an internal class for Flow and should not be used outside. This is deprecated since 1.3 and will be removed in later versions of Flow.
com.vaadin.flow.server.ServletHelper Use HandlerHelper instead

Deprecated Annotation Types

Annotation Type and Description
com.vaadin.flow.server.VaadinServletConfiguration Leftover from Vaadin Framework 8 where the developer typically defines their own servlet class. Starting from Flow 1.0, a servlet is automatically registered and this annotation serves very little purpose.

Deprecated Fields

Field and Description
com.vaadin.flow.server.Constants.COMPILED_WEB_COMPONENTS_PATH Use InitParameters.COMPILED_WEB_COMPONENTS_PATH instead.
com.vaadin.flow.server.Constants.DISABLE_AUTOMATIC_SERVLET_REGISTRATION Use InitParameters.DISABLE_AUTOMATIC_SERVLET_REGISTRATION instead.
com.vaadin.flow.server.Constants.DISABLE_WEBJARS Use InitParameters.DISABLE_WEBJARS instead.
com.vaadin.flow.server.Constants.EXTERNAL_STATS_FILE Use InitParameters.EXTERNAL_STATS_FILE instead.
com.vaadin.flow.server.Constants.EXTERNAL_STATS_URL Use InitParameters.EXTERNAL_STATS_URL instead.
com.vaadin.flow.server.Constants.FRONTEND_URL_ES5 Use InitParameters.FRONTEND_URL_ES5 instead.
com.vaadin.flow.server.Constants.FRONTEND_URL_ES6 Use InitParameters.FRONTEND_URL_ES6 instead.
com.vaadin.flow.server.Constants.I18N_PROVIDER Use InitParameters.I18N_PROVIDER instead.
com.vaadin.flow.server.Constants.LOAD_ES5_ADAPTERS Use InitParameters.LOAD_ES5_ADAPTERS instead.
com.vaadin.flow.server.Constants.REQUIRE_HOME_NODE_EXECUTABLE Use InitParameters.REQUIRE_HOME_NODE_EXECUTABLE instead.
com.vaadin.flow.server.InitParameters.SERVLET_PARAMETER_BOWER_MODE the parameter is renamed to InitParameters.SERVLET_PARAMETER_COMPATIBILITY_MODE
com.vaadin.flow.server.Constants.SERVLET_PARAMETER_BOWER_MODE Use InitParameters.SERVLET_PARAMETER_COMPATIBILITY_MODE instead.
com.vaadin.flow.server.Constants.SERVLET_PARAMETER_BROTLI Use InitParameters.SERVLET_PARAMETER_BROTLI instead.
com.vaadin.flow.server.Constants.SERVLET_PARAMETER_CLOSE_IDLE_SESSIONS Use InitParameters.SERVLET_PARAMETER_CLOSE_IDLE_SESSIONS instead.
com.vaadin.flow.server.Constants.SERVLET_PARAMETER_COMPATIBILITY_MODE Use InitParameters.SERVLET_PARAMETER_COMPATIBILITY_MODE instead.
com.vaadin.flow.server.Constants.SERVLET_PARAMETER_DEVMODE_ENABLE_LIVE_RELOAD Use InitParameters.SERVLET_PARAMETER_DEVMODE_ENABLE_LIVE_RELOAD instead.
com.vaadin.flow.server.Constants.SERVLET_PARAMETER_DEVMODE_OPTIMIZE_BUNDLE Use InitParameters.SERVLET_PARAMETER_DEVMODE_OPTIMIZE_BUNDLE instead.
com.vaadin.flow.server.Constants.SERVLET_PARAMETER_DEVMODE_TRANSPILE Use InitParameters.SERVLET_PARAMETER_DEVMODE_TRANSPILE instead.
com.vaadin.flow.server.Constants.SERVLET_PARAMETER_DEVMODE_WEBPACK_ERROR_PATTERN Use InitParameters.SERVLET_PARAMETER_DEVMODE_WEBPACK_ERROR_PATTERN instead.
com.vaadin.flow.server.Constants.SERVLET_PARAMETER_DEVMODE_WEBPACK_OPTIONS Use InitParameters.SERVLET_PARAMETER_DEVMODE_WEBPACK_OPTIONS instead.
com.vaadin.flow.server.Constants.SERVLET_PARAMETER_DEVMODE_WEBPACK_SUCCESS_PATTERN Use InitParameters.SERVLET_PARAMETER_DEVMODE_WEBPACK_SUCCESS_PATTERN instead.
com.vaadin.flow.server.Constants.SERVLET_PARAMETER_DEVMODE_WEBPACK_TIMEOUT Use InitParameters.SERVLET_PARAMETER_DEVMODE_WEBPACK_TIMEOUT instead.
com.vaadin.flow.server.Constants.SERVLET_PARAMETER_DISABLE_XSRF_PROTECTION Use InitParameters.SERVLET_PARAMETER_DISABLE_XSRF_PROTECTION instead.
com.vaadin.flow.server.Constants.SERVLET_PARAMETER_ENABLE_DEV_SERVER Use InitParameters.SERVLET_PARAMETER_ENABLE_DEV_SERVER instead.
com.vaadin.flow.server.Constants.SERVLET_PARAMETER_ENABLE_PNPM Use InitParameters.SERVLET_PARAMETER_ENABLE_PNPM instead.
com.vaadin.flow.server.Constants.SERVLET_PARAMETER_HEARTBEAT_INTERVAL Use InitParameters.SERVLET_PARAMETER_HEARTBEAT_INTERVAL instead.
com.vaadin.flow.server.Constants.SERVLET_PARAMETER_JSBUNDLE Use InitParameters.SERVLET_PARAMETER_JSBUNDLE instead.
com.vaadin.flow.server.Constants.SERVLET_PARAMETER_MAX_MESSAGE_SUSPEND_TIMEOUT Use InitParameters.SERVLET_PARAMETER_MAX_MESSAGE_SUSPEND_TIMEOUT instead.
com.vaadin.flow.server.Constants.SERVLET_PARAMETER_POLYFILLS Use InitParameters.SERVLET_PARAMETER_POLYFILLS instead.
com.vaadin.flow.server.Constants.SERVLET_PARAMETER_PRODUCTION_MODE Use InitParameters.SERVLET_PARAMETER_PRODUCTION_MODE instead.
com.vaadin.flow.server.Constants.SERVLET_PARAMETER_PUSH_MODE Use InitParameters.SERVLET_PARAMETER_PUSH_MODE instead.
com.vaadin.flow.server.Constants.SERVLET_PARAMETER_PUSH_SUSPEND_TIMEOUT_LONGPOLLING Use InitParameters.SERVLET_PARAMETER_PUSH_SUSPEND_TIMEOUT_LONGPOLLING instead.
com.vaadin.flow.server.Constants.SERVLET_PARAMETER_PUSH_URL Use InitParameters.SERVLET_PARAMETER_PUSH_URL instead.
com.vaadin.flow.server.Constants.SERVLET_PARAMETER_REQUEST_TIMING Use InitParameters.SERVLET_PARAMETER_REQUEST_TIMING instead.
com.vaadin.flow.server.Constants.SERVLET_PARAMETER_REUSE_DEV_SERVER Use InitParameters.SERVLET_PARAMETER_REUSE_DEV_SERVER instead.
com.vaadin.flow.server.Constants.SERVLET_PARAMETER_SEND_URLS_AS_PARAMETERS Use InitParameters.SERVLET_PARAMETER_SEND_URLS_AS_PARAMETERS instead.
com.vaadin.flow.server.Constants.SERVLET_PARAMETER_STATISTICS_JSON Use InitParameters.SERVLET_PARAMETER_STATISTICS_JSON instead.
com.vaadin.flow.server.Constants.SERVLET_PARAMETER_SYNC_ID_CHECK Use InitParameters.SERVLET_PARAMETER_SYNC_ID_CHECK instead.
com.vaadin.flow.server.Constants.SERVLET_PARAMETER_WEB_COMPONENT_DISCONNECT Use InitParameters.SERVLET_PARAMETER_WEB_COMPONENT_DISCONNECT instead.
com.vaadin.flow.server.Constants.SHOULD_WORK_NODE_MAJOR_VERSION this is an internal constant, don't use it
com.vaadin.flow.server.Constants.SHOULD_WORK_NODE_MINOR_VERSION this is an internal constant, don't use it
com.vaadin.flow.server.Constants.SHOULD_WORK_NPM_MAJOR_VERSION this is an internal constant, don't use it
com.vaadin.flow.server.Constants.SHOULD_WORK_NPM_MINOR_VERSION this is an internal constant, don't use it
com.vaadin.flow.server.Constants.SUPPORTED_NODE_MAJOR_VERSION this is an internal constant, don't use it
com.vaadin.flow.server.Constants.SUPPORTED_NODE_MINOR_VERSION this is an internal constant, don't use it
com.vaadin.flow.server.Constants.SUPPORTED_NPM_MAJOR_VERSION this is an internal constant, don't use it
com.vaadin.flow.server.Constants.SUPPORTED_NPM_MINOR_VERSION this is an internal constant, don't use it
com.vaadin.flow.server.Constants.SUPPORTED_PNPM_MAJOR_VERSION this is an internal constant, don't use it
com.vaadin.flow.server.Constants.SUPPORTED_PNPM_MINOR_VERSION this is an internal constant, don't use it
com.vaadin.flow.server.VaadinSession.UI_PARAMETER Use InitParameters.UI_PARAMETER instead.
com.vaadin.flow.server.VaadinService.URL_PARAMETER_CLOSE_APPLICATION As of 7.0.
com.vaadin.flow.server.VaadinService.URL_PARAMETER_RESTART_APPLICATION As of 7.0.
com.vaadin.flow.server.Constants.USE_ORIGINAL_FRONTEND_RESOURCES Use InitParameters.USE_ORIGINAL_FRONTEND_RESOURCES instead.

Deprecated Methods

Method and Description
com.vaadin.flow.dom.Element.addEventListener(String, DomEventListener, String...) Instead, use the returned registration instance for adding event data expressions
com.vaadin.flow.component.page.Page.addJsModule(String, LoadMode) LoadMode is not functional with external JavaScript modules, as those are loaded as deferred due to type=module in scrip tag. Use Page.addJsModule(String) instead.
com.vaadin.flow.dom.Element.addSynchronizedProperty(String) Use Element.addPropertyChangeListener(String, String, PropertyChangeListener) or DomListenerRegistration.synchronizeProperty(String) instead.
com.vaadin.flow.dom.Element.addSynchronizedProperty(String, DisabledUpdateMode) Use Element.addPropertyChangeListener(String, String, PropertyChangeListener) or DomListenerRegistration.synchronizeProperty(String) instead.
com.vaadin.flow.dom.Element.addSynchronizedPropertyEvent(String) Use Element.addPropertyChangeListener(String, String, PropertyChangeListener) or DomListenerRegistration.synchronizeProperty(String) instead.
com.vaadin.flow.dom.Element.callFunction(String, Serializable...) Use Element.callJsFunction(String,Serializable...) instead since it also allows getting return value back.
com.vaadin.flow.component.page.Page.executeJavaScript(String, Serializable...) Use Page.executeJs(String,Serializable...) instead since it also allows getting return value back.
com.vaadin.flow.dom.Element.executeJavaScript(String, Serializable...) Use Element.executeJs(String,Serializable...) instead since it also allows getting return value back.
com.vaadin.flow.server.ServletHelper.findLocale(VaadinSession, VaadinRequest) Use HandlerHelper.findLocale(VaadinSession, VaadinRequest) instead
com.vaadin.flow.server.VaadinServlet.getApplicationUrl(HttpServletRequest) As of 1.0. Will be removed in 3.0.
com.vaadin.flow.theme.AbstractTheme.getBodyAttributes(String) use getHtmlAttributes(String) instead
com.vaadin.flow.server.ServletHelper.getCancelingRelativePath(String) Use HandlerHelper.getCancelingRelativePath(String) instead
com.vaadin.flow.server.ServletHelper.getContextRootRelativePath(VaadinServletRequest) Don't use this method since it's tied to VaadinServletRequest
com.vaadin.flow.server.startup.ApplicationRouteRegistry.getInstance(ServletContext) this is deprecated in favor of getInstance(VaadinContext) and will be removed in a future release
com.vaadin.flow.component.ShortcutRegistration.getOwner() This component has now multiple owners so this method has been replaced by #getOwners().
com.vaadin.flow.router.Router.getRoutes() Url handling is moved to RouteConfiguration.getAvailableRoutes()
com.vaadin.flow.router.Router.getRoutesByParent() No replacement.
com.vaadin.flow.router.BeforeEvent.getRouteTargetType() use BeforeEvent.getRerouteTargetType() instead.
com.vaadin.flow.dom.Element.getSynchronizedProperties() Use Element.addPropertyChangeListener(String, String, PropertyChangeListener) or DomListenerRegistration.synchronizeProperty(String) instead.
com.vaadin.flow.dom.Element.getSynchronizedPropertyEvents() Use Element.addPropertyChangeListener(String, String, PropertyChangeListener) or DomListenerRegistration.synchronizeProperty(String) instead.
com.vaadin.flow.router.Router.getUrl(Class<? extends C>, List<T>) Url handling is moved to RouteConfiguration.getUrl(Class, List)
com.vaadin.flow.router.Router.getUrl(Class<? extends C>, T) Url handling is moved to RouteConfiguration.getUrl(Class, Object)
com.vaadin.flow.router.Router.getUrl(Class<? extends Component>) Url handling is moved to RouteConfiguration.getUrl(Class)
com.vaadin.flow.router.Router.getUrlBase(Class<? extends Component>) Url base handling is moved to RouteConfiguration.getUrlBase(Class)
com.vaadin.flow.function.DeploymentConfiguration.isBowerMode() use DeploymentConfiguration.isCompatibilityMode()
com.vaadin.flow.server.WebBrowser.isIOS() isIOS will return the wrong value for iOS 13 and later. Use instead ExtendedClientDetails.isIOS()
com.vaadin.flow.shared.BrowserDetails.isIOS() isIOS will return the wrong value for iOS 13 and later
com.vaadin.flow.server.WebBrowser.isIPad() isIPad will return the wrong value for iOS 13 and later. Use instead ExtendedClientDetails.isIPad()
com.vaadin.flow.shared.BrowserDetails.isIPad() isIPad will return the wrong value for iOS 13 and later
com.vaadin.flow.server.ServletHelper.isRequestType(VaadinRequest, ServletHelper.RequestType) Use HandlerHelper.isRequestType(VaadinRequest, com.vaadin.flow.server.HandlerHelper.RequestType) instead
com.vaadin.flow.shared.BrowserDetails.isSafariOrIOS() will return the wrong value for iOS 13 and later. Use ExtendedClientDetails.isIOS() instead.
com.vaadin.flow.component.ShortcutRegistration.preventsDefault() Replaced by ShortcutRegistration.isBrowserDefaultAllowed() in 1.4
com.vaadin.flow.dom.Element.removeSynchronizedProperty(String) Use Element.addPropertyChangeListener(String, String, PropertyChangeListener) or DomListenerRegistration.synchronizeProperty(String) instead.
com.vaadin.flow.dom.Element.removeSynchronizedPropertyEvent(String) Use Element.addPropertyChangeListener(String, String, PropertyChangeListener) or DomListenerRegistration.synchronizeProperty(String) instead.
com.vaadin.flow.router.Router.resolve(Class<?>, Route) Use RouteUtil.resolve(Class, Route) instead
com.vaadin.flow.server.VaadinServlet.safeEscapeForHtml(String) As of 1.0. Will be removed in 3.0. Use Entities.escape(String) instead.
com.vaadin.flow.server.ServletHelper.setResponseNoCacheHeaders(BiConsumer<String, String>, BiConsumer<String, Long>) Use HandlerHelper.setResponseNoCacheHeaders(BiConsumer, BiConsumer) instead
com.vaadin.flow.component.internal.UIInternals.setTheme(AbstractTheme) use UIInternals.setTheme(Class) instead
com.vaadin.flow.component.ShortcutRegistration.stopsPropagation() Replaced by ShortcutRegistration.isEventPropagationAllowed() in 1.4
com.vaadin.flow.dom.Element.synchronizeProperty(String, String) Use Element.addPropertyChangeListener(String, String, PropertyChangeListener) or DomListenerRegistration.synchronizeProperty(String) instead.
com.vaadin.flow.dom.Element.synchronizeProperty(String, String, DisabledUpdateMode) Use Element.addPropertyChangeListener(String, String, PropertyChangeListener) or DomListenerRegistration.synchronizeProperty(String) instead.

Deprecated Constructors

Constructor and Description
com.vaadin.flow.router.BeforeEnterEvent(NavigationEvent, Class<?>) Use BeforeEnterEvent.BeforeEnterEvent(NavigationEvent, Class, List) instead.
com.vaadin.flow.router.BeforeEnterEvent(Router, NavigationTrigger, Location, Class<?>, UI) Use BeforeEnterEvent.BeforeEnterEvent(Router, NavigationTrigger, Location, Class, UI, List) instead.
com.vaadin.flow.router.BeforeEvent(NavigationEvent, Class<?>) Use BeforeEvent.BeforeEvent(NavigationEvent, Class, List) instead.
com.vaadin.flow.router.BeforeEvent(Router, NavigationTrigger, Location, Class<?>, UI) Use BeforeEvent.BeforeEvent(Router, NavigationTrigger, Location, Class, UI, List) instead.
com.vaadin.flow.router.BeforeLeaveEvent(NavigationEvent, Class<?>) Use BeforeLeaveEvent.BeforeLeaveEvent(NavigationEvent, Class, List) instead.
com.vaadin.flow.router.BeforeLeaveEvent(Router, NavigationTrigger, Location, Class<?>, UI) Use BeforeLeaveEvent.BeforeLeaveEvent(Router, NavigationTrigger, Location, Class, UI, List) instead.
com.vaadin.flow.dom.Element(String, boolean) The autoCreate parameter no longer has any effect. Use Element.Element(String) instead.
com.vaadin.flow.internal.ResponseWriter() Use ResponseWriter.ResponseWriter(DeploymentConfiguration) instead.
com.vaadin.flow.internal.ResponseWriter(int) This constructor is never used internally and might be removed.

Deprecated Enum Constants

Enum Constant and Description
com.vaadin.flow.component.KeyLocation.RIGTH

Deprecated Annotation Type Elements

Annotation Type Element and Description
com.vaadin.flow.component.dependency.JsModule.loadMode LoadMode does not function with JavaScript modules. If the module is local, it is included into the frontend resource bundle. If the module is external, it is loaded as deferred due to type=module in scrip tag.