https://github.com/isleofcode/ember-render-vendor
https://github.com/isleofcode/ember-render-vendor
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/isleofcode/ember-render-vendor
- Owner: isleofcode
- License: mit
- Created: 2017-04-24T19:55:32.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-10-25T23:24:42.000Z (over 2 years ago)
- Last Synced: 2024-04-11T20:55:59.924Z (almost 2 years ago)
- Language: JavaScript
- Size: 903 KB
- Stars: 9
- Watchers: 4
- Forks: 2
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ember-render-vendor
ember-render-vendor is an Ember+Electron addon that wraps
[RenderVendor](https://github.com/isleofcode/render-vendor)'s blazing-fast PDF
rendering services with opinionated build tooling for easy integration into
Ember apps.
## Installation
* `ember install ember-render-vendor --save`
_n.b. we use `--save` to install e-r-v as a dep, so it will be packaged with
your e-electron builds_
## Usage
This addon's default blueprint should generate a `renderers` dir at the root
of your app, with one subdir (`-public`).
Any files added to `-public` will be available for use in all renderer
templates.
Valid `renderers` subdirs do not start with a `-`, and contain two files:
* `template.hbs`, a handlebars file that defines your renderer's template (w/ dynamic data provided by `data`); and
* `renderer.js`, which is loaded into your Ember app and may be accessed with the `rendererFor` helper (use it like service injection)
* > `import { rendererFor } from 'ember-render-vendor';`
#### Sample files
```handlebars
{{! renderers/invoice/template.hbs }}
hello {{data.customerName}}
you owe {{data.total}}
#logo {
padding: 10px;
}
h1 {
font-weight: bold;
}
```
```javascript
// renderers/invoice/renderer.js
import Renderer from 'ember-render-vendor';
export default Renderer.extend({
attrs: [
{ 'customer.name': 'customerName' },
'total'
],
render() {
return this._super({
type: 'pdf',
width: '2.25in',
height: '1.25in'
})
}
});
```
```javascript
// app/routes/invoice.js
import { rendererFor } from 'ember-render-vendor';
export Ember.Route.extend({
renderer: rendererFor('invoice'),
afterModel(model) {
this.set('renderer.data', model);
},
actions: {
renderPdf() {
this.get('renderer').render()
.then((buffer) => console.log(`raw pdf buffer: ${buffer}`));
}
}
});
```
```javascript
// ember-electron/main.js
// n.b. ideally this will move to an addon-friendly initializer + cleanup story upstream
// ...
let initializersDir = join(process.cwd(), 'ember-electron', 'initializers');
readdirSync(initializersDir)
.map((name) => require(join(initializersDir, name)))
.forEach((initializer) => initializer(app));
// ...
```
## Running
* `ember electron`
* `ember electron:package`
## ToDos
* write test suite
* chat with Fastboot team about server integration
* consider implementing e-electron build tooling upstream