Docs4dev
Docs
angular / 14 / api / router / withinmemoryscrolling.html

withInMemoryScrolling

function developer preview

Enables customizable scrolling behavior for router navigations.

withInMemoryScrolling(options: InMemoryScrollingOptions = {}): InMemoryScrollingFeature

Parameters
options InMemoryScrollingOptions

Set of configuration parameters to customize scrolling behavior, see InMemoryScrollingOptions for additional information.

Optional. Default is {}.
Returns

InMemoryScrollingFeature: A set of providers for use with provideRouter.

See also

Usage notes

Basic example of how you can enable scrolling feature:

const appRoutes: Routes = [];
bootstrapApplication(AppComponent,
  {
    providers: [
      provideRouter(appRoutes, withInMemoryScrolling())
    ]
  }
);

© 2010–2023 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://v14.angular.io/api/router/withInMemoryScrolling