Skip to content

Commit f6b8ce0

Browse files
CodyToleneCodyTolene
committed
Readme updates.
1 parent 6f893c9 commit f6b8ce0

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

‎README.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -152,17 +152,17 @@ Customization with optional inputs and icon
152152

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

155-
| Input | Value Typing | Default Value | Description |
156-
| ---------------------- | --------------------- | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
157-
| **backgroundColor** | string | `'#0D58C0'` (dark-blue) | Background color of the back to top button. Define any `'x'` css property available for `'background-color: x'`. |
158-
| **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. |
159-
| **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. |
160-
| **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'`. |
161-
| **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'`. |
162-
| **height** | string | `'40px'` | Height of back to top button in string px format. |
163-
| **position** | `'left'` \| `'right'` | `'right'` | Position on-screen where the back to top button is displayed. |
164-
| **width** | string | `'40px'` | Width of back to top button in string px format. |
165-
| **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. |
155+
| Input | Value Typing | Default Value | Description |
156+
| ---------------------- | ----------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
157+
| **backgroundColor** | string | `#0D58C0` | Background color of the back to top button. Define any `'x'` css property available for `'background-color: x'`. |
158+
| **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. |
159+
| **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. |
160+
| **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'`. |
161+
| **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'`. |
162+
| **height** | string | `32px` \| `1rem` | Height of back to top button in string format. |
163+
| **position** | `left` \| `right` | `right` | Position on-screen where the back to top button is displayed. |
164+
| **width** | string | `32px` \| `1rem` | Width of back to top button in string format. |
165+
| **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. |
166166

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

0 commit comments

Comments
 (0)