Skip to content
Merged
Show file tree
Hide file tree
Changes from 15 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 3 additions & 31 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1,32 +1,4 @@
# Displaying a sponsor button in your repository
# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository

# LFX Mentorship (formerly CommunityBridge)
# https://lfx.linuxfoundation.org/tools/mentorship
community_bridge:
# GitHub Sponsors
# https://github.com/sponsors
github: [ProAngular, CodyTolene]
# IssueHunt
# https://issuehunt.io/
issuehunt:
# Ko-fi
# https://ko-fi.com/
ko_fi:
# Liberapay
# https://en.liberapay.com/
liberapay:
# Open Collective
# https://opencollective.com/
open_collective:
# Otechie
# https://otechie.com/
otechie:
# Patreon
# https://www.patreon.com/
patreon:
# Tidelift
# https://tidelift.com/
tidelift:
# Custom URL
github: [CodyTolene, ProAngular]
buy_me_a_coffee: CodyTolene
patreon: CodyTolene
custom: ['https://www.paypal.me/CodyTolene']
2 changes: 2 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ public/
# Do not ignore the following files
!.github/
!src/
!src/**
!src/**/*
!README.md

# Re-ignore sub-directories from the above exempt directories:
Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,17 +152,17 @@ Customization with optional inputs and icon

## 📚 Component API <a name="api"></a>

| Input | Value Typing | Default Value | Description |
| ---------------------- | --------------------- | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| **backgroundColor** | string | `'#0D58C0'` (dark-blue) | Background color of the back to top button. Define any `'x'` css property available for `'background-color: x'`. |
| **bottomOffset** | string \| number | `'0px'` | Offset `px` from bottom of page when scrolled to bottom. For example this can be used to make sure the back to top button never overlaps a footer. |
| **displayAtYPosition** | string \| number | `'420px'` | The back to top button will not be displayed until the user scrolls to the provided Y (vertical `px`) coordinate on the page. |
| **fontColor** | string | `'#FFFFFF'` (white) | The font color for the nested content within the back to top button. Define any `'x'` css property available for `'color: x'`. |
| **fontSize** | string | `'16px'` | The font size for the nested content within the back to top button. Define any `'x'` css property available for `'font-size: x'`. |
| **height** | string | `'40px'` | Height of back to top button in string px format. |
| **position** | `'left'` \| `'right'` | `'right'` | Position on-screen where the back to top button is displayed. |
| **width** | string | `'40px'` | Width of back to top button in string px format. |
| **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. |
| Input | Value Typing | Default Value | Description |
| ---------------------- | ---------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| **backgroundColor** | string | #0D58C0 | Background color of the back to top button. Define any 'x' css property available for 'background-color: x'. |
| **bottomOffset** | string \| number | 0px | Offset px from bottom of page when scrolled to bottom. For example this can be used to make sure the back to top button never overlaps a footer. |
| **displayAtYPosition** | string \| number | 420px | The back to top button will not be displayed until the user scrolls to the provided Y (vertical px) coordinate on the page. |
| **fontColor** | string | #FFFFFF | The font color for the nested content within the back to top button. Define any 'x' css property available for 'color: x'. |
| **fontSize** | string | 16px | The font size for the nested content within the back to top button. Define any 'x' css property available for 'font-size: x'. |
| **height** | string | 32px \| 1rem | Height of back to top button in string format. |
| **position** | left \| right | right | Position on-screen where the back to top button is displayed. |
| **width** | string | 32px \| 1rem | Width of back to top button in string format. |
| **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. |

<p align="right">[ <a href="#index">🔍 Index</a> ]</p>

Expand Down
Loading
Loading