first commit

Author: ndungtse

.github/workflows/ci.yml

@@ -0,0 +1,43 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  Linting:
+    name: Linting
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Project
+        uses: actions/checkout@v3
+      - name: Use Node.js v18
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          check-latest: true
+          cache: yarn
+          registry-url: https://registry.npmjs.org/
+      - name: Install Dependencies
+        run: yarn --frozen-lockfile
+      - name: Run ESLint
+        run: yarn lint --fix=true
+
+  Building:
+    name: Compile source code
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Project
+        uses: actions/checkout@v3
+      - name: Use Node.js v18
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: yarn
+          registry-url: https://registry.npmjs.org/
+      - name: Install Dependencies
+        run: yarn --frozen-lockfile
+      - name: Typecheck And Build Code
+        run: yarn typecheck && yarn build

.gitignore

@@ -0,0 +1,26 @@
+
+# Optional eslint cache
+.eslintcache
+
+
+# Output of 'npm pack'
+*.tgz
+
+# dotenv environment variables file
+.env
+
+# next.js build output
+.next
+
+*node_modules
+.idea
+.DS_Store
+dist
+
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

CHANGELOG.md

@@ -0,0 +1,42 @@
+# Changelogs
+
+## v0.0.16
+
+- Use `React.memo` for better performance
+- Allow passing custom css tag in props
+
+## v0.0.15
+
+- Properly handle `routeChangeError` event
+
+## v0.0.14
+
+### Added
+
+- Added nonce support
+- Added autocomplete for advanced options
+
+## v0.0.13
+
+### Fixed
+
+- Fixed react version issue
+
+## v0.0.12
+
+### Updated
+
+- Updated README.md's 'How to use' section to be more clear and consise. Also added further context to Default Config.
+- Updated Next.js version to v12
+
+## v0.0.11
+
+### Added
+
+- Added next.js version 11.0.0 in package.json `peerDependancies`.
+- Added color highlight to the code in the README.md file.
+- Added type of showOnShallow of NextNProgress class in `index.d.ts`.
+
+### Updated
+
+- Upgraded the `next` version to 11.0.0 in `devDependencies`.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Ndungutse Charles
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,82 @@
+# Next.js Progressbar
+
+A simple Next.js progressbar component using [NProgress](http://ricostacruz.com/nprogress/).
+
+> [I've created this Blog to help you create your own progressbar](https://gosink.in/next-js-make-your-own-progress-bar-indicator-component-easily/)
+
+**Demo**: [https://demo-nextjs-progressbar.vercel.app](https://demo-nextjs-progressbar.vercel.app/)
+
+## How to install?
+
+```bash
+npm i nextjs-progressbar
+```
+
+## How to use?
+
+After installing the package, import `NextNProgress` in your `pages/_app.js` file:
+
+```js
+import NextNProgress from 'nextjs-progressbar';
+```
+
+And for rendering add `<NextNProgress />` to your `return()` in `MyApp()`:
+
+```js
+import NextNProgress from 'nextjs-progressbar';
+
+export default function MyApp({ Component, pageProps }) {
+  return (
+    <>
+      <NextNProgress />
+      <Component {...pageProps} />;
+    </>
+  );
+}
+```
+
+### Default Config
+
+If no props are passed to `<NextNProgress />`, below is the default configuration applied.
+
+```jsx
+<NextNProgress color="#29D" startPosition={0.3} stopDelayMs={200} height={3} showOnShallow={true} />
+```
+
+- `color`: to change the default color of progressbar. You can also use `rgb(,,)` or `rgba(,,,)`.
+- `startPosition`: to set the default starting position : `0.3 = 30%`.
+- `stopDelayMs`: time for delay to stop progressbar in `ms`.
+- `height`: height of progressbar in `px`.
+- `showOnShallow`: You can choose whether you want the progressbar to be displayed if you're using shallow routing. It takes a boolean. Learn more about shallow routing [in Next.js docs](https://nextjs.org/docs/routing/shallow-routing).
+
+### Advanced Config
+
+#### Adding nonce
+
+We use internal css in this package. If you are using csp, you can add nonce to the `<style>` tag by providing `nonce` prop to `<NextNProgress />` component.
+
+```jsx
+<NextNProgress nonce="my-nonce" />
+```
+
+#### Custom CSS
+
+You can use `transformCSS` prop to pass custom css.
+**Note:** You must return a `JSX.Element` from the function.
+
+```jsx
+<NextNProgress
+  transformCSS={(css) => {
+    // css is the default css string. You can modify it and return it or return your own css.
+    return <style>{css}</style>;
+  }}
+/>
+```
+
+#### Other Configs
+
+You can use [other configurations](https://github.com/rstacruz/nprogress#configuration) which NProgress provides by adding a JSON in `options` props.
+
+```jsx
+<NextNProgress options={{ easing: 'ease', speed: 500 }} />
+```

example/.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "next/core-web-vitals"
+}

example/.gitignore

@@ -0,0 +1,35 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts

example/README.md

@@ -0,0 +1,34 @@
+This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+
+## Getting Started
+
+First, run the development server:
+
+```bash
+npm run dev
+# or
+yarn dev
+# or
+pnpm dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+
+You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+
+This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+
+## Learn More
+
+To learn more about Next.js, take a look at the following resources:
+
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
+- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+
+You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+
+## Deploy on Vercel
+
+The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+
+Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.

example/next.config.js

@@ -0,0 +1,4 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {}
+
+module.exports = nextConfig

example/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "example",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start",
+    "lint": "next lint"
+  },
+  "dependencies": {
+    "@types/node": "20.3.2",
+    "@types/react": "18.2.14",
+    "@types/react-dom": "18.2.6",
+    "eslint": "8.43.0",
+    "eslint-config-next": "13.4.7",
+    "next": "13.4.7",
+    "next13-progressbar": "../",
+    "react": "18.2.0",
+    "react-dom": "18.2.0",
+    "typescript": "5.1.5"
+  }
+}