From 461a78d7704939d8f72f1a02263e3e0adf0432c3 Mon Sep 17 00:00:00 2001 From: Shri Ganesh Jha Date: Sat, 5 Oct 2024 20:37:09 +0530 Subject: [PATCH] Update Docs --- CHANGELOG.md | 10 ++++++++++ README.md | 36 +++++++++++++++--------------------- package.json | 2 +- 3 files changed, 26 insertions(+), 22 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1682c63..6498a4e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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` diff --git a/README.md b/README.md index c06c055..5fb2ba8 100644 --- a/README.md +++ b/README.md @@ -160,20 +160,21 @@ If no props are passed to ``, 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` | `"
"` | -| `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` | `"
"` | +| `zIndex` | `number` | `1600` | +| `showAtBottom` | `boolean` | `false` | +| `showForHashAnchor` | `boolean` | `true` | ## Contributors @@ -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 - - - Sentry - - - --- 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 diff --git a/package.json b/package.json index 868fe1d..526408c 100644 --- a/package.json +++ b/package.json @@ -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",