https://github.com/chemzqm/essage

elegant way to display tips/message
https://github.com/chemzqm/essage

Last synced: about 1 month ago
JSON representation

elegant way to display tips/message

• Host: GitHub
• URL: https://github.com/chemzqm/essage
• Owner: chemzqm
• Created: 2014-03-06T05:41:28.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2015-12-03T10:40:21.000Z (about 9 years ago)
• Last Synced: 2024-10-29T10:44:26.826Z (about 2 months ago)
• Language: HTML
• Size: 11.7 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • Changelog: History.md

Awesome Lists containing this project

README

        
# Essage

  Component fork of [sofish/essage](https://github.com/sofish/essage) with API changed.

  [demo](http://chemzqm.github.io/essage/)

  

  Deprecated not maintained any more

## Installation

  Install with [component(1)](http://component.io):

    $ component install chemzqm/essage

## Usage

``` js

var Essage = require('essage');

Essage.show('hello, im a message', {

  timeout: 2000,

  placement: 'bottom',

  status: 'success'

})

```

## API

### Essage.show(msg, [options])

Show `msg` with optional options.

options:

  - `timeout` hide the message in timeout ms.

  - `placement` the placement can be `top` or `bottom`, by default is `top`.

  - `status` could be `info` `warning` `success` `error` would add class `essage-[status]` container.

### Essage.hide()

Hide the message.

## License

  MIT