Skip to content

Commit b8de66b

Browse files
bartholomejbartholomej
committed
chore(update): patch release 0.3.1 🐛
1 parent 3038477 commit b8de66b

File tree

3 files changed

+29
-16
lines changed

3 files changed

+29
-16
lines changed

‎package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "ngx-scrolltop",
3-
"version": "0.3.0",
3+
"version": "0.3.1",
44
"description": "Lightweight, Material Design inspired button for scroll-to-top of the page. No dependencies. Pure Angular!",
55
"author": "Lukas Bartak <[email protected]> (https://github.com/bartholomej)",
66
"scripts": {

‎projects/ngx-scrolltop/README.md

Lines changed: 27 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[![Join the chat at https://gitter.im/ngx-scrolltop/Lobby](https://badges.gitter.im/ngx-scrolltop/Lobby.svg)](https://gitter.im/ngx-scrolltop/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
22
[![volkswagen status](https://auchenberg.github.io/volkswagen/volkswargen_ci.svg?v=1)](https://github.com/auchenberg/volkswagen)
33

4-
# Angular ScrollTop Button (alpha version)
4+
# Angular ScrollTop Button
55

66
Lightweight, **Material Design inspired button for scroll-to-top** of the page. No dependencies. **Pure Angular!**
77

@@ -12,7 +12,7 @@ Just hit the button to smoothly scroll back to the top of the page. [Here's the
1212
- Lightweight
1313
- Material Design inspired
1414
- Smoothly animated
15-
- Customizable
15+
- Highly customizable
1616
- With some useful [options](#settings)...
1717

1818
![Demo animation](https://github.com/bartholomej/material-scrollTop/blob/master/demo/images/material-scrolltop-animation.gif)
@@ -24,13 +24,25 @@ Watch this: [http://bartholomej.github.io/ngx-scrolltop/
2424

2525
## Install
2626

27+
### Automatically (recommended) 🚀
28+
29+
```bash
30+
ng add ngx-scrolltop
31+
```
32+
33+
_Module imported and all settings automatically set in your project._
34+
35+
_Now just see some [options](#options)_
36+
37+
### Manually (alternatively) 🛠
38+
2739
Via **yarn** or **npm**
2840

2941
```bash
3042
yarn add ngx-scrolltop # npm install ngx-scrolltop --save
3143
```
3244

33-
## Setup
45+
### Setup
3446

3547
```js
3648
...
@@ -48,7 +60,7 @@ import { NgxScrollTopModule } from 'ngx-scrolltop';
4860
export class AppModule { }
4961
```
5062

51-
## Usage
63+
### Usage
5264

5365
In **app.component.html** you just need to add your new button. Usually at the end of file.
5466

@@ -58,15 +70,15 @@ In **app.component.html** you just need to add your new button. Usually at the e
5870

5971
## Options
6072

61-
| Option | Type | Default | Description |
62-
| --------------- | ------------------------------------------------------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
63-
| mode | 'smart', 'classic' | 'classic' | **Smart** mode shows button only when you scroll more than two screens down and then you will try to go back to top. **Classic** mode shows button immediately when you scroll at least one screen down. |
64-
| backgroundColor | string | #212121 | Background color (you can use all values for `backgroud-color` css property) |
65-
| symbolColor | string | #fafafa | Symbol color (you can use all values for `fill` svg property) |
66-
| size | number | 40 | Button size(in pixels). Symbol will be resized automatically. |
67-
| symbol | string | | You can use utf8 chars for customizing symbol. For example: `↑` |
68-
| position | 'left', 'right' | 'right' | Left or right, that is the question. |
69-
| theme | [NgxScrolltopTheme](projects/ngx-scrolltop/src/lib/ngx-scrolltop.interfaces.ts) | 'gray' | Material color themes |
73+
| Option | Type | Default | Description |
74+
| ------------------- | ------------------------------------------------------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
75+
| **mode** | 'smart' \| 'classic' | 'classic' | **Smart** mode shows button only when you scroll more than two screens down and then you will try to go back to top. **Classic** mode shows button immediately when you scroll at least one screen down. |
76+
| **backgroundColor** | string | #212121 | Background color (you can use all values for `backgroud-color` css property) |
77+
| **symbolColor** | string | #fafafa | Symbol color (you can use all values for `fill` svg property) |
78+
| **size** | number | 40 | Button size [in pixels]. _(Symbol will be resized automatically_) |
79+
| **symbol** | string | | You can use utf8 chars for customizing symbol. For example: `↑` |
80+
| **position** | 'left' \| 'right' | 'right' | Left or right, that is the question... |
81+
| **theme** | [NgxScrolltopTheme](projects/ngx-scrolltop/src/lib/ngx-scrolltop.interfaces.ts) | 'gray' | Material color themes |
7082

7183
### Options: Example
7284

@@ -80,13 +92,14 @@ In **app.component.html** you just need to add your new button. Usually at the e
8092
symbol="↑"
8193
mode="smart"
8294
position="left"
95+
theme="pink"
8396
>
8497
</ngx-scrolltop>
8598
```
8699

87100
## Dependencies
88101

89-
No dependencies
102+
No dependencies! Pure Angular.
90103

91104
## License
92105

‎projects/ngx-scrolltop/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "ngx-scrolltop",
3-
"version": "0.3.0",
3+
"version": "0.3.1",
44
"description": "Lightweight, Material Design inspired button for scroll-to-top of the page. No dependencies. Pure Angular!",
55
"author": "Lukas Bartak <[email protected]> (https://github.com/bartholomej)",
66
"peerDependencies": {

0 commit comments

Comments
 (0)