Categories

.wrapAll()

Categories: DOM Insertion, Around | DOM Insertion, Around

.wrapAll( wrappingElement )Returns: jQuery

Description: Wrap an HTML structure around all elements in the set of matched elements.

  • .wrapAll( wrappingElement )

    version added: 1.0

    wrappingElement   An HTML snippet, selector expression, jQuery object, or DOM element specifying the structure to wrap around the matched elements.

The .wrapAll() function can take any string or object that could be passed to the $() function to specify a DOM structure. This structure may be nested several levels deep, but should contain only one inmost element. The structure will be wrapped around all of the elements in the set of matched elements, as a single group.

Consider the following HTML:

<div class="container">
  <div class="inner">Hello</div>
  <div class="inner">Goodbye</div>
</div>

Using .wrapAll(), we can insert an HTML structure around the inner <div> elements like so:

$('.inner').wrapAll('<div class="new" />');

The new <div> element is created on the fly and added to the DOM. The result is a new <div> wrapped around all matched elements:

<div class="container">
  <div class="new">
    <div class="inner">Hello</div>
    <div class="inner">Goodbye</div>
  </div>
</div>
  • Wrap a new div around all of the paragraphs.

    HTML:
    <p>Hello</p>
      <p>cruel</p>
      <p>World</p>
    CSS:
    
    
      div { border: 2px solid blue; }
      p { background:yellow; margin:4px; }
      
    Code:
    $("p").wrapAll("<div></div>");
  • Wraps a newly created tree of objects around the spans. Notice anything in between the spans gets left out like the <strong> (red text) in this example. Even the white space between spans is left out. Click View Source to see the original html.

    HTML:
    <span>Span Text</span>
      <strong>What about me?</strong>
      <span>Another One</span>
    CSS:
    
    
      div { border:2px blue solid; margin:2px; padding:2px; }
      p { background:yellow; margin:2px; padding:2px; }
      strong { color:red; }
      
    Code:
    $("span").wrapAll("<div><div><p><em><b></b></em></p></div></div>");
  • Wrap a new div around all of the paragraphs.

    HTML:
    <p>Hello</p>
      <p>cruel</p>
      <p>World</p>
    CSS:
    
    
      div { border: 2px solid blue; }
      p { background:yellow; margin:4px; }
      
    Code:
    $("p").wrapAll(document.createElement("div"));
  • Wrap a jQuery object double depth div around all of the paragraphs. Notice it doesn't move the object but just clones it to wrap around its target.

    HTML:
    <p>Hello</p>
      <p>cruel</p>
      <p>World</p>
      <div class="doublediv"><div></div></div>
    CSS:
    
    
      div { border: 2px solid blue; margin:2px; padding:2px; }
      .doublediv { border-color:red; }
      p { background:yellow; margin:4px; font-size:14px; }
      
    Code:
    $("p").wrapAll($(".doublediv"));

.wrapAll( wrappingElement )Returns: jQuery

Plugin: jQuery.xml

Description: Wrap an XML structure around each element in the set of matched elements.

  • .wrapAll( wrappingElement )

    version added: 1.0

    wrappingElement   An XML snippet, jQuery object, or DOM element specifying the structure to wrap around the matched elements.

This variant of .wrapAll() provides to wrap elements from a string in XML markup around the matched elements.

WrappingElement as XML string, is only available for XML documents, not HTML or XHTML.

  • Wrap a XML around all of elements containing the class 'inner'.

    XML:
    <?xml version="1.0" encoding="utf-8"?>
    <root>
      <entry class="inner">Hello</entry>
      <entry class="inner">Goodbye</entry>
    </root>
    Code:
    $( '.inner', xmlDocument ).wrapAll('<test />');
    // Wrap around all inner <entry> elements this wrappingElement
    Results:
    <?xml version="1.0" encoding="utf-8"?>
    <root>
      <test>
        <entry class="inner">Hello</entry>
        <entry class="inner">Goodbye</entry>
      </test>
    </root>