Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aidanaden/solid-top-loading-bar
A very simple, highly customisable youtube/githhub-like solid loader component (inspired by react-top-loading-bar)
https://github.com/aidanaden/solid-top-loading-bar
loader loading loading-bar loading-indicator progress-bar solid-indicator solid-loader solid-loading-bar solid-progress-bar solidjs solidjs-indicator solidjs-loading-bar solidjs-progress-bar top-bar
Last synced: about 1 month ago
JSON representation
A very simple, highly customisable youtube/githhub-like solid loader component (inspired by react-top-loading-bar)
- Host: GitHub
- URL: https://github.com/aidanaden/solid-top-loading-bar
- Owner: aidanaden
- Created: 2022-06-26T15:52:46.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-15T05:59:59.000Z (about 1 year ago)
- Last Synced: 2024-04-14T02:00:07.585Z (8 months ago)
- Topics: loader, loading, loading-bar, loading-indicator, progress-bar, solid-indicator, solid-loader, solid-loading-bar, solid-progress-bar, solidjs, solidjs-indicator, solidjs-loading-bar, solidjs-progress-bar, top-bar
- Language: TypeScript
- Homepage: https://solid-top-loading-bar.vercel.app
- Size: 300 KB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# solid-top-loading-bar
>
[](https://bundlephobia.com/package/solid-top-loading-bar)
[](https://www.npmjs.com/package/solid-top-loading-bar)
[download-image]: https://img.shields.io/npm/dm/solid-top-loading-bar.svg
[download-url]: https://npmjs.org/package/solid-top-loading-bar
[](https://npmjs.org/package/solid-top-loading-bar)
This package was ported to Solid from the [react-top-loading-bar](https://github.com/klendi/react-top-loading-bar) package made by [Klendi Gocci](https://klendi.dev/)
## Install
- using npm
```bash
npm install --save solid-top-loading-bar
```
- using yarn
```bash
yarn add solid-top-loading-bar
```
- CDN
```
https://unpkg.com/solid-top-loading-bar
```
## Usage
### With ref
```jsx
import LoadingBar, { LoadingBarRef } from "solid-top-loading-bar";
const App = () => {
const [loadingBar, setLoadingBar] = createSignal()
return (
loadingBar()?.continuousStart()}>
Start Continuous Loading Bar
loadingBar()?.staticStart()}>
Start Static Loading Bar
loadingBar()?.complete()}>Complete
);
};
export default App;
```
### With state
```jsx
import { createSignal } from "solid";
import LoadingBar from "solid-top-loading-bar";
const App = () => {
const [progress, setProgress] = createSignal(0);
return (
setProgress(0)}
/>
setProgress((p) => p + 10)}>Add 10%
setProgress((p) => p + 20)}>Add 20%
setProgress(100)}>Complete
);
};
export default App;
```
## Demo
[Click here for demo](https://solid-top-loading-bar.vercel.app/)
## Built-in Methods
| Methods | Parameters | Descriptions |
| ------------------------------------------- | :---------------------------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| add(value) | Number | Adds a value to the loading indicator. |
| decrease(value) | Number | Decreases a value to the loading indicator. |
| continuousStart(startingValue, refreshRate) | Number (optional), Number(optional) | Starts the loading indicator with a random starting value between 20-30, then repetitively after an refreshRate, increases it by a random value between 2-10. This continues until it reaches 90% of the indicator's width. |
| staticStart(startingValue) | Number (optional) | Starts the loading indicator with a random starting value between 30-50. |
| complete() | | Makes the loading indicator reach 100% of his width and then fade. |
## Properties
| Property | Type | Default | Description |
| :----------------- | :------------ | :------ | :-------------------------------------------------------------------------------------------------------------------------------- |
| progress | Number | `0` | The progress/width indicator, progress prop varies from `0` to `100`. |
| color | String | `red` | The color of the loading bar, color take values like css property `background:` do, for example `red`, `#000` `rgb(255,0,0)` etc. |
| shadow | Boolean | `true` | Enables / Disables shadow underneath the loader. |
| height | Number | `2` | The height of the loading bar in pixels. |
| background | String | `3` | The loader parent background color. |
| style | CSSProperties | | The style attribute to loader's div |
| containerStyle | CSSProperties | | The style attribute to loader's container |
| shadowStyle | CSSProperties | | The style attribute to loader's shadow |
| transitionTime | Number | `300` | Fade transition time in miliseconds. |
| loaderSpeed | Number | `500` | Loader transition speed in miliseconds. |
| waitingTime | Number | `1000` | The delay we wait when bar reaches 100% before we proceed fading the loader out. |
| className | String | | You can provide a class you'd like to add to the loading bar to add some styles to it |
| containerClassName | String | | You can provide a class you'd like to add to the loading bar container to add some css styles |
| onLoaderFinished | Function | | This is called when the loading bar completes, reaches 100% of his width. |
## Projects using solid-top-loading-bar
Add your own project. Make a PR
## Code Style
[](http://standardjs.com)
## License
MIT © aidanaden