Skip to content

Commit 07eb5da

Browse files
committed
chore(update): beta release 2.0.0-beta.1 β
1 parent 1eea1a8 commit 07eb5da

File tree

3 files changed

+27
-6
lines changed

3 files changed

+27
-6
lines changed

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "ngx-scrolltop",
3-
"version": "1.0.0",
3+
"version": "2.0.0-rc.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": {
@@ -14,6 +14,7 @@
1414
"clean:schematics": "rm -rf dist/ngx-scrolltop/schematics/",
1515
"deploy:ghpages": "yarn build && yarn build:example && ngh --dir=dist/example",
1616
"publish:npmjs": "npm run syncprojects && npm run build && npm publish --folder dist/ngx-scrolltop",
17+
"publish:next": "yarn && yarn syncprojects && yarn build && yarn build:schematics && yarn test --configuration=ci && npm publish --folder dist/ngx-scrolltop --tag next",
1718
"gpr:setup": "yarn ts-node --project scripts/tsconfig.ts-node.json scripts/gpr-setup",
1819
"test": "ng test",
1920
"lint": "ng lint",

projects/ngx-scrolltop/README.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,11 @@
88
![](https://github.com/bartholomej/ngx-scrolltop/workflows/Build%20&%20Tests%20&%20Publish/badge.svg)
99
[![volkswagen status](https://auchenberg.github.io/volkswagen/volkswargen_ci.svg?v=1)](https://github.com/auchenberg/volkswagen)
1010

11-
> Lightweight, **Material Design inspired button for scroll-to-top** of the page. No dependencies. **Pure Angular!**
11+
> Lightweight, **Material Design inspired button for scroll-to-top** of the page.
12+
> No dependencies.
13+
> **Pure Angular!**
1214
13-
> ✓ Angular 10, Ivy and SSR compatible
15+
> ✓ Angular 10, Ivy and Angular Universal (SSR) compatible
1416
1517
Just hit the button to smoothly scroll back to the top of the page. [Here's the demo.](http://bartholomej.github.io/ngx-scrolltop/)
1618

@@ -102,10 +104,28 @@ In **app.component.html** you just need to add your new button. Usually at the e
102104
| **backgroundColor** | string | #212121 | Background color (you can use all values for `backgroud-color` css property). _You can override `theme` color_ |
103105
| **symbolColor** | string | #fafafa | Symbol color (you can use all values for `fill` svg property). _You can override `theme` color_ |
104106
| **size** | number | 40 | Button size [in pixels]. _(Symbol will be resized automatically_) |
105-
| **symbol** | string | | You can use utf8 chars for customizing symbol. For example: `` |
107+
| ~~**symbol**~~ | ~~string~~ | | ~~You can use utf8 chars for customizing symbol. For example: ``~~ Removed in v2.0.0. Use _content projection_. See example [here](#symbol) |
106108
| **position** | 'left' \| 'right' | 'right' | Left or right, that is the question... |
107109
| **theme** | [NgxScrollTopTheme](projects/ngx-scrolltop/src/lib/ngx-scrolltop.interface.ts) | 'gray' | Material color themes |
108110

111+
#### Symbol
112+
113+
Since version v2.0.0 you can use _content projection_ for your own symbol.
114+
115+
```html
116+
<ngx-scrolltop>
117+
118+
</ngx-scrolltop>
119+
```
120+
121+
Or you can even use your own components or fonts (e.g. fontAwesome)
122+
123+
```html
124+
<ngx-scrolltop>
125+
<i class="fa fa-arrow-up"></i>
126+
</ngx-scrolltop>
127+
```
128+
109129
### Directive
110130

111131
| Option | Type | Default | Description |
@@ -123,11 +143,11 @@ In **app.component.html** you just need to add your new button. Usually at the e
123143
[size]="50"
124144
backgroundColor="#33691e"
125145
symbolColor="#fff"
126-
symbol=""
127146
mode="smart"
128147
position="left"
129148
theme="pink"
130149
>
150+
131151
</ngx-scrolltop>
132152
```
133153

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": "1.0.0",
3+
"version": "2.0.0-rc.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)