@angular/router

withInMemoryScrolling

function

stable

Enables customizable scrolling behavior for router navigations.

API

function withInMemoryScrolling(
  options?: InMemoryScrollingOptions,
): InMemoryScrollingFeature;

withInMemoryScrolling

InMemoryScrollingFeature

Enables customizable scrolling behavior for router navigations.

@paramoptionsInMemoryScrollingOptions

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

@returnsInMemoryScrollingFeature

Usage Notes

Basic example of how you can enable scrolling feature:

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