Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ulrobin committed Nov 30, 2015
1 parent 149bd34 commit 0a2d416
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Expand Up @@ -5,7 +5,9 @@ Tiny jQuery pluugin to easily adapt the page's styling
dynamicColorPage was made to give the visitors of a website the possibility to choose their favourite style colors.
All you have to do, is to add the class "dcl" (for dynamic color) or "dbg" (for dynamic background-color) to all elements,
that should apply the given color scheme. The extended functionality applies some other classes, if you add a number
(-100, -90, -80, -70, -60, -50, -40, -30, -20, -10, 0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100) at the end of the class.
(-100, -90, -80, -70, -60, -50, -40, -30, -20, -10, 0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100) at the end of the class (e.g. "dbg-70").

These colors are lighted or darked color versions of the basic color for the selected color.

## Dependences:
The code represents only a tiny plugin to jQuery, so you have to include jQuery first and then load/execute this script.
Expand All @@ -26,3 +28,8 @@ This variable defines, how many color tiles are in one row of the color-changer
With this variable you can define another standard color class, the script should look for, if the color is changed.
For exaple if this variable is "grey", then you have to add "dclgrey" or "dbggrey" as classes to your elements to active the script
and the color-change-functionality for these elements. For default the value is "", so you can just use "dcl" and "dbg" as classes.

## How it works:
The script just replaces the previous "dcl" or "dbg" class of all elements and replaces this with the new color name.
If the default color is set to "" and that is changed to "green", then every "dcl" and every "dbg" class is replaced with "dclgreen"
or "dbggreen" class. The same procedure is applied to all color shades.

0 comments on commit 0a2d416

Please sign in to comment.