2.0.0 • Published 9 years ago

document-section v2.0.0

Weekly downloads
5
License
BSD
Repository
github
Last release
9 years ago

Build Status

document sections allows you to keep track, and modify document fragments that have been appended to the DOM. For example:

var createDocumentSection = require("document-section");

var helloSection = createDocumentSection(), buttonSection = createDocumentSection(), buttonElement;

// add multiple items - this demonstrates how multiple nodes are controlled by one
// section
helloSection.appendChild(document.createTextNode("Hello "));
helloSection.appendChild(document.createTextNode("World!"));

// setup the button which toggles the message visibility
buttonSection.appendChild(buttonElement = $("<div><a href='#'>Toggle Message Visibility</a></div>")[0]);

// create a toggle for the "Hello World!" message.
$(buttonElement).click(function () {
    if(helloSection.visible) {
        helloSection.hide();
    } else {
        helloSection.show();
    }
});

// convert the sections into controlled document fragments.
document.body.appendChild(helloSection.render());
document.body.appendChild(buttonSection.render());

Output:

<html>
  <head>
    
  </head>
  <body>
    <div id="application">
      Hello World!
      <div>
        <a href="#">Toggle Message Visibility</a>
      </div>
    </div>
  </body>
</html>

Here's a live example: http://jsfiddle.net/4L8wy/1/. Be sure to inspect the DOM as you're toggling the message visibility!

API

section createDocumentSection(nodeFactory = document)

creates a new block of dom elements

section.hide()

hides the section - replaces all bundled nodes with a placeholder node

section.show()

displays the section if it's hidden

section.appendChild(children...)

appends a node to the section

section.appendChild(children...)

prepends a node to the section

section.replaceChildNodes(children...)

disposes the document section

section.toFragment()

returns the section as a document fragment

section.dispose()

removes all child nodes

section.getChildNodes()

returns an array of the child nodes

section.start

the start marker for the section

section.end

the stop marker for the section