https://github.com/andrepolischuk/messg
Messages via CSS3 animations
https://github.com/andrepolischuk/messg
alert confirm message
Last synced: 5 months ago
JSON representation
Messages via CSS3 animations
- Host: GitHub
- URL: https://github.com/andrepolischuk/messg
- Owner: andrepolischuk
- License: mit
- Created: 2015-01-06T19:45:07.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2018-11-02T09:48:33.000Z (almost 7 years ago)
- Last Synced: 2024-10-14T11:42:16.546Z (12 months ago)
- Topics: alert, confirm, message
- Language: JavaScript
- Homepage: http://andrepolischuk.github.io/messg/
- Size: 188 KB
- Stars: 53
- Watchers: 7
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# messg [![Build Status][travis-image]][travis-url]
> Messages via CSS3 animations
## Install
```sh
npm install --save messg
```
## Usage
```js
import messg from 'messg';
messg
.success('Awesome!')
.button('Ok');
```
## API
### messg(text[, type, delay])
Create `Message` instance.
#### text
Type: `string`
Message text.
#### type
Type: `string`
Default: `'default'`
Message type:
* default
* success
* info
* warning
* error
#### delay
Type: `number`
Default: `null`
Аutohide timeout.
### messg.default(text[, delay])
### messg.success(text[, delay])
### messg.info(text[, delay])
### messg.warning(text[, delay])
### messg.error(text[, delay])
Aliases for `messg(text[, type, delay])`
```js
messg.warning('Connection is lost');
messg.success('Task completed', 2500);
```
### .button(name[, fn])
Add button.
#### name
Type: `string`
Button title.
#### fn
Type: `function`
Handler for click on the button.
Buttons with handler:
```js
messg
.warning('Are you sure?')
.button('Yes', () => {
})
.button('No', () => {
});
```
Simple close button:
```js
messg
.success('Task completed')
.button('Ok');
```
If buttons not specified, close message by clicking on it.
### .hide(fn)
Add hide handler.
#### fn
Type: `function`
Handler for hide the message.
```js
messg
.warning('Hello!')
.hide(() => {
});
```
### messg.clean()
Close all messages in flow.
## Options
### messg.speed
Type: `number`
Default: `250`
Show and hide speed (ms).
### messg.position
Type: `string`
Default: `'top'`
Messages position:
* `top`
* `top-left`
* `top-right`
* `bottom`
* `bottom-left`
* `bottom-right`
### messg.flow
Type: `boolean`
Default: `true`
Disable messages flow if `false`.
### messg.max
Type: `number`
Default: `null`
Max flow length.
### messg.delay
Type: `number`
Default: `null`
Global delay for all messages.
## License
MIT
[travis-url]: https://travis-ci.org/andrepolischuk/messg
[travis-image]: https://travis-ci.org/andrepolischuk/messg.svg?branch=master