Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
asashay committed Aug 4, 2020
1 parent 28978be commit 77faf51
Show file tree
Hide file tree
Showing 4 changed files with 92 additions and 1,221 deletions.
33 changes: 22 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,17 +44,28 @@ Also it takes in all the `<video>` props and passes them down to the underlying


## Props
All props are optional.

| Prop | Type | Default | Description |
|---|---|---|---|
| pathColor | `string` | `red` | Any valid color string (e.g. `#ffffff, rgb(0,0,0)` )
| pathWidth | `string` | `3px` | Any valid width value (e.g. `2em, .5rem`)
| progressStart | `string` | `BottomLeft` | One of `BottomLeft, TopLeft, TopRight, BottomRight`
| type | `string` | `OneLine` | One of `OneLine, TwoLines, BottomLine`
| wrapperStyle | object | `{ display: 'inline-block', position: 'relative',}` | inline styles for wrapper `div`
| wrapperClassName | string | `''` | Class assigned to wrapper
| ...rest | any of [HTMLVideoElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLVideoElement) props | | Any of `<video>` attributes (e.g. `autoplay, width, className` etc) |
All props are **optional**.

* `pathColor`: String, default `red`
* Any valid color string (e.g. `#ffffff, rgb(0,0,0)` )

* `pathWidth`: String, default `3px`
* Any valid width value (e.g. `2em, .5rem`)

* `progressStart`: String, default `BottomLeft`
* One of `BottomLeft, TopLeft, TopRight, BottomRight`

* `type`: String, default `OneLine`
* One of `OneLine, TwoLines, BottomLine`

* `wrapperStyle`: Object, default `{ display: 'inline-block', position: 'relative'}`
* inline styles for wrapper `div`

* `wrapperClassName`: String, default `''`
* Class assigned to wrapper

* ...rest: any of [HTMLVideoElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLVideoElement) props
* Any of `<video>` attributes (e.g. `autoplay, width, className` etc)

## License

Expand Down
6 changes: 2 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "react-video-progress",
"version": "1.1.0",
"version": "1.1.1",
"description": "React component to show video progress at frame borders",
"author": "asashay",
"license": "MIT",
Expand Down Expand Up @@ -53,10 +53,8 @@
"prettier": "^2.0.4",
"puppeteer": "^3.1.0",
"react": "^16.13.1",
"react-docgen-typescript": "^1.20.1",
"react-dom": "^16.13.1",
"react-scripts": "^3.4.1",
"react-styleguidist": "^11.0.8"
"react-scripts": "^3.4.1"
},
"files": [
"dist"
Expand Down
4 changes: 0 additions & 4 deletions styleguide.config.js

This file was deleted.

Loading

0 comments on commit 77faf51

Please sign in to comment.