Skip to content

Commit 683063f

Browse files
committed
Merge branch 'feature/upgrade_to_v8' into next
2 parents 001aea5 + b5846bd commit 683063f

File tree

13 files changed

+6116
-4861
lines changed

13 files changed

+6116
-4861
lines changed

.browserslistrc

Lines changed: 0 additions & 17 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
# Contributing
22

3+
* You'll find the parallax directive's source in [`/projects/ionic-header-parallax/src`](projects/ionic-header-parallax/src).
34
* The source code for the demo app [`/src`](src).
4-
* You'll find the library's source in [`/projects/ionic-header-parallax/src`](projects/ionic-header-parallax/src).
55

66
## Getting Started
7-
1. Do `npm start` to build and launch the app in watch mode.
8-
2. Do `npm run link` to link the demo app to the source library project.
7+
8+
In the root folder:
9+
1. Run `npm run watch` to build the directive in watch mode.
10+
1. Run `npm run link` to point the demo app to use the local directive's source.
11+
2. Run `ng serve` to launch the demo app.
12+

Readme.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,19 @@ This directive enables parallax effect on `ion-header` elements to display a cov
66

77
| Stack | Tag |
88
| -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
9+
| ![](https://img.shields.io/badge/-v8-white?logo=ionic) ![](https://img.shields.io/badge/-v16-red?logo=angular) | [6.x.x](https://www.npmjs.com/package/ionic-header-parallax?activeTab=versions) |
910
| ![](https://img.shields.io/badge/-v7-white?logo=ionic) ![](https://img.shields.io/badge/-v14-red?logo=angular) | [5.x.x](https://www.npmjs.com/package/ionic-header-parallax?activeTab=versions) |
1011
| ![](https://img.shields.io/badge/-v6-white?logo=ionic) ![](https://img.shields.io/badge/-v13-red?logo=angular) | [4.x.x](https://www.npmjs.com/package/ionic-header-parallax?activeTab=versions) |
1112
| ![](https://img.shields.io/badge/-v5-white?logo=ionic) ![](https://img.shields.io/badge/-v12-red?logo=angular) | [3.x.x](https://www.npmjs.com/package/ionic-header-parallax?activeTab=versions) |
1213
| ![](https://img.shields.io/badge/-v4-white?logo=ionic) ![](https://img.shields.io/badge/-v8-red?logo=angular) | [2.x.x](https://www.npmjs.com/package/ionic-header-parallax?activeTab=versions) |
1314

1415
## Live Demo
15-
Checkout the Live Demo [here](https://raschidjfr.github.io/ionic-header-parallax)
16-
17-
![](https://raw.githubusercontent.com/raschidJFR/ionic-header-parallax/5.0.0/img/ios.gif)
18-
![](https://raw.githubusercontent.com/raschidJFR/ionic-header-parallax/5.0.0/img/android.gif)
1916

17+
Checkout the Live Demo [here](https://raschidjfr.github.io/ionic-header-parallax)
2018

19+
| iOS | Android |
20+
| ----------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
21+
| ![](https://raw.githubusercontent.com/raschidJFR/ionic-header-parallax/5.0.0/img/ios.gif) | ![](https://raw.githubusercontent.com/raschidJFR/ionic-header-parallax/5.0.0/img/android.gif) |
2122

2223
## Set Up
2324

@@ -38,12 +39,7 @@ import { IonicHeaderParallaxModule } from 'ionic-header-parallax';
3839
Just add the attribute `parallax` to any `<ion-header>` element:
3940
4041
```html
41-
<ion-header
42-
parallax
43-
imageUrl="https://picsum.photos/350"
44-
height="350"
45-
bgPosition="top"
46-
>
42+
<ion-header parallax imageUrl="https://picsum.photos/350" height="350" bgPosition="top">
4743
<ion-toolbar color="primary">
4844
<ion-title> Parallax Header </ion-title>
4945
</ion-toolbar>
@@ -56,10 +52,10 @@ Just add the attribute `parallax` to any `<ion-header>` element:
5652
| ---------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
5753
| imageUrl | `string` | The background image to show while expanded. |
5854
| height | ` number \| string` | The height for the header when expanded. If the value is a number, it will be set in `px`. If the value is a string it will be passed as is (eg: `"20rem"`) |
59-
| color | `string` | The color (web hex formatted) to show while the header is expanded when no `imageUrl` is set. When scrolled it will fade to the toolbar's color. |
60-
| bgPosition | `'top' \| 'center' \| 'bottom'` | The position of the image in the header. This parameter slightly changes the feeling of the animation. |
55+
| color | `string` | The color (web hex formatted) to show while the header is expanded when no `imageUrl` is set. When scrolled, it will fade to the toolbar's color. |
56+
| bgPosition | `'top' \| 'center' \| 'bottom'` | The position of the image in the header. This parameter slightly changes the feeling of the animation. Default: `'top'` |
6157
6258
## Contributing
6359
6460
I don't plan to be maintaining this package full-time, but as I'm usually developing in Ionic I'll be glad to update it any time I make some upgrades for myself.
65-
Code contributions, issues and PRs are very welcome. Find the instructions in the [CONTRIBUTING.md](CONTRIBUTING.md) file.
61+
Code contributions, issues, and PRs are very welcome. Find the instructions in the [CONTRIBUTING.md](CONTRIBUTING.md) file.

0 commit comments

Comments
 (0)