@ng-web-apis/view-transition
TypeScript icon, indicating that this package has built-in type declarations

4.12.0 • Public • Published

ng-web-apis logo View Transition API for Angular

npm version npm bundle size codecov

This service is an abstraction over view transition API for Angular

Install

npm i @ng-web-apis/view-transition

How to use

  1. Import the ViewTransitionService into your Angular component or service where you want to use it.
import {ViewTransitionService} from '@ng-web-apis/view-transition';
  1. Inject the ViewTransitionService into your component's constructor or with inject (Angular 14+).
// in constructor
constructor(private viewTransitionService: ViewTransitionService) {}

// via inject
viewTransitionService = inject(ViewTransitionService);
  1. Use the startViewTransition method to initiate a view transition. This method takes a callback function that returns a Promise<void> or void. You can perform any necessary DOM changing logic within this callback.
startTransition() {
  this.viewTransitionService.startViewTransition(() => {
    // Your DOM changing logic goes here
    return this.animateTransition();
  }).subscribe({
    next: (transition) => {
      // Callback is done and transition is about to begin
      console.log('View transition is about to begin:', transition);
    },
    complete: () => {
      console.log('View transition completed');
    },
    error: (error) => {
      // Handle any errors that occur during the transition
      console.error('View transition error:', error);
    },
  });
}

Demo

You can try online demo here

See also

Other Web APIs for Angular by @ng-web-apis

Package Sidebar

Install

npm i @ng-web-apis/view-transition

Weekly Downloads

21

Version

4.12.0

License

Apache-2.0

Unpacked Size

28.2 kB

Total Files

11

Last publish

Collaborators

  • marsibarsi
  • waterplea
  • vladimir.potekhin
  • defenderbass