Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stowball/quench-vue
Simple, client-side hydration of pre-rendered Vue.js apps
https://github.com/stowball/quench-vue
javascript spa ssr vuejs
Last synced: 3 months ago
JSON representation
Simple, client-side hydration of pre-rendered Vue.js apps
- Host: GitHub
- URL: https://github.com/stowball/quench-vue
- Owner: stowball
- License: mit
- Created: 2017-06-24T11:39:05.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-06-04T05:37:37.000Z (over 3 years ago)
- Last Synced: 2024-10-28T14:41:27.576Z (3 months ago)
- Topics: javascript, spa, ssr, vuejs
- Language: JavaScript
- Homepage: https://codesandbox.io/s/quench-vue-demo-foe55
- Size: 414 KB
- Stars: 75
- Watchers: 2
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Quench Vue
**Simple, tiny, client-side hydration of pre-rendered [Vue.js](https://vuejs.org) apps**
Quench Vue allows server-rendered/static markup to be used as a Vue app's `data`, `template` and local components' `template`s. It's great for when you can't/don't want to use "real" [server-side rendering](https://vuejs.org/v2/guide/ssr.html).
All of Vue's existing features will work as normal when the app is initialised in the browser.
## Table of Contents
- [Demo](#demo)
- [Installation](#installation)
- [npm](#npm)
- [Direct `` include](#direct-script-include)
- [Usage](#usage)
- [Defining the app `data` and `template`](#defining-the-app-data-and-template)
- [Method 1: Defining the `data` with `[q-data]`](#method-1-defining-the-data-with-q-data)
- [Rendering the data with `[v-text]`](#rendering-the-data-with-v-text)
- [Method 2: Defining the `data` with inline `[q-binding]` bindings](#method-2-defining-the-data-with-inline-q-binding-bindings)
- [Simple bindings](#simple-bindings)
- [Array and Object bindings](#array-and-object-bindings)
- [Array](#array)
- [Object](#object)
- [Array of Objects](#array-of-objects)
- [Non-element bindings](#non-element-bindings)
- [Referencing global variables as `data` properties](#referencing-global-variables-as-data-properties)
- [Excluding elements from the app template compiler](#excluding-elements-from-the-app-template-compiler)
- [Instantiating the app](#instantiating-the-app)
- [With a module bundler, such as webpack](#with-a-module-bundler-such-as-webpack)
- [For direct `<script>` include](#for-direct-script-include)
- [Defining local component `template`s](#defining-local-component-templates)
- [Specifying a component with `[q-component]`](#specifying-a-component-with-q-component)
- [Specifying a component's `template`](#specifying-a-components-template)
- [Handling a `template`'s logic](#handling-a-templates-logic)
- [Method 1: Add the logic within the markup](#method-1-add-the-logic-within-the-markup)
- [Method 2: Add the logic to the component's JavaScript using `partials`](#method-2-add-the-logic-to-the-components-javascript-using-partials)
- [Define a completely different component](#define-a-completely-different-component)
- [Excluding elements from the component template compiler](#excluding-elements-from-the-component-template-compiler)
- [Rendering future components dynamically](#rendering-future-components-dynamically)
- [Updating our app initialization to support pre-rendered components](#updating-our-app-initialization-to-support-pre-rendered-components)
- [With a module bundler, such as webpack](#with-a-module-bundler-such-as-webpack-1)
- [For direct `<script>` include](#for-direct-script-include-1)
- [Hiding elements in the pre-rendered HTML](#hiding-elements-in-the-pre-rendered-html)
- [Embedding additional app templates](#embedding-additional-app-templates)
- [Benefits](#benefits)
## Demo
A complete demo is available here: https://codesandbox.io/s/quench-vue-demo-foe55
## Installation
### npm
```sh
npm install quench-vue --save
```
### Direct `<script>` include
```html
<script src="https://unpkg.com/quench-vue/umd/quench-vue.min.js">
```
*Note: You will need to use [the full build of Vue.js](https://vuejs.org/v2/guide/installation.html#Explanation-of-Different-Builds), which includes the compiler.*
## Usage
1. [Defining the app `data` and `template`](#defining-the-app-data-and-template).
2. [Defining local component `template`s](#defining-local-component-templates).
## Defining the app `data` and `template`
There are 2 ways of defining and using `data` for the app:
1. With a stringified JSON object in the app container's `q-data` attribute; and/or
2. With an inline `q-binding` attribute on an element, when `q-convert-bindings` is added to the app container.
Both techniques can be used together or on their own, but the `q-data` is preferred as it's faster, simpler and more versatile.
Let's look at some examples:
### Method 1: Defining the `data` with `[q-data]`
This method allows you to easily specify the `data` for the app, including arrays and objects.
```html
…
```
#### Rendering the data with `[v-text]`
We obviously duplicate the "data" in the markup, and inform Vue which elements are bound to which `data` properties using a [`v-text`](https://vuejs.org/v2/api/#v-text) attribute whose value points to a property name, such as:
```html
Hello, World!
2018
-
js
-
library
-
Matt
-
Stow
-
JS
4
-
CSS
5
```
For iterating over lists, we also need to use another syntax, ` … `, which [we'll describe later](#hiding-elements-from-the-compiler).
*Note:*
* *You can also use [`v-html`](https://vuejs.org/v2/api/#v-html) to render HTML, but ensure that it's sanitized and trusted.*
* *You only need to output the `v-for` and the `v-text`/`q-binding` attributes on the first iteration of the loop.*
### Method 2: Defining the `data` with inline `[q-binding]` bindings
While we don't recommend the following approach for anything but the simplest of apps, when `q-convert-bindings` is set on the app's container, we can also use the `q-binding` attribute to create a `data` variable that is equal to the value of the element's `.textContent`.
*Note:*
* *Bindings specified in the global `q-data` object take precedence over inline bindings.*
* *Do not nest elements inside a `q-binding` element, or you'll have unexpected results.*
The following examples all perfectly re-create the global `q-data` object from before.
#### Simple bindings
```html
Hello, World!
2018
```
#### Array and Object bindings
Vue supports iterating over arrays and objects via [the `v-for` directive](https://vuejs.org/v2/guide/list.html) with the syntax `item in items`, where `items` is the source data list and `item` is an **alias** for the array element being iterated on.
To inline bind with Quench, we need to use another special syntax `itemsSource as item`.
##### Array
To replicate the `tags` array from above, we would:
```html
-
js
-
library
```
where `itemsSource` is the name of the array (`tags`) plus the index in the array `[0]`/`[1]` which we wish to populate, and `tag` is the `item` alias in the `v-for`.
##### Object
To replicate the `author` object from above, we would:
```html
-
Matt
-
Stow
```
where `itemsSource` is the name of the object (`author`) plus the relevant object key `.firstName`/`.lastName` which we wish to populate, and `key` is the `item` alias in the `v-for`.
##### Array of Objects
Both of the above techniques can be combined, so to replicate the `skills` array from above, we would:
```html
-
JS
4
-
CSS
5
```
where `itemsSource` is the name of the array and index (`skills[0]`) plus the relevant object key `.name`/`.level` which we wish to populate, and `skill.name`/`skill.level` is the `item` alias in the `v-for` plus the object key.
Hopefully you'll agree that using inline bindings to set the `data` is more complicated than using the `q-data` method, but it can still have its uses.
*Note: When using inline bindings, arrays and objects are limited to a depth of 1 level.*
#### Non-element bindings
Since v0.7.0, you can also create `data` from bindings using specially formatted comments, thus not requiring to have actual elements to attach to. This can be useful if you need to create extra `data` that is "invisible" to the user, or if you need to create more complex values, such as nested arrays and objects.
Using the syntax `` we can easily recreate the `data` from the previous examples:
```html
```
However, we can also create more complex `data` values. The following recreates the above arrays and objects succinctly.
```html
```
*Note: Non-element bindings must be JSON-serializable and written on one line.*
### Referencing global variables as `data` properties
You can also pass global variables (on `window`) to be used as data properties. Similarly to `q-data`, we can pass a stringified JSON object of key/value pairs to a `q-r-data` attribute, where *key* is the name of the `data`'s property and *value* the name of the global variable to be used, which can also use dot notation to access properties of an object.
```html
var ENV = 'dev';
var PORT = 3000;
var obj = {
foo: 'bar',
baz: 'qux',
}
```
which will produce the following `data`:
```js
{
env: 'dev',
port: 3000,
foo: 'bar',
baz: 'qux',
}
```
*Note: Bindings specified in the `q-r-data` object take precedence over those in `q-data`.*
### Excluding elements from the app template compiler
In the previous sections, we introduced the ` … ` syntax. These are a pair of opening and closing comments that exclude the contents within from being passed to the template compiler.
The most obvious use case (and necessary when using inline bindings) is to strip all but the first element of a `v-for` loop as demonstrated earlier.
Another use case is to replace static markup for a component, such as:
```html
```
*Note: Nesting comments is not supported.*
### Instantiating the app
Very little needs to change from the way you'd normally instantiate an app.
#### With a module bundler, such as webpack
```js
import Vue from 'vue';
import { createAppData, createAppTemplate } from 'quench-vue';
var appEl = document.getElementById('app');
var data = createAppData(appEl);
var template = createAppTemplate(appEl);
var app = new Vue({
el: appEl,
data: data,
template: template,
});
```
#### For direct `` include
```html
<script src="https://unpkg.com/vue">
```
```js
var appEl = document.getElementById('app');
var data = quenchVue.createAppData(appEl);
var template = quenchVue.createAppTemplate(appEl);
var app = new Vue({
el: appEl,
data: data,
template: template,
});
```
## Defining local component `template`s
Vue applications are often comprised of multiple components, which promotes reuse and reduces repetition. However, the more components you have, the greater your JavaScript bundle will be. While complex components, such as interactive UI widgets should probably be defined in JavaScript, simpler, more display-only components can easily be defined from existing, pre-rendered HTML with Quench Vue.
Defining local component `template`s from existing markup suits situations such as an infinite scroll of news cards, where the original "page" of cards are pre-rendered, and as a user scrolls, your Vue app needs to fetch and append more cards from a JSON API response.
*Note: You cannot use Quench Vue to specify the `template` of global components created with `Vue.component()`. We consider global components an anti-pattern anyway.*
### Specifying a component with `[q-component]`
Any element within your app's `el` can be used as the markup for a component by adding an attribute of `q-component="NAME"`, where `"NAME"` is the name of the local component defined in your Vue app.
Typically, this would be on a `
For instance:
```html
Card
```
will create a `template` of:
```html
Card
```
but:
```html
Card
```
will create a `template` of:
```html
Card
```
*Note:*
* *Only the first instance of `q-component="NAME"` will be used as the component's `template`.*
* *Components need to be wrapped in ` … ` comments to prevent them from being included in the app's template.*
* *We opted for a custom, `q-component` syntax (compared with Vue's native [`inline-template`](https://vuejs.org/v2/guide/components.html#Inline-Templates) syntax) for various reasons, but mainly because it allows for greater flexibility in the types of templates that can be defined (such as ``s with multiple children), and we can supplement with additional features as described below.*
### Specifying a component's `template`
The previous templates aren't particularly useful, but as you'd expect, any Vue directives or template syntax can be used and will be converted, similar to the app's template above (with the exception of not supporting Quench Vue's `q-binding`).
Take the following HTML:
```html
```
which will define the `card` component's `template` as:
```html
```
### Handling a `template`'s logic
While the previous template will handle content and style differences, it's not uncommon for a component's markup to also change based on certain conditions. There a 3 ways in which we can handle these logic requirements:
1. Add the logic within the markup (often using `` so they're invisible in the pre-rendered markup).
2. Add the logic within the component's JavaScript using a proprietary `partials` object and reference it with a special `` syntax; or
3. Define a completely different component.
Let's look at some examples:
#### Method 1: Add the logic within the markup
```html
```
This will most likely be the primary method used to handle template logic, however, with complex conditions, you may like to consider the following 2 approaches.
#### Method 2: Add the logic to the component's JavaScript using `partials`
When defining the component in JavaScript, add a `partials` object with a name and template string key/value pair, like so:
```js
components: {
card: {
partials: {
image: `
` // Using ES6 template literals, but any string concatenation method works
},
template: 'local'
}
}
```
and reference it in the pre-rendered component with ``:
```html
```
When the template is compiled, this `` will be converted to the value of the app's `components.partials.image` property.
This method allows you to move more complex or repetitive logic into the JavaScript to reduce the size of the pre-rendered HTML.
*Note: Having a `` element within your markup could affect your layout. There are 2 solutions to this problem:*
1. *Add `q-component-partial { display: none; }` to your CSS; or*
2. *Wrap HTML comments around the tag ``, which reduces the need for extra CSS, but may make the HTML less obvious in your editor.*
#### Define a completely different component
Instead of handling the logic in the front-end, you could define separate component variations in the pre-rendered HTML. The downside to this approach is, that if your original markup didn't contain a component variation which was later used, Vue would throw an error. A workaround to this is to output a `` as a fallback for all possible variations that weren't in the original data.
Here we define 2 components, `card--default` and `card--fallback`, and remove all the `v-if` logic from the markup.
```html
```
### Excluding elements from the component template compiler
Similarly to [excluding elements from the app template compiler](#excluding-elements-from-the-app-template-compiler), elements within a component can be excluded from its template by being wrapped in a pair of ` … ` comments as demonstrated in the earlier examples.
### Rendering future components dynamically
While components are normally rendered with their name in angled brackets (``), Vue also [supports a meta component (``)](https://vuejs.org/v2/api/#component) which allows us to programmatically render a component of our choice.
Assuming we had 4 card variations: `card--default`, `card--fallback`, `card--twitter` and `card--instagram`, we can use a unique variable (often a property on the card's `props` object such as `type`) to selectively render future components of that type using the `is` attribute.
Here we iterate over our `cards` array, dynamically render the correct card component based on `card.type` and pass the card's data to the `props` prop.
```html
```
```js
[
{
type: 'card--twitter',
title: 'Arguing on the Internet still rampant',
…
},
{
type: 'card--default',
title: 'Mario Bros And Other Nintendo Arcade Games Coming To Nintendo Switch',
…
},
{
type: 'card--instagram',
title: 'Check out this selfie of me and my avocado',
…
},
{
type: 'card--fallback',
title: 'Doom 2016 Is Coming To Nintendo Switch',
…
}
]
```
### Updating our app initialization to support pre-rendered components
Very little needs to change [from our earlier example](#instantiating-the-app).
#### With a module bundler, such as webpack
```js
import Vue from 'vue';
import { createAppData, createAppTemplate, createComponentTemplates } from 'quench-vue'; // import createComponentTemplates
var appEl = document.getElementById('app');
var data = createAppData(appEl);
var components = {
'card--default': { // Register all possible components for this app
props: ['props'], // Define props as you normally would
template: 'local', // Specify that the component's template is "local"
},
'card--fallback': {
props: ['props'],
template: 'local',
},
'card--instagram': {
props: ['props'],
template: 'local',
},
'card--twitter': {
props: ['props'],
template: 'local',
}
};
components = createComponentTemplates(appEl, components); // Convert and add templates to your components
var template = createAppTemplate(appEl); // createAppTemplate has to be called after createComponentTemplates
var app = new Vue({
el: appEl,
components: components,
data: data,
template: template,
});
```
*Note: camelCase component names are converted to kebab-case, so you can use [object shorthand notation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Object_initializer#Property_definitions) to define your components after `import`ing them*
#### For direct `` include
```html
<script src="https://unpkg.com/vue">
```
```js
var appEl = document.getElementById('app');
var data = quenchVue.createAppData(appEl);
var components = {
'card--default': { // Register all possible components for this app
props: ['props'], // Define props as you normally would
template: 'local', // Specify that the component's template is "local"
},
'card--fallback': {
props: ['props'],
template: 'local',
},
'card--instagram': {
props: ['props'],
template: 'local',
},
'card--twitter': {
props: ['props'],
template: 'local',
}
};
components = quenchVue.createComponentTemplates(appEl, components); // Convert and add templates to your components
var template = quenchVue.createAppTemplate(appEl); // createAppTemplate has to be called after createComponentTemplates
var app = new Vue({
el: appEl,
components: components,
data: data,
template: template,
});
```
## Hiding elements in the pre-rendered HTML
To prevent layout jumping and repositioning when the app's template gets compiled, it can be beneficial to visually (and accessibly) hide elements and content that is inappropriate without JavaScript, such as a ``.
By adding a class on your app container and an appropriate CSS rule, this can be achieved easily:
```html
I'm a button that only works with JS
```
```css
.pre-quench .hide-when-pre-quench {
visibility: hidden;
}
```
When Quench compiles our template for Vue, it removes any `pre-quench` classes and adds a `quenched` class, thus providing the ability to style elements based on the pre and post-quenched state.
## Embedding additional app templates
You may also like to embed an additional JavaScript string template within the compiled, pre-rendered template. This can easily be achieved by passing the template as the second parameter to `createAppTemplate()`, and describing where it will appear with a `` tag.
A possible use case for this technique is when you need to create multiple apps of simple components (such as a video player), but you don't want to have to continually repeat the `` component definition.
```html
```
```js
var baseTemplate = '';
var template = createAppTemplate(appEl, baseTemplate);
```
*Note: You can also wrap HTML comments around the tag ``, to hide the placeholder from the browser's parser.*
## Benefits
Hopefully you've recognized that you're now able to render fast, SEO-friendly static markup (either from a CMS, static-site generator or component library such as [Fractal](http://fractal.build/)) and have it quickly and easily converted into a fully dynamic, client-side Vue.js application, without having to set up more complicated server-side rendering processes.
---
Copyright (c) 2018 [Matt Stow](http://mattstow.com)
Licensed under the MIT license *(see [LICENSE](https://github.com/stowball/quench-vue/blob/master/LICENSE) for details)*