Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: replace nprogress with HolyProgress #5

Merged
merged 5 commits into from
Dec 12, 2023
Merged

feat: replace nprogress with HolyProgress #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
daf4d83
feat: add HolyProgress & remove nprogress
tomcru Dec 12, 2023
1f7d456
fix: eslint
tomcru Dec 12, 2023
c9382df
refactor: add error handling
tomcru Dec 12, 2023
684b911
refactor: isSameHost func + tests
tomcru Dec 12, 2023
0a32fdc
chore: update README
tomcru Dec 12, 2023
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
5 changes: 5 additions & 0 deletions .eslintignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
tsup.config.ts
.eslintrc.js
vitest.config.ts
dist/
node_modules/
26 changes: 26 additions & 0 deletions .eslintrc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
module.exports = {
env: {
browser: true,
es2021: true,
},
extends: ['standard-with-typescript', 'plugin:react/recommended', 'prettier'],
overrides: [
{
env: {
node: true,
},
files: ['.eslintrc.{js,cjs}'],
parserOptions: {
sourceType: 'script',
},
},
],
parserOptions: {
ecmaVersion: 'latest',
sourceType: 'module',
},
plugins: ['react'],
rules: {
'@typescript-eslint/consistent-type-definitions': ['off'],
},
};
7 changes: 7 additions & 0 deletions .prettierrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"singleQuote": true,
"trailingComma": "all",
"tabWidth": 2,
"bracketSpacing": true,
"semi": true
}
14 changes: 9 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,13 +69,17 @@ export default function App({ Component, pageProps }) {
### Custom Configuration

```typescript
import React from "react";
import HolyLoader from "holy-loader";

export default function RootLayout({ children }) {
return (
<html lang="en">
<HolyLoader color="#ff4500" height={5} crawlSpeed={250} easing="linear" />
<HolyLoader
color="#ff4500"
height={5}
trickleSpeed={250}
easing="linear"
/>
{children}
</html>
);
Expand All @@ -99,11 +103,11 @@ Holy Loader accepts the following props for customization:

- `color` (string): Specifies the color of the top-loading bar. Default: "#59a2ff" (a shade of blue).
- `initialPosition` (number): Sets the initial position of the top-loading bar as a percentage of the total width. Default: 0.08 (8% of the total width).
- `crawlSpeed` (number): Determines the delay speed for the incremental movement of the top-loading bar, in milliseconds. Default: 200 milliseconds.
- `trickleSpeed` (number): Determines the delay speed for the incremental movement of the top-loading bar, in milliseconds. Default: 200 milliseconds.
- `height` (number): Defines the height of the top-loading bar in pixels. Default: 4 pixels.
- `crawl` (boolean): Enables or disables the automatic incremental movement of the top-loading bar. Default: true (enabled).
- `trickle` (boolean): Enables or disables the automatic incremental movement of the top-loading bar. Default: true (enabled).
- `easing` (string): Specifies the easing function to use for the loading animation. Accepts any valid CSS easing string. Default: "ease".
- `speed` (number): Sets the animation speed of the top-loading bar in milliseconds. Default: 200 milliseconds.
- `zIndex` (number): Defines the z-index property of the top-loading bar, controlling its stacking order. Default: 2147483647.

Project inspired by [nextjs-toploader](https://github.com/TheSGJ/nextjs-toploader).
Project inspired by [nextjs-toploader](https://github.com/TheSGJ/nextjs-toploader) & [nprogress](https://github.com/rstacruz/nprogress)
Loading
Loading