Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hm21/ngx-image-hero
A package to implement hero animations, allowing users to click on images and smoothly zoom them into a larger, immersive view, enhancing the user experience and interaction with images.
https://github.com/hm21/ngx-image-hero
angular angular2 animation hero image zoom
Last synced: 4 months ago
JSON representation
A package to implement hero animations, allowing users to click on images and smoothly zoom them into a larger, immersive view, enhancing the user experience and interaction with images.
- Host: GitHub
- URL: https://github.com/hm21/ngx-image-hero
- Owner: hm21
- License: mit
- Created: 2023-12-19T10:29:55.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-05-23T07:48:21.000Z (8 months ago)
- Last Synced: 2024-05-23T08:52:54.003Z (8 months ago)
- Topics: angular, angular2, animation, hero, image, zoom
- Language: TypeScript
- Homepage:
- Size: 3.52 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-angular - ngx-image-hero - A package to implement hero animations, allowing users to click on images and smoothly zoom them into a larger, immersive view, enhancing the user experience and interaction with images. (Table of contents / Third Party Components)
- fucking-awesome-angular - ngx-image-hero - A package to implement hero animations, allowing users to click on images and smoothly zoom them into a larger, immersive view, enhancing the user experience and interaction with images. (Table of contents / Third Party Components)
- fucking-awesome-angular - ngx-image-hero - A package to implement hero animations, allowing users to click on images and smoothly zoom them into a larger, immersive view, enhancing the user experience and interaction with images. (Table of contents / Third Party Components)
README
Angular Image-Hero Animation
[](https://badge.fury.io/js/ngx-image-hero)
[](https://badge.fury.io/js/ngx-image-hero)
[](https://badge.fury.io/js/ngx-image-hero)
[](https://opensource.org/licenses/MIT)
[](https://github.com/hm21/ngx-image-hero/issues)
[](https://ngx-hm21.web.app/image-hero)
This package is similar to the popular Flutter Hero animations.
## Table of contents
- [About](#about)
- [Getting started](#getting-started)
- [Documentation](#documentation)
- [Example](#example)
- [Contributing](#contributing)
- [License](LICENSE)
## About
A package to implement hero animations, allowing users to click on images and smoothly zoom them into a larger, immersive view, enhancing the user experience and interaction with images.
## Getting started
### Installation
```sh
npm install ngx-image-hero
```
### Import the directive
```typescript
import { Component } from "@angular/core";
import { NgxImageHeroDirective } from "ngx-image-hero";
@Component({
selector: "app-root",
standalone: true,
templateUrl: "./app.component.html",
styleUrl: "./app.component.scss",
imports: [NgxImageHeroDirective],
})
export class AppComponent {}
```
Documentation
### Inputs
| Option | Type | Default | Comment |
| :----------------- | :------------ | :--------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
| highQualityPath | string | | The path to the high-quality image or content to be displayed, which seamlessly replaces the current picture when opened. |
| fixedHero | boolean | false | Specifies whether to use the fixed-hero mode when absolute positioning is not effective due to overflow issues. |
| supportedFormats | string[] | | An array of supported image formats, which is only required when using the `` element where the browser automatically selects the format. |
| backdropPosition | 'documentEnd' | 'beforeHeroItem' | 'documentEnd' | Insert backdrop at this position. |
| browserSupportAvif | boolean | | If you have already manually determined whether the browser supports AVIF, you can set it using this option. Otherwise, the package will automatically perform the check. This option is only required when `supportedFormats` contains values. |
| browserSupportWebP | boolean | | If you have already manually determined whether the browser supports WebP, you can set it using this option. Otherwise, the package will automatically perform the check. This option is only required when `supportedFormats` contains values. |
### Outputs
| Option | Type | Comment |
| :-------- | :------------------- | :---------------------------------------- |
| openHero | EventEmitter\ | Triggered when the hero animation starts. |
| closeHero | EventEmitter\ | Triggered when the hero animation ends. |
Example
#### Simple example
```html
```
#### Complete example demonstrating all properties
```html
@for (format of imgFormats; track format) {
}
```
## Contributing
I welcome contributions from the open-source community to make this project even better. Whether you want to report a bug, suggest a new feature, or contribute code, I appreciate your help.
### Bug Reports and Feature Requests
If you encounter a bug or have an idea for a new feature, please open an issue on my [GitHub Issues](https://github.com/hm21/ngx-image-hero/issues) page. I will review it and discuss the best approach to address it.
### Code Contributions
If you'd like to contribute code to this project, please follow these steps:
1. Fork the repository to your GitHub account.
2. Clone your forked repository to your local machine.
```bash
git clone https://github.com/hm21/ngx-scroll-animations.git
```