npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@ivi/htm

v3.0.2

Published

ivi HTML-like markup language.

Downloads

7

Readme

ivi HTML Template Language

@ivi/htm module provides an interface for creating ivi templates with template literals:

htm`
  <div id="app">
    <h1>Template Example</h1>
    <div class="content">
      ${condition ? "true" : "false"}
    </div>
  </div>
`;

Multiple Root Nodes

htm`
  <div></div>
  ${expr}
  text
  <div></div>
`

Childless elements can be self closed with a /> syntax

htm`
  <div
    class="a"
  />
`;

Whitespaces

  1. Whitespaces around newlines are removed:
<div>
  <p></p>
  ab
  <p></p>
</div>
<div><p></p>ab<p></p></div>
  1. Inline whitespaces are collapsed into one whitespace:
<div>  <span>  a  b  </span>  </div>
<div> <span> a b </span> </div>
  1. Whitespaces around newlines in text nodes are collapsed into one whitespace:
<div>
  ab
  cd
</div>
<div>ab cd</div>
  1. Vertical tab \v character prevents from removing all whitespaces around newlines:
<div>
  <b>1</b>
  \v item left
<div>
<div><b>1</b> item left</div>

Element Attributes Syntax

HTML Template Language supports additional syntax to work with DOM properties, events, etc.

Attributes

  • <div name="value" /> - Static attribute with a value <div name="value">.
  • <div name /> - Static attribute without a value <div name>.
  • <div name=${expr} /> - Dynamic attribute element.setAttribute(name, expr).

DOM attributes are assigned with Element.setAttribute(..).

When dynamic attribute has an undefined, null or false value, it will be removed from the DOM element with Element.removeAttribute(..) method.

Properties

  • <div .name=${expr} /> - Property element[name] = expr.
  • <div *name=${expr} /> - Property element[name] = expr, diffs against a DOM value.

Properties are assigned with an assignment operator Element.name = value.

Diffing with a DOM value is useful in use cases when we use <input> values to avoid triggering unnecessary input events.

Styles

  • <div ~name="value" /> - Static style <div style="value">.
  • <div ~name=${expr} /> - Dynamic style element.style.setProperty(name, expr).

Static styles are automatically merged with :style="value" attribute.

Dynamic styles are assigned with a CSSStyleDeclaration.setProperty(..) method.

When style has an undefined, null or false value, it will be removed with CSSStyleDeclaration.removeProperty(..) method.

Events

  • <div @name=${expr} /> - Event element.addEventListener(name, expr).

Events are assigned with an EventTarget.addEventListener(..) method.

When event has an undefined, null or false value, it will be removed with EventTarget.removeEventListener(..) method.

Directives

  • <div ${directive} /> - Client-Side Element Directive directive(element).
  • <div &=${directive} /> - Client-Side Element Directive directive(element).
  • <div &:ssr=${directive} /> - Element Directive that works during Client-Side and Server-Side Rendering directive(element, hydrate).

Directive is a function that is invoked each time template is updated and receives a DOM element associated with a directive:

type ElementDirective = <E extends Element>(
  element: E,
  hydrate?: boolean,
) => void | string | { a?: string, c?: string; };

Directive function is invoked only when template is created with a different function, so if we are going to reuse the same function, it can be used as a DOM element created callback:

const Example = component((c) => {
  const onCreated = (innerElement) => {
    // ..
  };
  return () => htm`
    <div>
      <div class="Inner" ${onCreated} />
    </div>
  `;
});

Directives can be used not just as a simple DOM created callbacks, but also as stateful directives. E.g.

function createStatefulDirective() {
  // Internal state that stores previous value.
  let prev;
  // Returns a factory that creates directive functions.
  return (next) => (element) => {
    // Check if previous value has been changed.
    if (prev !== next) {
      prev = next;
      // Updates textContent only when input value is changed.
      element.textContent = next;
    }
  };
}

const Example = component((c) => {
  const directive = createStatefulDirective();
  return (i) => htm`
    <div ${directive(i)} />
  `;
});

Text Content

  • <div .textContent=${expr} /> - Text Content element.textContent = expr.

Text content property can be used as an optimization that slightly reduces memory consumption for elements with a text child. It will create a text node with a Node.textContent property and won't have any stateful nodes associated with a text node.

Text content value should have an undefined, null, false, string or a number type.