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

pug-client-template

v2.1.2

Published

Enables creating client template functions from within the main pug template

Downloads

15

Readme

pug-client-template

Node middleware to allow parts of the pug template to be passed on and used in the browser.

This enables two new tags for pug files pugruntime and pugtemplate.

  • pugruntime - Outputs the pug runtime functions to the object window.pug (created by the tag).
  • pugtemplate - Outputs the block below it as a template function usable by client-side javascript.

The pugtemplate works just like mixins, and in fact compile to a mixin as well as the client side, so can be called just like a mixin would.

pugtemplate templateName(arg1, arg2, ...restArgs)

DEPRECATION NOTICE - namespaces will be deprecated in a future version.

The template name may be namespaced using dot notation. This allows you to specify which window variable will get the template function. If you do not specify a namespace, the default templates will be used. The name for the mixin will use the name with the dot replaced with an underscore.

pugtemplate tmpl.templateName(arg1)
+tmpl_templateName('arg')

Installation

This might work on earlier version of NodeJS, however the NPM version of >=3.0.0 should be followed (as most new installations today have that by default it shouldn't be to hard). NPM 3.0 started flattening dependencies, which this relies on - as the only listed dependency is Pug - though it still uses some of the dependencies of Pug.

npm install pug-client-template

Example

body
  #templateResult
  pugtemplate my_template(testVar)
    .my-template #{testVar}
  +my_template(varPassedIn)
  pugruntime
  script.
    $(function() {
      $('#templateResult').html(templates.my_template('Working'));
    });

Abbreviated output

<body>
  <div id="templateResult"></div>
  <div class="my-template">{value of varPassedIn}</div>
  <script>
    (function() {
      if (!window.templates) {
        window.templates = {};
      }
      if (!window.pug_mixins) {
        window.pug_mixins = {};
        window.pug_mixin_level = 0;
        window.pug_html = "";
      }
      window.templates.my_template = function my_template(arg1) {
        /* this is the compiled template function */
      };
    })();
  </script>
  <script>
    (function() {
      window.pug = {};
      function pug_attrs(t,r) {/* a pug runtime function - there are more than one */}
      window.pug.attrs = pug_attrs;
    })();
  </script>
  <script>
    $(function() {
      $('#templateResult').html(templates.my_template('Working'));
    });
  </script>
</body>