Giter VIP home page Giter VIP logo

template-html's Introduction

This repository is now deprecated because the Shadow DOM spec has changed fairly drastically and this API is not ideal for consumers of authors that use it. It exists for backward compatibility purposes only and will be deleted in the future.

[DEPRECATED] Skate HTML Templates

Skate HTML templates is designed to be a very light implementation of how Shadow DOM uses <content> nodes and select attributes to project Light DOM. Just because it has Skate in the name doesn't mean you have to use it with Skate. It can be used completely on its own, too.

It works by defining a template:

var myTemplate = skateTemplateHtml(`
  <article>
    <h3>
      <content select=".heading"></content>
    </h3>
    <section>
      <content>
        <p>There is no content to display.</p>
      </content>
    </section>
  </article>
`);

The compiled template is just a function that you call on an element. If you called the template above on the body:

myTemplate(document.body);

The result would be:

<body>
  <article>
    <h3></h3>
    <section>There is no content to display.</section>
  </article>
</body>

If this already existed in the body:

<body>
  <span class="heading">My Heading</span>
  <p>First paragraph.</p>
  <p>Second paragraph.</p>
</body>

Then it would have been transformed into:

<body>
  <article>
    <h3><span class="heading">My Heading</span></h3>
    <section>
      <p>First paragraph.</p>
      <p>Second paragraph.</p>
    </section>
  </article>
</body>

Once you template an element, it's accessors and methods are overridden so that you're only working with the Light DOM.

var thirdParagraph = document.createElement('p');
thirdParagraph.textContent = 'Third paragraph.';
body.appendChild(thirdParagraph);

Doing that would result in:

<body>
  <article>
    <h3><span class="heading">My Heading</span></h3>
    <section>
      <p>First paragraph.</p>
      <p>Second paragraph.</p>
      <p>Third paragraph.</p>
    </section>
  </article>
</body>

Notice how the when you appended the content, it didn't actually append it to the body, it actually appended it to the content area that was selecting paragraphs.

You could have achieved the same thing doing:

body.innerHTML += '<p>Third paragraph.</p>';

Additionally, if all paragraphs were removed from the <section>:

body.removeChild(body.childNodes[2]);
body.removeChild(body.childNodes[1]);
body.removeChild(body.childNodes[0]);

Then the default content that we specified in the template definition would take their place:

<body>
  <article>
    <h3>
      <span class="heading">My Heading</span>
    </h3>
    <section>
      <p>There is no content to display.</p>
    </section>
  </article>
</body>

If you decide you want to put some content back in, then it will remove the default content in favour of the content you specify.

To unwrap a node that has been wrapped (accessors / methods overridden) just call unwrap() on the node:

skateTemplateHtml.unwrap(document.body);

You can also manually wrap an element instead of templating it:

skateTemplateHtml.wrap(document.body);

The properties and methods that are overridden to give you this behaviour are:

  1. appendChild()
  2. childNodes
  3. children
  4. firstChild
  5. innerHTML
  6. insertAdjacentHTML()
  7. insertBefore()
  8. lastChild
  9. outerHTML
  10. removeChild()
  11. replaceChild()
  12. textContent

The following properties and methods are not overridden but will be:

  1. getElementsByClassName()
  2. getElementsByTagName()
  3. getElementsByTagNameNS()
  4. nextSibling
  5. parentElement
  6. parentNode
  7. previousSibling
  8. querySelector()
  9. querySelectorAll()
  10. remove()

License

The MIT License (MIT)

Copyright (c) 2014 - 2015

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

template-html's People

Contributors

bewong-atl avatar stevenschobert avatar treshugart avatar wbinnssmith avatar

Stargazers

avatar avatar avatar avatar avatar avatar

Watchers

avatar avatar avatar avatar avatar avatar avatar avatar avatar

Forkers

zephor wbinnssmith jstewsy

template-html's Issues

necessity of wrapping the element in order to dynamically project <content>

I don't have much experience writing polyfills, so forgive me and disregard if this is a dumb question.

I was wondering why the usage of a wrapper element that mostly implements the DOM element interface is necessary, versus simply overriding the methods on the prototype of the custom element you're declaring? Similar to how mutation observers are polyfilled in skatejs for IE:

Object.defineProperty(elementPrototype, "innerHTML", {...

If I write a custom element called "my-component" that projects some content from the light DOM, I'm assuming as it is now I couldn't then nest it inside a parent component and set its content dynamically:

<my-component>{{content via data-binding}}</my-component>

because a templating engine or whatever I'm using doesn't know to create the wrapper. Whether it just resets .innerHTML or does something more efficient, it won't trigger the projection logic that might (or might not, depending on the new content) be necessary.

Thanks!

Properties should not be accessed when wrapping the node.

When the node is wrapped, it traverses the node's members and creates wrappers for them. Currently, it accesses property values to check their type, however, if this is done it invokes the property getter which may not have had dependent logic properly set up at this point which can break certain implementations. In order to get around this, we should defer the checking of this in the proxy property.

templates break when there are new lines in the markup

You can observe this behaviour if you add a new line character to any of the tests. For example:

    it('should select specific content from the inital html', function () {
      el.innerHTML = '<span>one</span><span>two</span>';
      tmp('<span><content select="span"></content></span>')
        .innerHTML.should.equal('<span><!----><span>one</span><span>two</span><!----></span>');
    });

to

    it('should select specific content from the inital html', function () {
      el.innerHTML = '<span>one</span>\n<span>two</span>';
      tmp('<span><content select="span"></content></span>')
        .innerHTML.should.equal('<span><!----><span>one</span><span>two</span><!----></span>');
    });

throws this error:

'mozMatchesSelector' called on an object that does not implement interface Element.

Post-install of bower

Hey! Sorry for raising another issue so quickly after my pull-request.

I notice you are installing bower dependencies in your npm postinstall script. Is this for development purposes?

With bower being listed only under devDependencies, it causes npm install to fail. Moving bower into dependencies will fix the error, but I couldn't tell if it was needed or not, so I thought I'd ask first.

If its only required for development, you could do move into into a Makefile or something similar, and that would prevent all the users of your package from having to install bower and its dependencies.

Either way, I'm happy to open another pull-request for you.

Again, sorry to pester! Thanks for the awesome contributions!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.