Resizable Widget | jQuery UI API Documentation (original) (raw)

Description: Change the size of an element using the mouse.

QuickNavExamples

Options

Methods

Events

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.

Theming

The resizable widget uses the jQuery UI CSS framework to style its look and feel. If resizable specific styling is needed, the following CSS class names can be used for overrides or as keys for the classes option:

• 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.

Dependencies

• UI Core
• Widget Factory
• Mouse Interaction

Additional Notes:

• This widget requires some functional CSS, otherwise it won't work. If you build a custom theme, use the widget's specific CSS file as a starting point.

Options

alsoResize

Default: false

One or more elements to resize synchronously with the resizable element.

Code examples:

Initialize the resizable with the alsoResize option specified:

Get or set the alsoResize option, after initialization:

animate

Default: false

Animates to the final size after resizing.

Code examples:

Initialize the resizable with the animate option specified:

Get or set the animate option, after initialization:

animateDuration

Default: "slow"

How long to animate when using the animate option.

Multiple types supported:

• Number: Duration in milliseconds.
• String: A named duration, such as "slow" or "fast".

Code examples:

Initialize the resizable with the animateDuration option specified:

Get or set the animateDuration option, after initialization:

animateEasing

Default: "swing"

Which easing to apply when using the animate option.

Code examples:

Initialize the resizable with the animateEasing option specified:

Get or set the animateEasing option, after initialization:

aspectRatio

Default: false

Whether the element should be constrained to a specific aspect ratio.

Multiple types supported:

• Boolean: When set to true, the element will maintain its original aspect ratio.
• Number: Force the element to maintain a specific aspect ratio during resizing.

Code examples:

Initialize the resizable with the aspectRatio option specified:

Get or set the aspectRatio option, after initialization:

autoHide

Default: false

Whether the handles should hide when the user is not hovering over the element.

Code examples:

Initialize the resizable with the autoHide option specified:

Get or set the autoHide option, after initialization:

cancel

Default: "input,textarea,button,select,option"

Prevents resizing from starting on specified elements.

Code examples:

Initialize the resizable with the cancel option specified:

Get or set the cancel option, after initialization:

classes

Default:

"ui-resizable-se": "ui-icon ui-icon-gripsmall-diagonal-se"

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.

Code examples:

Initialize the resizable with the classes option specified, changing the theming for the ui-resizable class:

Get or set a property of the classes option, after initialization, here reading and changing the theming for the ui-resizable class:

containment

Default: false

Constrains resizing to within the bounds of the specified element or region.

Multiple types supported:

• Selector: The resizable element will be contained to the bounding box of the first element found by the selector. If no element is found, no containment will be set.
• Element: The resizable element will be contained to the bounding box of this element.
• String: Possible values: "parent" and "document".

Code examples:

Initialize the resizable with the containment option specified:

Get or set the containment option, after initialization:

delay

Default: 0

Tolerance, in milliseconds, for when resizing should start. If specified, resizing will not start until after mouse is moved beyond duration. This can help prevent unintended resizing when clicking on an element. (version deprecated: 1.12)

Code examples:

Initialize the resizable with the delay option specified:

Get or set the delay option, after initialization:

disabled

Default: false

Disables the resizable if set to true.

Code examples:

Initialize the resizable with the disabled option specified:

Get or set the disabled option, after initialization:

distance

Default: 1

Tolerance, in pixels, for when resizing should start. If specified, resizing will not start until after mouse is moved beyond distance. This can help prevent unintended resizing when clicking on an element. (version deprecated: 1.12)

Code examples:

Initialize the resizable with the distance option specified:

Get or set the distance option, after initialization:

ghost

Default: false

If set to true, a semi-transparent helper element is shown for resizing.

Code examples:

Initialize the resizable with the ghost option specified:

Get or set the ghost option, after initialization:

grid

Default: false

Snaps the resizing element to a grid, every x and y pixels. Array values: [ x, y ].

Code examples:

Initialize the resizable with the grid option specified:

Get or set the grid option, after initialization:

handles

Default: "e, s, se"

Which handles can be used for resizing.

Multiple types supported:

• String: A comma delimited list of any of the following: n, e, s, w, ne, se, sw, nw, all. The necessary handles will be auto-generated by the plugin.
• Object:
  The following keys are supported: { n, e, s, w, ne, se, sw, nw }. The value of any specified should be a jQuery selector matching the child element of the resizable to use as that handle. If the handle is not a child of the resizable, you can pass in the DOMElement or a valid jQuery object directly.
  Note: When generating your own handles, each handle must have the ui-resizable-handle class, as well as the appropriate ui-resizable-{direction} class, .e.g., ui-resizable-s.

Code examples:

Initialize the resizable with the handles option specified:

Get or set the handles option, after initialization:

helper

Default: false

A class name that will be added to a proxy element to outline the resize during the drag of the resize handle. Once the resize is complete, the original element is sized.

