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

joinx

v1.0.1

Published

A light-weight javascript templating engine for generating html.

Downloads

12

Readme

JoinX

A light-weight javascript templating engine for generating html.

Features:

  • Write blocks of javascript to create dynamic html.
  • Express.js compatible.
  • Light-weight and fast.
  • Add blocks with just <JX @="<block name>" />.
  • Add custom path blocks with <JX @="./<folder name>/<block name>" />..
  • Supports adding a boilerplate.
  • Add custom default data that can be altered by passing in options.

Table of Contents

  1. Install
  2. Usage

Install

npm i --save joinx 

Usage

Options:

const JoinX = require('joinx')

// create JX passing in (options)
const JX = new JoinX({
  // views directory
  views: path.join(__dirname, './views'),
  // blocks directory
  blocks: path.join(__dirname, './views/blocks'),
  // boilerplate to render on each function call
  boilerplate: path.join(__dirname, './views/boilerplate/app.jx'),
  // default data
  default: {
    title: 'Default Title',
    description: 'Default Description',
  }
})

//// for express.js
// pass in app and 'jx' or custom file extension
// allows for res.render()
JX.use(app, 'jx)

Render:

//// JX pattern
// returns a promise
JX.render('fileName', {
  'data-key': 'data',
})

// express.js pattern
res.render('fileName', {
  'data-key': 'data',
})

JavaScript in HTML Use:

<ul>
  <!--> block of javascript that will render as html <-->
  <!-->  must call out$() or some other function to output a string to render <-->
  <JX>
    pages.forEach(page => {
      out$(`<li> ${page} </li>`)
    })
  </JX>
</ul>

<!--> output the string as html <-->
<p>{{ user.username }}</p>

Block Use:

<!--> include a block <-->
<JX @="<block-name>" />

<!--> include a block inside a custom directory <-->
<!--> must start with a . | ./ will equal the views directory <-->
<JX @="./custom/<block-name>" />

Boilerplate Use:

<JX @="head" />
<JX @="navbar" />

<!--> must include (children) block <-->
<!--> this is where the rest of your view will be rendered <-->
<JX @="children" />

<JX @="footer" />