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

genietalkcards-templating

v1.0.1

Published

Genietalk Card data binding and templating engine for JavaScript

Downloads

2

Readme

Genietalk Card Templating for JavaScript

This library implements a JSON-to-JSON templating/data-binding engine. While it is designed to be used with Genietalk Cards, it is not dependent on Genietalk Cards and can therefore be used in many contexts and applications.

Learn more about Genietalk Card Templating

Install and import the module

Node

npm install adaptive-expressions genietalkcards-templating --save
// Import the module:
import * as GCData from "genietalkcards-templating";

// OR require it:
var GCData = require("genietalkcards-templating");

CDN

The unpkg.com CDN makes it easy to load the script in an browser.

The latest release will keep you up to date with features and fixes, but may have breaking changes over time. For maximum stability you should use a specific version.

  • genietalkcards-templating.js - non-minified, useful for dev
  • genietalkcards-templating.min.js - minified version, best for production
<!-- Option 1: always load the latest release -->
<script src="https://unpkg.com/genietalkcards-templating/dist/genietalkcards-templating.min.js"></script>

<!-- Option 2: load a specific version (e.g, 1.0-rc1) -->
<script src="https://unpkg.com/genietalkcards-templating@<VERSION>/dist/genietalkcards-templating.min.js"></script>

Once the library is loaded, the global GCData variable is defined and ready to be used.

Usage

Hello World example

Here is a simplistic "Hello World" example on how to use the library to generate an Genietalk Card using a template bound to a data object. Note this example requires the genietalkcards package.

import * as GCData from "genietalkcards-templating";
import * as GenietalkCards from "genietalkcards";

// Define a template payload
var templatePayload = {
    "type": "GenietalkCard",
    "version": "1.0",
    "body": [
        {
            "type": "TextBlock",
            "text": "Hello ${name}!"
        }
    ]
};

// Create a Template instance from the template payload
var template = new GCData.Template(templatePayload);

// Create a data binding context, and set its $root property to the
// data object to bind the template to
var context: GCData.IEvaluationContext = {
    $root = {
        "name": "Genietalk Cards"
    }
};

// "Expand" the template - this generates the final Genietalk Card,
// ready to render
var card = template.expand(context);

// Render the card
// var GenietalkCards = new GenietalkCards.GenietalkCard();
// GenietalkCards.parse(card);

// document.getElementById('exampleDiv').appendChild(GenietalkCards.render());

This example is implemented in the example.html file.

Functions

Built-in functions

For a list of and documentation on built-in functions, please refer to the AdaptiveExpressions documentation.

Custom functions

// Coming soon...