/candlestick

jQuery plugin selector between three options

Primary LanguageJavaScriptMIT LicenseMIT

Candlestick will no longer be support

Sorry, but i have no time to support or/and develop this plugin. If someone want to continue his developement, he can contact me. Contact E-mail : edouard@tackacoder.fr

jQuery toggle candlestick (version 1.4.1)

This is a switch and stylish jquery plugin that converts checkbox to toggle switch button. This plugin allows to choose between three options.

  • Checked
  • Unchecked
  • Indeterminate

The toggle button switch with CSS3 animation.

You can use it with swipe option (Perform by Hammerjs)

<link rel="stylesheet" href="path/to/font-awesome.min.css">
<link rel="stylesheet" href="dist/candlestick.min.css">
<script src="dist/candlestick.min.js" type="text/javascript"></script>

Load dependencies for swipe option

<script src="path/to/hammerjs/hammer.min.js" type="text/javascript"></script>
<script src="path/to/jquery-hammerjs/jquery-hammer.js" type="text/javascript"></script>

Create html field (id is neccessary)

<input class="js-candlestick" type="checkbox" name="candlestick" value="1" id="myId>

and then use it

$('.js-candlestick').candlestick();

different options and methods

$('.js-candlestick').candlestick({
    'mode': 'options', // "contents" is the other mode
    'contents': { // Options for "contents" mode
        'left': 'Left', // The left content
        'middle': 'Middle', // The middle content
        'right': 'Right', // The right content
        'swipe': true // enable the global swipe mode
    },
    'on': '1', // for on value
    'off': '0', // for off value
    'nc': '', // for none/default value
    'swipe': true, // for swipe
    'size': 'md', // Sizes (lg, md (default), sm, xs)
    'debug': false, // Display some log message. used with Candlestick.log()
    'allowManualDefault': true, // Enable the three options, set to false will disable the default option
    afterAction: function(input, wrapper, action) {
        // Fired after action
    },
    afterRendering: function(input, wrapper) {
        // Fired after rendering element
    },
    afterOrganization: function(input, wrapper) {
        // Fired after organization method
    },
    afterSetting: function(input, wrapper, value) {
        // Fired after setting value
    }
});

input -> the html field input[type=hidden]

wrapper -> the wrapper element [class=candlestick-bg]

Set candle option

$(".js-candlestick").candlestick('on');
$(".js-candlestick").candlestick('off');
$(".js-candlestick").candlestick('default'); or $(".js-candlestick").candlestick('reset');

Enable / Disable candle

$(".js-candlestick").candlestick('enable');
$(".js-candlestick").candlestick('disable');

Reset candle option

We can reset candlestick in form, for example, with click on button.

<input class="js-candlestick" type="checkbox" name="candlestick" value="0" id="ID">
// Button to reset form
$(MY_ELEMENT_BUTTON).on('click', function(e) {
    e.preventDefault();

    // With the class you use to create candlestick
    // reset all candlestick
    $(".js-candlestick").candlestick('reset');
    // or with the ID of the input[type=checkbox] element
    // reset only one candlestick
    $("#ID").candlestick('reset');
});

More options for swipe

$('.js-candlestick').candlestick({
    'swipe': {
        enabled: true, // for swipe
        mobile: true, // Only for mobile/tablet (to develop)
        desktop: true, // Only for desktop (to develop)
        transition: false // On value to off value / *true* On value to Default value to Off value
    }
});

Dependencies

Compatibility

  • Browsers
    • Windows / Chrome
    • Windows / Opera
    • Windows / Firefox
    • Windows / Safari
    • Windows / IE
      • Edge (no test)
      • IE10 +
      • IE9 / no transition
  • Minimum jQuery version 1.9.1 (for bootstrap 3.3)
  • Develop with Twitter Bootstrap 3.3

ToDo list

  • Documentation for feature
  • Check compatibilities (MAC)
  • Check responsive mode
  • Check if the element is a checkbox type
  • Swipe
  • Option for swipe in desktop and/or mobile
  • Swipe transistion
    • On/Off
    • On/Default/Off
  • CSS style for size (lg, md, sm, xs)
  • Reset option

Roadmap Version 2

ToDo list

  • Settings can be integrate into the checkbox element with dataset attribute
  • Execute the html element with $('[data-toggle="candletisk"]')
  • Allow linear/easing animation
  • Remove dependencies with bootstrap and FontAwesome
  • Create less css

Development

Create new branch for helping development

Update workflow

npm update
bower update

Thanks contributors

CHANGELOG

SEE CHANGELOG

LICENCE

The MIT License (MIT)

Copyright (c) 2015

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.