Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/chharvey/template-processor

A lightweight class for generating markup from a template and some data.
https://github.com/chharvey/template-processor

dom html template

Last synced: about 1 month ago
JSON representation

A lightweight class for generating markup from a template and some data.

Awesome Lists containing this project

README

        

# template-processor
A lightweight class for generating markup from a template and some data.

## Install
```bash
npm install template-processor
```

## Example

Given the following document,

```html

{{ text }}

```

The code below (JavaScript or Typescript) will append the following markup to the body.

```html
AN EXAMPLE
```

API:

1. Import the `Processor` class.
2. The constructor’s `instructions` argument must be a function returning `void`.
3. The constructor’s `instructions_async` argument, if provided, must be an asynchronous function returning a `Promise`.
(If providing `instructions_async`, the `instructions` argument is still required. It could be an empty function or a fallback to the async.)
4. The `process` method returns a `DocumentFragment`.
5. The asynchronous `processAsync` method returns a `Promise`.

### JavaScript

1. Import the module.
```js
const { Processor } = require('template-processor')
```

2. Get your own template & write your own instructions.
```js
const template = document.querySelector('template')
const instructions = (frag, data, opts) => {
frag.querySelector('a').href = data.url
frag.querySelector('a').textContent = (opts.uppercase) ? data.text.toUpperCase() : data.text
if (data.url.slice(0,4) === 'http') {
frag.querySelector('a').setAttribute('rel', 'external')
}
}
```
If your instructions uses I/O, you can write an asynchronous function.
Note that this function must not take promises as arguments.
```js
const instructionsAsync = async (frag, data, opts) => {
await doSomeAsyncStuff();
}
```

3. Construct a new processor with the stuff you wrote
(optionally provide the async instructions).
```js
let my_processor = new Processor(template, instructions)
my_processor = new Processor(template, instructions, instructionsAsync)
```

4. Process some data (synchronously or asynchronously).
```js
const snippet = my_processor.process({
url: 'https://www.example.com/',
text: 'an example',
}, { uppercase: true })
document.body.append(snippet)

my_processor.processAsync({
url: 'https://www.example.com/',
text: 'an example',
}, { uppercase: true }).then((snippet) => {
document.body.append(snippet)
})
```
You can also pass in promises for the data and options.
Here’s where the promises will be awaited.
```js
my_processor.processAsync(Promise.resolve({
url: 'https://www.example.com/',
text: 'an example',
}), Promise.resolve({ uppercase: true })).then((snippet) => {
document.body.append(snippet)
})
```

### TypeScript

1. Import the module.
```ts
import { Processor } from 'template-processor'
```

2. Get your own template & write your own instructions.
```ts
type DataType = { url: string; text: string; }
type OptsType = { uppercase?: boolean; }

const template: HTMLTemplateElement = document.querySelector('template') !
const instructions = (frag: DocumentFragment, data: DataType, opts: OptsType): void => {
frag.querySelector('a').href = data.url
frag.querySelector('a').textContent = (opts.uppercase) ? data.text.toUpperCase() : data.text
if (data.url.slice(0,4) === 'http') {
frag.querySelector('a').setAttribute('rel', 'external')
}
}
```
If your instructions uses I/O, you can write an asynchronous function.
Note that this function must not take promises as arguments.
```ts
const instructionsAsync = async (frag: DocumentFragment, data: DataType, opts: OptsType): Promise => {
await doSomeAsyncStuff();
}
```

3. Construct a new processor with the stuff you wrote
(optionally provide the async instructions).
```ts
let my_processor: Processor = new Processor(template, instructions)
my_processor = new Processor(template, instructions, instructionsAsync)
```

4. Process some data (synchronously or asynchronously).
```ts
const snippet: DocumentFragment = my_processor.process({
url: 'https://www.example.com/',
text: 'an example',
}, { uppercase: true })
document.body.append(snippet)

my_processor.processAsync({
url: 'https://www.example.com/',
text: 'an example',
}, { uppercase: true }).then((snippet) => {
document.body.append(snippet)
})
```
You can also pass in promises for the data and options.
Here’s where the promises will be awaited.
```ts
const data: Promise = Promise.resolve({
url: 'https://www.example.com/',
text: 'an example',
})
const opts: Promise = Promise.resolve({ uppercase: true })
my_processor.processAsync(data, opts).then((snippet) => {
document.body.append(snippet)
})
```

## Why?

The point is to have one template and one instruction, but tons of data.

```js
let dataset = [
{ "name": "twitter" , "url": "//twitter.com/god" , "text": "Follow God on Twitter" },
{ "name": "google" , "url": "//plus.google.com/god", "text": "Follow God on Google+" },
{ "name": "facebook", "url": "//facebook.com/god" , "text": "Like God on Facebook" },
{ "name": "linkedin", "url": "//linkedin.com/god" , "text": "Connect with God on LinkedIn" },
{ "name": "youtube" , "url": "//youtube.com/god" , "text": "Watch God on YouTube" },
// even more and more
]
// or it could be a promise:
dataset = Promise.resolve([
{ "name": "twitter" , "url": "//twitter.com/god" , "text": "Follow God on Twitter" },
// even more and more
])

const document = createDocument`

Social Media Links


`
```

Synchronously:
```js
const processor = new Processor(document.querySelector('ul > template'), (frag, data, opts) => {
frag.querySelector('a.c-LinkList__Link').href = data.url
frag.querySelector('i' ).className = `icon icon-${data.name}`
frag.querySelector('slot[name="text"]' ).textContent = data.text
})

document.querySelector('ul').append(...dataset.map((data) => processor.process(data)))
```

Asynchronously:
```js
const processor = new Processor(document.querySelector('ul > template'), () => {}, async (frag, data, opts) => {
await doSomeAsyncStuff();
frag.querySelector('a.c-LinkList__Link').href = data.url
frag.querySelector('i' ).className = `icon icon-${data.name}`
frag.querySelector('slot[name="text"]' ).textContent = data.text
})

// with promises:
dataset.then((datapoints) =>
Promise.all(datapoints.map((data) => processor.processAsync(data)))
).then((frags) =>
document.querySelector('ul').append(...frags)
)

// with await:
document.querySelector('ul').append(
...await Promise.all((await dataset).map((data) => processor.processAsync(data)))
)
```

Starting in v1.2, we can do the above much more efficiently with two new static methods:
`Processor.populateList` and `Processor.populateListAsync`.
They check for a `` inside the list and ensure it has the correct markup structure.

Synchronously:
```js
Processor.populateList(document.querySelector('ul'), (frag, data, opts) => {
frag.querySelector('a.c-LinkList__Link').href = data.url
frag.querySelector('i' ).className = `icon icon-${data.name}`
frag.querySelector('slot[name="text"]' ).textContent = data.text
}, dataset)
```

Asynchronously:
```js
Processor.populateListAsync(document.querySelector('ul'), async (frag, data, opts) => {
await doSomeAsyncStuff();
frag.querySelector('a.c-LinkList__Link').href = data.url
frag.querySelector('i' ).className = `icon icon-${data.name}`
frag.querySelector('slot[name="text"]' ).textContent = data.text
}, Promise.resolve(dataset))
```