Skip to content

Commit

Permalink
Update Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@TheSGJ
TheSGJ committed Oct 5, 2024
1 parent b1f63cb commit 461a78d
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 22 deletions.
10 changes: 10 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -187,3 +187,13 @@
### Fixed

- Fixed typo in template value in prop type table in README

## v3.7.15

### Added

- Added option to control showing of top loader for hash anchors

### Updated

- Updated README.md Documentation for `showForHashAnchor`
36 changes: 15 additions & 21 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -160,20 +160,21 @@ If no props are passed to `<NextTopLoader />`, below is the default configuratio

#### `NextTopLoaderProps` (props passed to the TopLoader)

| **Name** | **Type** | **Default Value** |
| ----------------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `color` | `string` | `"#2299DD"` |
| `initialPosition` | `number` | `0.08` |
| `crawlSpeed` | `number` | `200` |
| `height` | `number` | `3` |
| `crawl` | `boolean` | `true` |
| `showSpinner` | `boolean` | `true` |
| `easing` | `string` | `"ease"` |
| `speed` | `number` | `200` |
| `shadow` | `string \| false` | `"0 0 10px #2299DD,0 0 5px #2299DD"` |
| `template` | `string` | `"<div class="bar" role="bar"><div class="peg"></div></div><div class="spinner" role="spinner"><div class="spinner-icon"></div></div>"` |
| `zIndex` | `number` | `1600` |
| `showAtBottom` | `boolean` | `false` |
| **Name** | **Type** | **Default Value** |
| ------------------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `color` | `string` | `"#2299DD"` |
| `initialPosition` | `number` | `0.08` |
| `crawlSpeed` | `number` | `200` |
| `height` | `number` | `3` |
| `crawl` | `boolean` | `true` |
| `showSpinner` | `boolean` | `true` |
| `easing` | `string` | `"ease"` |
| `speed` | `number` | `200` |
| `shadow` | `string \| false` | `"0 0 10px #2299DD,0 0 5px #2299DD"` |
| `template` | `string` | `"<div class="bar" role="bar"><div class="peg"></div></div><div class="spinner" role="spinner"><div class="spinner-icon"></div></div>"` |
| `zIndex` | `number` | `1600` |
| `showAtBottom` | `boolean` | `false` |
| `showForHashAnchor` | `boolean` | `true` |

## Contributors

Expand All @@ -185,13 +186,6 @@ This project was made possible thanks to the contributions of its code contribut

### Financial Contributors

We extend a huge thanks to our financial contributor for helping us sustain this community

<a href="https://sentry.io">
<img src="https://thanks.dev/assets/partner-logos/sentry-color.svg" alt="Sentry" width="200"/>

</a>

---

Support this project with your organization. Your logo will show up here with a link to your website. You can Support this project on Open Collective or Equivalent Method from the below
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "nextjs-toploader",
"version": "3.6.15",
"version": "3.7.15",
"description": "A Next.js Top Loading Bar component made using nprogress, works with Next.js 14 and React.",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down

0 comments on commit 461a78d

Please sign in to comment.