https://github.com/tubbo/gordon
Short message rendering in pure DOM JavaScript.
https://github.com/tubbo/gordon
Last synced: 16 days ago
JSON representation
Short message rendering in pure DOM JavaScript.
- Host: GitHub
- URL: https://github.com/tubbo/gordon
- Owner: tubbo
- Created: 2011-01-12T14:41:24.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T20:10:38.000Z (over 1 year ago)
- Last Synced: 2025-04-12T01:17:59.651Z (16 days ago)
- Language: JavaScript
- Homepage: http://github.com/tubbo/gordon
- Size: 14.6 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Gordon. Flash Gordon.
**Gordon** is a plugin that manages the display of error messages using pure JavaScript. It was inspired by Twitter's means of displaying the flash.
## Installation
Install with Bower:
```bash
$ bower install gordon
```
Or, clone down this repo and add **gordon.js** and **gordon.css** to the
proper locations in your project.
Then, include the resources in the `` of your page:
```html
```
Finally, instantiate the plugin with the ID of your element (default is "flash").
Make sure this is consistent with the id in your CSS:
```javascript
var flash = new Gordon("flash");
```
## Usage
Gordon has three methods that can be used at any time in your JS code.
To display the flash with green, 14pt text...
```javascript
flash.notice("message");
```
To display the flash with red text at 16pt, slightly larger than the default format...
```javascript
flash.alert("message");
```
To display the flash with blue text at 16pt...
```javascript
flash.info("message");
```
This is also slightly larger, in order to denote special text that may require magnification
**NOTE: You can opt to just display the last set status message by invoking the `flash.` methods without any arguments.**
## License
Copyright (c) 2011-2012 Tom Scott
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.