https://github.com/diogomoretti/react-snakke
🐍 Reading position indicator for React
https://github.com/diogomoretti/react-snakke
progress-bar react react-component
Last synced: about 1 year ago
JSON representation
🐍 Reading position indicator for React
- Host: GitHub
- URL: https://github.com/diogomoretti/react-snakke
- Owner: diogomoretti
- License: mit
- Created: 2019-03-06T23:24:36.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-12-16T13:05:37.000Z (over 1 year ago)
- Last Synced: 2025-05-10T14:04:27.218Z (about 1 year ago)
- Topics: progress-bar, react, react-component
- Language: JavaScript
- Homepage: https://diogomoretti.github.io/react-snakke
- Size: 746 KB
- Stars: 302
- Watchers: 2
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
## Install
#### npm
```bash
npm install --save react-snakke
```
#### yarn
```bash
yarn add react-snakke
```
## Usage
#### default
```jsx
import React from 'react'
import Snakke from 'react-snakke'
export default function Example () {
return (
)
}
```
#### with custom values
```jsx
import React from 'react'
import Snakke from 'react-snakke'
export default function Example () {
return (
)
}
```
## Options / Props
| Prop | Type | Default value | Required | Description |
|---------|--------|---------------|----------|-----------------------------------|
| color | String | #000 | false | Set progress bar background color |
| height | String | 5px | false | Set height of progress bar |
| opacity | String | 1 | false | Set opacity from 0 to 1 |
| top | String | 0 | false | Set distance from top of page |
| zIndex | String | 9999 | false | Set value based on css z-index property |
| shadow | Boolean | false | false | Progress bar with or without shadow |
## License
MIT © [Diogo Moretti](https://github.com/diogomoretti)