Git Product home page Git Product logo

mourn.js's Introduction

Mourn.js

Mourn.js is a jQuery library which is built in order to change any web site to gray color mode and also has an option to place the black ribbon in a page.

Version 0.0.16

Files

  • src/css/mourn.css
  • src/css/mourn.min.css
  • src/js/mourn.js
  • src/js/mourn.min.js
  • example.css
  • example.html

Quick start

Several quick start options are available:

Demo

try now!

Installation

Step 1: Link required files

First, add a link to the css file in your <head>:

<!-- Mourn.js CSS file -->
<link rel="stylesheet" type="text/css" href="src/css/mourn.css">

Then, before your closing <body> tag add:

<!-- jQuery library (served from Google) -->
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.2.4/jquery.min.js"></script>
<!-- Mourn.js Javascript file -->
<script type="text/javascript" src="src/js/mourn.js"></script>

Step 2: Call the Mourn.js

With a simple call below, your web site will become to gray color mode and has a mourning ribbon on the page.

$(document).ready(function(){
  $.mourn();
});

Configuration options

Options

The Mourn.js has several properties that you can customize. Noted that the options you'll see below are default options of this library.

$.mourn({
  // Gray Color Mode Options
  gray: true,                      // boolean: [true|false]
  grayScale: 1.0                   // double: [0.0 ~ 1.0]

  // Ribbon Options
  ribbon: true,                    // boolean: [true|false]
  ribbonSize: 'large',             // String: [small|large]
  ribbonPosition: 'top-right',     // String: [top-left|top-right|bottom-left|bottom-right]
});

========================================================================================

Copyright (C) 2016 | Developed by Kanmanus Ongvisatepaiboon, Songklod Saengvoratip, Phruek Kosonsuwiwat.

Co-Advisor: Teeradech Thanapop, Nathawat Thumthiwong, Suthat Ronglong

mourn.js's People

Contributors

kanmanus avatar phruek1412 avatar

Watchers

James Cloos avatar Tirapong Chaiyakun avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.