You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](https://gitter.im/ProAngular/community)
15
-
[](https://github.com/ProAngular/ngx-scroll-top/actions/workflows/on-merge-main-deploy-gpr.yml)
16
-
[](https://github.com/ProAngular/ngx-scroll-top/actions/workflows/on-merge-main-deploy-npmjs.yml)
@@ -51,7 +79,19 @@ Import `NgxScrollTopModule` where needed
51
79
export class AppModule { }
52
80
```
53
81
54
-
# Usage
82
+
<aname="dependencies"/>
83
+
84
+
## Dependencies
85
+
86
+
### Styling UX - Angular Material
87
+
88
+
You should have an Angular Material theme set up prior to using this. It's also possible to use this without an angular theme and style it yourself entirely!
89
+
90
+
More information on theming Angular Material: https://material.angular.io/guide/theming
91
+
92
+
<aname="usage"/>
93
+
94
+
## Usage
55
95
56
96
Default (blue button with white icon)
57
97
```html
@@ -73,7 +113,9 @@ Customization with optional inputs and icon
73
113
>⇮</ngx-scroll-top>
74
114
```
75
115
76
-
# Component API
116
+
<aname="api"/>
117
+
118
+
## Component API
77
119
78
120
| Input | Value Typing | Default Value | Description |
@@ -87,15 +129,19 @@ Customization with optional inputs and icon
87
129
|**width**| string |`'40px'`| Width of back to top button in string px format. |
88
130
|**zIndex**| number |`999`| Style the `z-index` for the back to top button as needed for correct layer height adjustment. This can be useful when working with sticky headers. |
89
131
90
-
# Compatibility
132
+
<aname="compatibility"/>
133
+
134
+
## Compatibility
91
135
92
136
| Angular version |@proangular/ngx-scroll-top| Install |
Please submit all issues, and feature requests here: [https://github.com/ProAngular/ngx-scroll-top/issues](https://github.com/ProAngular/ngx-scroll-top/issues)
101
147
@@ -115,13 +161,17 @@ Contribution:
115
161
116
162
Thank you for any and all contributions!
117
163
118
-
# Donation
164
+
<aname="donations"/>
165
+
166
+
## Donation
119
167
120
168
As a husband and father of four children, your donations mean the world to me! Any donations are greatly appreciated and keep me going!
0 commit comments