Code examples:

Initialize the resizable with the helper option specified:

Get or set the helper option, after initialization:

maxHeight

Default: null

The maximum height the resizable should be allowed to resize to.

Code examples:

Initialize the resizable with the maxHeight option specified:

Get or set the maxHeight option, after initialization:

maxWidth

Default: null

The maximum width the resizable should be allowed to resize to.

Code examples:

Initialize the resizable with the maxWidth option specified:

Get or set the maxWidth option, after initialization:

minHeight

Default: 10

The minimum height the resizable should be allowed to resize to.

Code examples:

Initialize the resizable with the minHeight option specified:

Get or set the minHeight option, after initialization:

minWidth

Default: 10

The minimum width the resizable should be allowed to resize to.

Code examples:

Initialize the resizable with the minWidth option specified:

Get or set the minWidth option, after initialization:

Methods

destroy()Returns: jQuery (plugin only)

Removes the resizable functionality completely. This will return the element back to its pre-init state.

• This method does not accept any arguments.

Code examples:

Invoke the destroy method:

disable()Returns: jQuery (plugin only)

Disables the resizable.

• This method does not accept any arguments.

Code examples:

Invoke the disable method:

enable()Returns: jQuery (plugin only)

Enables the resizable.

• This method does not accept any arguments.

Code examples:

Invoke the enable method:

instance()Returns: Object

Retrieves the resizable's instance object. If the element does not have an associated instance, undefined is returned.

Unlike other widget methods, instance() is safe to call on any element after the resizable plugin has loaded.

• This method does not accept any arguments.

Code examples:

Invoke the instance method:

option( optionName )Returns: Object

Gets the value currently associated with the specified optionName.

Note: For options that have objects as their value, you can get the value of a specific key by using dot notation. For example, "foo.bar" would get the value of the bar property on the foo option.

• optionName
  The name of the option to get.

Code examples:

Invoke the method:

option()Returns: PlainObject

Gets an object containing key/value pairs representing the current resizable options hash.

• This signature does not accept any arguments.

Code examples:

Invoke the method:

option( optionName, value )Returns: jQuery (plugin only)

Sets the value of the resizable option associated with the specified optionName.

Note: For options that have objects as their value, you can set the value of just one property by using dot notation for optionName. For example, "foo.bar" would update only the bar property of the foo option.

• optionName
  The name of the option to set.
• value
  A value to set for the option.

Code examples:

Invoke the method:

option( options )Returns: jQuery (plugin only)

Sets one or more options for the resizable.

• options
  A map of option-value pairs to set.

Code examples:

Invoke the method:

Events

create( event, ui )Type: resizecreate

Triggered when the resizable is created.

• event
• ui

Note: The ui object is empty but included for consistency with other events.

Code examples:

Initialize the resizable with the create callback specified:

Bind an event listener to the resizecreate event:

resize( event, ui )Type: resize

This event is triggered during the resize, on the drag of the resize handler.

• event
• ui
  • element
    The jQuery object representing the element to be resized
  • helper
    The jQuery object representing the helper that's being resized
  • originalElement
    The jQuery object representing the original element before it is wrapped
  • originalPosition
    The position represented as { left, top } before the resizable is resized
  • originalSize
    The size represented as { width, height } before the resizable is resized
  • position
    The current position represented as { left, top }. The values may be changed to modify where the element will be positioned. Useful for custom resizing logic.
  • size
    The current size represented as { width, height }. The values may be changed to modify where the element will be positioned. Useful for custom resizing logic.

Code examples:

Initialize the resizable with the resize callback specified:

Bind an event listener to the resize event:

Restrict height resizing to 30 pixel increments:

start( event, ui )Type: resizestart

This event is triggered at the start of a resize operation.

• event
• ui
  • element
    The jQuery object representing the element to be resized
  • helper
    The jQuery object representing the helper that's being resized
  • originalElement
    The jQuery object representing the original element before it is wrapped
  • originalPosition
    The position represented as { left, top } before the resizable is resized
  • originalSize
    The size represented as { width, height } before the resizable is resized
  • position
    The current position represented as { left, top }
  • size
    The current size represented as { width, height }

Code examples:

Initialize the resizable with the start callback specified:

Bind an event listener to the resizestart event:

stop( event, ui )Type: resizestop

This event is triggered at the end of a resize operation.

• event
• ui
  • element
    The jQuery object representing the element to be resized
  • helper
    The jQuery object representing the helper that's being resized
  • originalElement
    The jQuery object representing the original element before it is wrapped
  • originalPosition
    The position represented as { left, top } before the resizable is resized
  • originalSize
    The size represented as { width, height } before the resizable is resized
  • position
    The current position represented as { left, top }
  • size
    The current size represented as { width, height }

Code examples:

Initialize the resizable with the stop callback specified:

Bind an event listener to the resizestop event:

Example:

A simple jQuery UI Resizable.

Demo: