https://github.com/dbtek/mui-timeout
A timeout / progress dialog built with Material UI
https://github.com/dbtek/mui-timeout
Last synced: 6 months ago
JSON representation
A timeout / progress dialog built with Material UI
- Host: GitHub
- URL: https://github.com/dbtek/mui-timeout
- Owner: dbtek
- Created: 2019-02-06T06:52:52.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-05-18T09:04:14.000Z (about 7 years ago)
- Last Synced: 2025-02-19T12:04:32.562Z (over 1 year ago)
- Language: JavaScript
- Size: 249 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
mui-timeout :bomb:
A timeout dialog React component built with Material UI.
---
### Install
```bash
$ npm i -S mui-timeout
# or with yarn
$ yarn add mui-timeout
```
### Usage
```js
import TimeoutDialog from 'mui-timeout'
```
### API
**Props**
`end` `{Date} *`
End time.
`onActionClick` `{function(ended: Boolean)} *`
Action button click listener.
`interval` `{String}`
Timeout interval, time to inform before end (in minutes).
`title` `{Object}`
`title.inform` `{String}`
Inform title.
`title.ended` `{String}`
Title to show when timeout ends.
`content` `{Object}`
`content.inform` `{String}`
Inform content.
`content.ended` `{String}`
Content to show when timeout ends.
`actionButtonText` `{Object}`
`actionButtonText.inform` `{String}`
Text to show on action button.
`actionButtonText.ended` `{String}`
Text to show on action button when timeout ends.
`color` `{String}`
One of "primary" or "secondary".
### Author
Ismail Demirbilek [@dbtek](https://twitter.com/dbtek)