-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit bc1956d
Showing
12 changed files
with
2,994 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"presets": ["@babel/preset-react"] | ||
} | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
.DS_Store | ||
node_modules/ | ||
dist/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
src/ | ||
.gitignore |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) [2024] [Sarah C. Siqueira] | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
# Scroll Bar Indicator | ||
|
||
[](https://opensource.org/licenses/MIT) | ||
|
||
`ScrollBarIndicator` is a customizable React component that displays a scroll position indicator. | ||
|
||
<p align="center"> | ||
 | ||
</p> | ||
|
||
|
||
|
||
## Usage | ||
|
||
### Install | ||
|
||
To install the `scroll-bar-indicator` package, run: | ||
|
||
`npm install scroll-bar-indicator` or | ||
|
||
`yarn add scroll-bar-indicator` | ||
|
||
### Import | ||
|
||
Import the ScrollBarIndicator in your React application: | ||
|
||
`import ScrollBarIndicator from 'scroll-bar-indicator';` | ||
|
||
Add the component with your custom props. | ||
|
||
``` | ||
<ScrollBarIndicator | ||
barColor="rgb(200, 200, 200)" | ||
barHeight = "2rem", | ||
indicatorColor="rgb(14, 179, 170)" | ||
infoColor="rgb(51, 51, 51)" | ||
showInfo={true} | ||
/> | ||
``` | ||
|
||
### Props | ||
|
||
To customize, use the props below into the ScrollBarIndicator: | ||
|
||
- `barColor` (string): Background color of the scroll bar. Default is `rgb(179, 179, 179)`. | ||
- `barHeight` (string): Defines the bar height. Default is `2 rem`. | ||
- `indicatorColor` (string): Background color of the scroll indicator. Default is `rgb(14, 179, 170)`. | ||
- `infoColor` (string): Color of the scroll info text. Default is `rgb(51, 51, 51)`. | ||
- `showInfo` (boolean): Whether to display the scroll info text. Default is `true`. | ||
|
||
## License | ||
|
||
MIT |
Oops, something went wrong.