diff --git a/entries/accordion.xml b/entries/accordion.xml index 1e593106..a5991340 100644 --- a/entries/accordion.xml +++ b/entries/accordion.xml @@ -39,8 +39,13 @@
ui-accordion
: The outer container of the accordion.
ui-accordion-header
: The headers of the accordion. The headers will additionally have a ui-accordion-icons
class if they contain icons
.ui-accordion-content
: The content panels of the accordion.ui-accordion-header
: The headers of the accordion. The active header will additionally have a ui-accordion-content-active
class, the inactive headers will have a ui-accordion-header-collapsed
class. The headers will also have a ui-accordion-icons
class if they contain icons
.
+ ui-accordion-header-icon
: Icon elements within each accordion header.ui-accordion-content
: The content panels of the accordion. The active content panel will additionally have a ui-accordion-content-active
class.The specified class name(s) will be added to the dialog, for additional theming.
+The dialogClass
option has been deprecated in favor of the classes
option, using the ui-dialog
property.
Make the selected elements draggable by mouse. If you want not just drag, but drag & drop, see the jQuery UI Droppable plugin, which provides a drop target for draggables.
+ui-draggable
: The draggable element. When the draggable is disabled, the ui-draggable-disabled
class is added. While dragging, the ui-draggable-dragging
class is added.ui-draggable-handle
: The handle of the draggable, specified using the handle
option. By default, the draggable element itself is also the handle.helper
option must be set to "clone"
in order to work flawlessly. Requires the jQuery UI Sortable plugin to be included.{ top, left, right, bottom }
.The jQuery UI Droppable plugin makes selected elements droppable (meaning they accept being dropped on by draggables). You can specify which draggables each will accept.
+ui-droppable
: The droppable element. When a draggable that can be dropped on this dropppable is activated, the ui-droppable-active
class is added. When dragging a draggable over this droppable, the ui-droppable-hover
class is added.true
if the draggable should be accepted.If specified, the class will be added to the droppable while an acceptable draggable is being dragged.
+The activeClass
option has been deprecated in favor of the classes
option, using the ui-droppable-active
property.
false
, will prevent the ui-droppable
class from being added. This may be desired as a performance optimization when calling .droppable()
init on hundreds of elements.true
, any parent droppables will not receive the element. The drop
event will still bubble normally, but the event.target
can be checked to see which droppable received the draggable element.If specified, the class will be added to the droppable while an acceptable draggable is being hovered over the droppable.
+The hoverClass
option has been deprecated in favor of the classes
option, using the ui-droppable-hover
property.
accept
option. A draggable with the same scope value as a droppable will be accepted.This method is deprecated. Use .focus()
without arguments inside a timeout or $.Widget's ._delay()
method.
refresh()
on an input widget when the parent form gets reset.<input>
. It doesn't work for other elements like <label>
or <div>
+ this._bindFormResetHandler()
inside _create()
to initialize the mixin.
+
+ this._unbindFormResetHandler()
inside _destroy()
to destroy the mixin.
+
+ ")
+ .addClass("demo-colorize-swatch")
+ .insertAfter(this.element);
+
+ this.refresh();
+ this._bindFormResetHandler();
+
+ this._on({ keyup: "refresh" });
+ },
+ refresh: function() {
+ this.swatch.css( "background-color", this.element.val() );
+ },
+ _destroy: function() {
+ this.swatch.remove();
+ this._unbindFormResetHandler();
+ }
+} ] );
+$( "#colorize" ).colorize();
+]]>
+ .animate()
. The animationProperties
must contain a clip
property.This method is useful for mimicking a clip animation when using a placeholder for effects. Given a clip animation, jQuery.effects.clipToBox()
will generate an object containing top
, left
, width
, and height
properties which can be passed to .css()
or .animate()
. This method is generally used in conjunction with jQuery.effects.createPlaceholder()
.
clip
animations without disrupting the layout.Many effects require animating the clip
CSS property. In order to apply clipping, the element must be absolutely positioned. As a result, if an animation that utilizes clipping is applied to an element with static or relative positioning, the layout of the page will be affected when the animated element is removed from the flow. To compensate for this, a placeholder element with the same size and position can be inserted into the document.
jQuery.effects.createPlaceholder()
will create a placeholder with the same display, position, dimensions, and margins as the original element. The placeholder is inserted into the DOM as the next sibling of the original element. When the animation is complete, jQuery.effects.removePlaceholder()
should be used to remove the inserted element.
undefined
."show"
, "hide"
, or "toggle"
.options
argument contains duration
and mode
properties, as well as any effect-specific options.Defines a new effect for use with .effect()
, .show()
, .hide()
, and .toggle()
. The effect method is invoked with this
being a single DOM element. The done
argument must be invoked when the animation is complete.
jQuery.effects.define()
stores the new effect in jQuery.effects.effect[ name ]
and returns the function that was provided as the effect
parameter.
+ jQuery.effects.createPlaceholder()
.Removes the placeholder for an element. This method is safe to call even if jQuery.effects.createPlaceholder()
did not create a placeholder.
Restores all inline styles for an element which have been saved using jQuery.effects.saveStyle()
.
Stores a copy of the current inline styles applied to the element, which can be reapplied to the element later using jQuery.effects.restoreStyle()
. This is useful when animating various styles and restoring the existing styles at the end.
When using jQuery.effects.define()
to create an effect, if jQuery.effects.saveStyle()
is used on the main element being animated, the styles will be restored automatically when the animation is complete.
"horizontal"
or "vertical"
. If direction
is omitted, both dimensions will be scaled.This method scales the dimensions of an element, returning an object containing height
, width
, outerHeight
, and outerWidth
properties. The element is not actually modified.
Additional (thematic) classes to add to the widget, in addition to the structural classes. The structural classes are used as keys of this option and the thematic classes are the values. See the _addClass()
method for using this in custom widgets. Check out the documentation of individual widgets to see which classes they support.
The primary motivation of this option is to map structural classes to theme classes. In other words, any class prefixed with namespace and widget, like "ui-progressbar-"
, is considered a structural class. These are always added to the widget. In contrast to that, any class not specific to the widget is considered a theme class. These could be part of jQuery UI's CSS framework, but can also come from other CSS frameworks or be defined in custom stylesheets.
Setting the classes
option after creation will override all default properties. To only change specific values, use deep setters, e.g. .option( "classes.ui-progressbar-value", null )
.
classes
option specified, changing the theming for the ui-progressbar
class:
+$( ".selector" ).progressbar({
+ classes: {
+ "ui-progressbar": "highlight"
+ }
+});
+
+ classes
option, after initialization:
+// Getter
+var classes = $( ".selector" ).widget( "option", "classes" );
+
+// Setter, override all classes
+$( ".selector" ).widget( "option", "classes", { "custom-header": "icon-warning" } );
+
+// Setter, override just one class
+$( ".selector" ).widget( "option", "classes.custom-header", "icon-warning" );
+
+ This provides a hook for the user to add additional classes or replace default styling classes, through the classes
option.
It also provides automatic removal of these classes when a widget is destroyed, as long as you're using _addClass()
, _removeClass()
and _toggleClass()
together. This can heavily simplify the implementation of custom _destroy()
methods.
this.element
.classes
option matches a key, the value will be added as well.
+ When you only need the extra
argument, you can skip this argument by specifying null
.
keys
argument, these aren't associated with any properties of the classes
option. Just like keys
, they will also be automatically removed when destroying the widget.ui-progressbar
class to the widget's element (this.element
). Will also add any additional classes specified through the classes
option for the given class.
+ demo-popup-header
class to the specified element (here referencing this.popup
). Will also add any additional classes specified through the classes
option for the given class. In addition, it will always add the ui-front
class.
+ ui-helper-hidden-accessible
class to the specified element. Uses null
for the keys
argument to skip it.
+ The arguments are the same as for the _addClass()
method, the same semantics apply, just in reverse.
this.element
.classes
option matches a key, the value will be removed as well.
+ When you only need the extra
argument, you can skip this argument by specifying null
.
keys
argument, these aren't associated with any properties of the classes
option.ui-progressbar
class from the widget's element (this.element
). Will also remove any additional classes specified through the classes
option for the given class.
+ demo-popup-header
class from the specified element (here referencing this.popup
). Will also remove any additional classes specified through the classes
option for the given class. In addition, it will also remove the ui-front
class.
+ ui-helper-hidden-accessible
class from the specified element. Uses null
for the keys
argument to skip it.
+ The arguments are the same as for the _addClass()
and _removeClass()
methods, except for the additional boolean argument that specifies to add or remove classes.
Unlike jQuery's .toggleClass()
method, the boolean add
argument is always required.
this.element
.classes
option matches a key, the value will be toggled as well.
+ When you only need the extra
argument, you can skip this argument by specifying null
.
keys
argument, these aren't associated with any properties of the classes
option. Just like keys
, they will also be automatically removed when destroying the widget.Indicates whether to add or remove the specified classes, where a boolean true
indicates that classes should be added, a boolean false
indicates that classes should be removed.
ui-state-disabled
class on the widget's element (this.element
).
+ _create()
method is the widget's constructor.
diff --git a/entries/labels.xml b/entries/labels.xml
new file mode 100644
index 00000000..bc7efd5f
--- /dev/null
+++ b/entries/labels.xml
@@ -0,0 +1,29 @@
+
+This can be used to find all the <label>
elements associated with an <input>
element. The association can be through nesting, where the label is an ancestor of the input, or through the for
attribute on the label, pointing at the id
attribute of the input. If no labels are associated with the given element, an empty jQuery object is returned.
This methods mimics the native labels
property, which isn't supported in all browsers. In addition, this method also works for document fragments.
+
+ Firstname
+
+
+
+]]>
+ A menu can be created from any valid markup as long as the elements have a strict parent/child relationship. The most commonly used element is the unordered list (<ul>
):
A menu can be created from any valid markup as long as the elements have a strict parent/child relationship. The most commonly used element is the unordered list (<ul>
). Additionally, the contents of each menu item must be wrapped with a block-level DOM element. In the example below <div>
elements are used as wrappers:
- Item 1
- Item 2
- Item 3
+
+ Item 1
+
+
+ Item 2
+
+
+ Item 3
- - Item 3-1
- - Item 3-2
- - Item 3-3
- - Item 3-4
- - Item 3-5
+ -
+ Item 3-1
+
+ -
+ Item 3-2
+
+ -
+ Item 3-3
+
- Item 4
- Item 5
+
+ Item 4
+
+
+ Item 5
+
]]>
@@ -35,20 +48,26 @@
- Save
+
+ Save
+
]]>
Menu automatically adds the necessary padding to items without icons.
Divider elements can be created by including unlinked menu items that contain only spaces and/or dashes:
+Divider elements can be created by including menu items that contain only spaces and/or dashes:
- Item 1
+
+ Item 1
+
-
- Item 2
+
+ Item 2
+
]]>
@@ -71,12 +90,17 @@
ui-menu
: The outer container of the menu. This element will additionally have a ui-menu-icons
class if the menu contains icons.
+ ui-menu
: The outer container of the menu, as well as any nested submenu. This top-level element will additionally have a ui-menu-icons
class if the menu contains icons.
ui-menu-item
: The container for individual menu items.
+ ui-menu-item
: The container for individual menu items. This contains the element for the item's text itself as well as the element for submenus.
ui-menu-divider
: Divider elements between menu items.focus
event.
+ Activates the given menu item and triggers the menu's focus
event. Opens the menu item's sub-menu, if one exists.
This is a standalone jQuery plugin and has no dependencies on other jQuery UI components.
"right"
will be normalized to "right center"
, "top"
will be normalized to "center top"
(following CSS convention). Acceptable horizontal values: "left"
, "center"
, "right"
. Acceptable vertical values: "top"
, "center"
, "bottom"
. Example: "left top"
or "center center"
. Each dimension can also contain offsets, in pixels or percent, e.g., "right+10 top-25%"
. Percentage offsets are relative to the element being positioned.ui-progressbar
: The outer container of the progressbar. This element will additionally have a class of ui-progressbar-indeterminate
for indeterminate progressbars.
+ ui-progressbar
: The outer container of the progressbar. This element will additionally have a class of ui-progressbar-indeterminate
for indeterminate progressbars. For determinate progressbars, the ui-progressbar-complete
class is added once the maximum value is reached.
ui-progressbar-value
: The element that represents the filled portion of the progressbar.
@@ -35,6 +35,15 @@
The jQuery UI Resizable plugin makes selected elements resizable (meaning they have draggable resize handles). You can specify one or more handles as well as min and max width and height.
+ui-resizable
: The resizable element. During a resize, the ui-resizable-resizing
class is added. When the autoHide
option is set, the ui-resizable-autohide
class is added.ui-resizable-handle
: One of the handles of the resizable, specified using the handles
option. Each handle will also have a ui-resizable-{direction}
class according to its position.ui-resizable-ghost
: When using the ghost
option, this class is applied to the ghost helper element.ui-resizable-helper
: When the animate
option is used, but the helper
option isn't specified, this class is added to the generated helper."parent"
and "document"
.The jQuery UI Selectable plugin allows for elements to be selected by dragging a box (sometimes called a lasso) with the mouse over the elements. Elements can also be selected via click or drag while holding the ctrl/meta key, allowing for multiple (non-contiguous) selections.
+ui-selectable
: The selectable element.
+ ui-selectee
: One of the selectable elements, as specified through the filter
option. This element can also receive one of the following classes: ui-selecting
(when the lasso includes this element), ui-selected
(after a successful selection), ui-unselecting
(when the lasso lost this element).ui-selectable-helper
: The "lasso" element used to visualize the ongoing selection.ALT
/OPTION
+ UP
/DOWN
: Toggle the visibility of the menu.SPACE
: Open the menu.ui-selectmenu-button
: The button-like element replacing the native selectmenu on the page. Has the ui-selectmenu-button-closed
class when closed, the ui-selectmenu-button-open
class when open.
+ ui-selectmenu-text
: The span representing the text portion of the button element.ui-selectmenu-icon-space
: A supporting element between the text and the icon of the selectmenu button.ui-selectmenu-menu
: The wrapper element around the menu used to display options to the user (not the menu itself). When the menu is open, the ui-selectmenu-open
class is added.
+ ui-selectmenu-optgroup
: One of the elements that replicates <optgroup>
elements from native selects.null
, the parents of the <select>
are checked for a class name of ui-front
. If an element with the ui-front
class name is found, the menu is appended to that element. Regardless of the value, if no element is found, the menu is appended to the body.null
, the width of the native select is used.null
, the width of the native select is used. When the value is false
, no inline style will be set for the width, allowing the width to be set in a stylesheet.Method that controls the creation of the generated button content. The method must create and return a new element.
+<option>
element.<optgroup>
, this is set to that <optgroup>
's label.value
attribute of the item's original <option>
.", {
+ "class": "ui-selectmenu-text"
+ })
+ this._setText( buttonItem, item.label );
+
+ buttonItem.css( "background-color", item.value )
+
+ return buttonItem;
+}
]]>
When using this effect with the .show()
and .toggle()
methods, the to
argument is used as the starting point and the original size used as the endpoint.
ui-slider
: The track of the slider control. This element will additionally have a class name of ui-slider-horizontal
or ui-slider-vertical
depending on the orientation
of the slider.
+ ui-slider
: The track of the slider control. This element will additionally have a class name of ui-slider-horizontal
or ui-slider-vertical
depending on the orientation
option of the slider.
ui-slider-handle
: The slider handles.ui-slider-range
: The selected range used when the range
option is set. This element can additionally have a class of ui-slider-range-min
or ui-slider-range-max
if the range
option is set to "min"
or "max"
respectively.ui-slider-handle
: One of the slider handles.ui-slider-range
: The selected range used when the range
option is set. This element can additionally have a class of ui-slider-range-min
or ui-slider-range-max
if the range
option is set to "min"
or "max"
respectively.The jQuery UI Sortable plugin makes selected elements sortable by dragging with the mouse.
Note: In order to sort table rows, the tbody
must be made sortable, not the table
.
ui-sortable
: The sortable element.
+ ui-sortable-handle
: The handle of each sortable item, specified using the handle
option. By default, each sortable item itself is also the handle.ui-sortable-placeholder
: The element used to show the future position of the item currently being sorted.ui-sortable-helper
: The element shown while dragging a sortable item. The element actually used depends on the helper
option.connectWith
option must be set on both sortable elements.{ top, left, right, bottom }
.null
, the currently set culture in Globalize
is used, see Globalize docs for available cultures. Only relevant if the numberFormat
option is set. Requires Globalize to be included.ui-tabs
: The outer container of the tabs. This element will additionally have a class of ui-tabs-collapsible
when the collapsible
option is set.
+ ui-tabs
: The outer container of the tabs. This element will additionally have a class of ui-tabs-collapsible
when the collapsible
option is set.
ui-tabs-nav
: The list of tabs.
ui-tabs-active
class. Any list item whose associated content is loading via an Ajax call will have a ui-tabs-loading
class.
+ ui-tabs-tab
: One of the items in the list of tabs.The active item will have the ui-tabs-active
class. Any list item whose associated content is loading via an Ajax call will have the ui-tabs-loading
class.
ui-tabs-anchor
: The anchors used to switch panels.true
, the active panel can be closed.The content of the tooltip.
@@ -59,6 +66,12 @@This may get replaced by the classes option.
+A class to add to the widget, can be used to display various tooltip types, like warnings or errors.
+The tooltipClass
option has been deprecated in favor of the classes
option, using the ui-tooltip
property.
Very useful when trying to visualize interaction between two elements.
The transfer element itself has the class ui-effects-transfer
, and needs to be styled by you, for example by adding a background or border.
This effect is deprecated, replaced by the .transfer() method.
Very useful when trying to visualize interaction between two elements.
+The transfer element itself has the class ui-effects-transfer
, and needs to be styled by you, for example by adding a background or border.
ui-effects-transfer
."fast"
and "slow"
can be supplied to indicate durations of 200 and 600 milliseconds, respectively. The number type indicates the duration in milliseconds.
+
+
+]]>
+ false
, the animation will begin immediately. A string can also be provided, in which case the animation is added to the queue represented by that string.false
, the animation will begin immediately. A string can also be provided, in which case the animation is added to the queue represented by that string.Specify additional classes to add to the widget's elements. Any of classes specified in the Theming section can be used as keys to override their value. To learn more about this option, check out the learn article about the classes
option.
classes
option specified, changing the theming for the ui-
class:
+$( ".selector" ). ({
+ classes: {
+ "ui- ": "highlight"
+ }
+});
+
+ classes
option, after initialization, here reading and changing the theming for the ui-
class:
+// Getter
+var themeClass = $( ".selector" ). ( "option", "classes.ui- " );
+
+// Setter
+$( ".selector" ). ( "option", "classes.ui- ", "highlight" );
+
+ The
The classes
option:
.ui-widget-overlay
: Applies 100% width & height dimensions to an overlay screen, along with background color/texture, and screen opacity.
.ui-widget-shadow
: Class to be applied to overlay widget shadow elements. Applies background color/texture, custom corner radius, opacity, top/left offsets and shadow "thickness". Thickness is applied via padding to all sides of a shadow that is set to match the dimensions of the overlay element. Offsets are applied via top and left margins (can be positive or negative).
+ .ui-widget-shadow
: Class to be applied to overlay widget shadow elements. Sets box-shadow
x & y offset, blur radius and color.