No Description

Matheus Giovani 2fd15c8dc1 added support for comments to virtual-dom 3 years ago
examples 2fd15c8dc1 added support for comments to virtual-dom 3 years ago
packages 2fd15c8dc1 added support for comments to virtual-dom 3 years ago
test 43d0b5515e fixes reactivity 3 years ago
.gitignore 958b7dbec6 added a simple lexer for the tags 3 years ago
.gitmodules bfa4cc8e1f added virtual-dom submodule 3 years ago
.npmignore 43d0b5515e fixes reactivity 3 years ago
LICENSE d873f3a526 first commit 3 years ago
README.md e5f79a8374 added implementation tag and one new example 3 years ago
jest.config.js 57dbd2e0b8 general refactor 3 years ago
nodemon.json 2fd15c8dc1 added support for comments to virtual-dom 3 years ago
package.json 43d0b5515e fixes reactivity 3 years ago
tsconfig.json dd48e19f34 reformulated component declaration 3 years ago
webpack.config.js 2fd15c8dc1 added support for comments to virtual-dom 3 years ago

README.md

pupper.js icon

pupper.js

pupper.js is a reactive template engine based in pugjs.

This is a BETA project, it can change drastically over time, so use it with caution for now and stay updated! :D


Basic syntax

pupper.js is based in pugjs, you can learn about pugjs's syntax here.

There's some new syntax added to use the reactivity:

  • {{ variable }} Renders the contents of variable as text, replacing HTML entities with escaped entities.
  • {- variable -} Renders the literal content of variable as-is

How to use

You can integrate pupper.js to your application by using one of the given loaders that compiles .pupper files into Javascript:


Or, you can integrate using the API:

const pupper = require("@pupperjs/core");
const Renderer = pupper.Renderer;

// Compiles the template to a string
const template = pupper.compileToStringSync(/*pupper*/`
template
    .test
        span.hello-world(id={{ id }})
            ={- content -}
`);

// Create a renderer (view) with some starting data
const renderer = new Renderer(template, {
    id: "the-id",
    content: "Hello, beautiful world!"
});

/**
 * <div class="test">
 *      <span class="hello-world" id="the-id">
 *          Hello, beautiful world!
 *      </span>
 * </div> 
 */
renderer.renderToString();