https://github.com/kflorence/jquery-expandcollapse

Expand and collapse elements with custom animations
https://github.com/kflorence/jquery-expandcollapse

Last synced: 3 days ago
JSON representation

Expand and collapse elements with custom animations

• Host: GitHub
• URL: https://github.com/kflorence/jquery-expandcollapse
• Owner: kflorence
• License: mit
• Created: 2011-02-16T21:44:39.000Z (almost 14 years ago)
• Default Branch: master
• Last Pushed: 2011-06-07T22:17:27.000Z (over 13 years ago)
• Last Synced: 2024-11-01T04:12:36.502Z (about 2 months ago)
• Language: JavaScript
• Homepage: http://kflorence.github.com/jquery-expandCollapse/example/
• Size: 102 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license-bsd

Awesome Lists containing this project

README

        
# jQuery.expandCollapse

    $("#element").expandCollapse();

Toggles an element's visibility based on an arbitrary trigger. Supports custom animations.

## Options

    {

      updateText: true,

      updateClass: true,

      startHidden: false,

      eventType: "click",

      triggerElement: ".trigger",

      expandClass: "expand",

      collapseClass: "collapse",

      textElement: ".trigger",

      expandText: "expand",

      collapseText: "collapse",

      expandAnimation: {

        properties: { height : "show" },

        options: { duration: 0 }

      },

      collapseAnimation: {

        properties: { height : "hide" },

        options: { duration: 0 },

      }

    }

* **updateText** _Boolean_  

  whether or not to update the trigger element's text on click (uses the values from expandText and collapseText).

* **updateClass** _Boolean_  

  whether or not to update the trigger element's class on click (uses the values from expandClass and collapseClass).

* **startHidden** _Boolean_  

  whether or not to automatically hide any matched elements. This is useful for graceful degrading, in case the user has javaScript turned off and you still want your toggled elements to show up.

* **eventType** _String_  

  The name of the event to bind to the trigger element.

* **triggerElement** _String, jQuery_  

  The element to use as the trigger element. If not given, one will be created for you.

* **expandClass** _String_  

  The name of the class to apply to the trigger element when the target is hidden.

* **collapseClass** _String_  

  The name of the class to apply to the trigger element when the target is visible.

* **textElement** _String, jQuery_  

  The element that contains the text we will be changing on expand and collapse.

* **expandText** _String_  

  The text to display when the target element is hidden.

* **collapseText** _String_  

  The text to display when the target element is visible.

* **expandAnimation** _Object_  

  An object containing settings for jQuery's [.animate()](http://api.jquery.com/animate/) that will be used when expanding.

* **collapseAnimation** _Object_  

  An object containing settings for jQuery's [.animate()](http://api.jquery.com/animate/) that will be used when collapsing.

## Requirements

jQuery.expandCollapse requires:

* jQuery version 1.1.0+

## Compatibility

As far as I know this works cross-browser and cross-platform.

## License

Copyright (C) 2011 Kyle Florence  

Dual licensed under the MIT and BSD licenses.