Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/derstimmler/ngx-easy-view-transitions
Angular library for easier use of the View Transitions API
https://github.com/derstimmler/ngx-easy-view-transitions
angular animations library ngx npm typescript view-transitions view-transitions-api
Last synced: about 2 months ago
JSON representation
Angular library for easier use of the View Transitions API
- Host: GitHub
- URL: https://github.com/derstimmler/ngx-easy-view-transitions
- Owner: DerStimmler
- License: mit
- Created: 2023-11-16T22:59:23.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-31T19:22:28.000Z (7 months ago)
- Last Synced: 2024-10-29T01:38:25.648Z (about 2 months ago)
- Topics: angular, animations, library, ngx, npm, typescript, view-transitions, view-transitions-api
- Language: TypeScript
- Homepage: https://derstimmler.github.io/ngx-easy-view-transitions/
- Size: 282 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ngx-easy-view-transitions
[](https://www.npmjs.org/package/ngx-easy-view-transitions/)
[](https://www.npmjs.org/package/ngx-easy-view-transitions/)
[](https://github.com/DerStimmler/ngx-easy-view-transitions/blob/main/LICENSE.md)
Angular library for easier use of the View Transitions API
## Demo
https://derstimmler.github.io/ngx-easy-view-transitions/
## Installation
Available on [npm](https://www.npmjs.org/package/ngx-easy-view-transitions/).
```bash
npm install ngx-easy-view-transitions
```
You have to enable Angulars built-in view transitions in the Router using the [`withViewTransitions()`](https://angular.io/api/router/withViewTransitions#usage-notes) function.
```typescript
bootstrapApplication(AppComponent,
{
providers: [
provideRouter(appRoutes, withViewTransitions())
]
}
);
```
## Usage
### Morph elements
To morph an element during navigation from the old to the new state use the `transitionName` directive and provide the same name on both pages.
```typescript
import { TransitionNameDirective } from 'ngx-easy-view-transitions';
```
`users.component.html`
```angular2html
```
`user.component.html`
```angular2html
```
Note that each `transitionName` must be unique for a page.
### Customize animations
Instead of morphing an element, you can provide custom animations for entering and leaving the view using the `inAnimation` and `outAnimation` inputs.
There are two ways to provide a custom animations: As CSS `@keyframes` rule or [`Keyframe`](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API/Keyframe_Formats) array.
#### Using CSS @keyframes
You can simply use a CSS [`@keyframes`](https://developer.mozilla.org/en-US/docs/Web/CSS/@keyframes) rule from your CSS:
```css
@keyframes fadeIn {
from {
opacity: 0;
}
to {
opacity: 1;
}
}
```
```typescript
inAnimation = { keyframeName: 'fadeIn', duration: 600 };
outAnimation = { keyframeName: 'fadeIn', duration: 600, reverse: true };
```
```angular2html
```
#### Using Keyframe array
When you want to use typed objects instead of CSS you can provide a [`Keyframe`](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API/Keyframe_Formats) array:
```typescript
const fadeIn: Keyframe[] = [
{
opacity: 0,
offset: 0,
},
{
opacity: 1,
offset: 1,
},
];
```
```typescript
inAnimation = { keyframes: fadeIn, duration: 600 };
outAnimation = { keyframes: fadeIn, duration: 600, reverse: true };
```
```angular2html
```
### Built-In animations
To start faster there are some built-in animations available under `DefaultTransitions.*`.
```typescript
import { DefaultTransitions } from 'ngx-easy-view-transitions';
inAnimation = { keyframes: DefaultTransitions.fadeInUp, duration: 600 };
```
You can see them in the [demo](https://derstimmler.github.io/ngx-easy-view-transitions/animations) and [here](https://github.com/DerStimmler/ngx-easy-view-transitions/blob/main/ngx-easy-view-transitions/src/lib/default-transitions.ts).
### Exclude element from view transitions
When you want to exclude an element form view transitions you can add the `noTransition` directive.
```typescript
import { NoTransitionDirective } from 'ngx-easy-view-transitions';
```
```angular2html
```
### Configure default transition
By default View Transitions API will perform a cross-fade animation on all elements.
But you can also provide your own in and out animations by adding the `provideDefaultViewTransition()` provider function.
In the following example the default animation gets disabled:
```typescript
bootstrapApplication(AppComponent,
{
providers: [
provideRouter(appRoutes, withViewTransitions()),
provideDefaultViewTransition(
{ keyframes: DefaultTransitions.none, duration: 0 },
{ keyframes: DefaultTransitions.none, duration: 0 }
)
]
}
);
```
## Development
Install dependencies with: `pnpm install`
Run `pnpm demo` to run the demo app on a local development server.
You can access it on http://localhost:4200.
Run `pnpm test` to test all projects.
Run `pnpm lint` to lint all projects.
Run `pnpm build` to build all projects. You can find the output under `/dist`.
Since it's a nx workspace you can use the common nx commands for everything else.