https://github.com/juliangruber/koa-dom

Dom templating for koa.
https://github.com/juliangruber/koa-dom

Last synced: 2 months ago
JSON representation

Dom templating for koa.

• Host: GitHub
• URL: https://github.com/juliangruber/koa-dom
• Owner: juliangruber
• Created: 2013-08-20T04:20:17.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2017-03-15T14:10:40.000Z (over 7 years ago)
• Last Synced: 2024-04-09T15:33:47.028Z (3 months ago)
• Language: JavaScript
• Size: 5.86 KB
• Stars: 11
• Watchers: 2
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Lists

• awesome-koa - koa-dom - 服务端渲染DOM模板。  (仓库 / 中间件)

README

        

# koa-dom

Dom templating for [koa](https://github.com/koajs/koa).

## Example

Given a layout file, make the app use it and set / stream html into dom selectors.

```js

var koa = require('koa');

var dom = require('koa-dom');

var fs = require('fs');

var app = koa();

var layout = dom(__dirname + '/layout.html');

app.use(layout);

app.use(function(next) {

  return function *() {

    yield next;

    this.dom['#foo'] = 'a sweet string';

    this.dom['#bar'] = fs.createReadStream(__dirname + '/lipsum.txt');

  }

});

app.listen(8000, function() {

  console.log('open http://localhost:8000/');

});

```

And the dom will be:

```html

a sweet string

Lorem ipsum dolor sit amet...

```

## API

### Dom(path)

A koa middleware that populates the context with `.dom`, an associative Array of dom selectors and strings / streams.

## Installation

With [npm](https://npmjs.org) do:

```bash

npm install koa-dom

```

## License

(MIT)

Copyright (c) 2013 Julian Gruber <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of

this software and associated documentation files (the "Software"), to deal in

the Software without restriction, including without limitation the rights to

use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies

of the Software, and to permit persons to whom the Software is furnished to do

so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.