162 lines
6.4 KiB
Markdown
162 lines
6.4 KiB
Markdown
# vue-template-compiler
|
|
|
|
> This package is auto-generated. For pull requests please see [src/platforms/web/entry-compiler.js](https://github.com/vuejs/vue/tree/dev/src/platforms/web/entry-compiler.js).
|
|
|
|
This package can be used to pre-compile Vue 2.0 templates into render functions to avoid runtime-compilation overhead and CSP restrictions. In most cases you should be using it with [`vue-loader`](https://github.com/vuejs/vue-loader), you will only need it separately if you are writing build tools with very specific needs.
|
|
|
|
## Installation
|
|
|
|
``` bash
|
|
npm install vue-template-compiler
|
|
```
|
|
|
|
``` js
|
|
const compiler = require('vue-template-compiler')
|
|
```
|
|
|
|
## API
|
|
|
|
### compiler.compile(template, [options])
|
|
|
|
Compiles a template string and returns compiled JavaScript code. The returned result is an object of the following format:
|
|
|
|
``` js
|
|
{
|
|
ast: ?ASTElement, // parsed template elements to AST
|
|
render: string, // main render function code
|
|
staticRenderFns: Array<string>, // render code for static sub trees, if any
|
|
errors: Array<string> // template syntax errors, if any
|
|
}
|
|
```
|
|
|
|
Note the returned function code uses `with` and thus cannot be used in strict mode code.
|
|
|
|
#### Options
|
|
|
|
- `outputSourceRange` *new in 2.6*
|
|
- Type: `boolean`
|
|
- Default: `false`
|
|
|
|
Set this to true will cause the `errors` returned in the compiled result become objects in the form of `{ msg, start, end }`. The `start` and `end` properties are numbers that mark the code range of the error source in the template. This can be passed on to the `compiler.generateCodeFrame` API to generate a code frame for the error.
|
|
|
|
- `whitespace`
|
|
- Type: `string`
|
|
- Valid values: `'preserve' | 'condense'`
|
|
- Default: `'preserve'`
|
|
|
|
The default value `'preserve'` handles whitespaces as follows:
|
|
|
|
- A whitespace-only text node between element tags is condensed into a single space.
|
|
- All other whitespaces are preserved as-is.
|
|
|
|
If set to `'condense'`:
|
|
|
|
- A whitespace-only text node between element tags is removed if it contains new lines. Otherwise, it is condensed into a single space.
|
|
- Consecutive whitespaces inside a non-whitespace-only text node are condensed into a single space.
|
|
|
|
Using condense mode will result in smaller compiled code size and slightly improved performance. However, it will produce minor visual layout differences compared to plain HTML in certain cases.
|
|
|
|
**This option does not affect the `<pre>` tag.**
|
|
|
|
Example:
|
|
|
|
``` html
|
|
<!-- source -->
|
|
<div>
|
|
<span>
|
|
foo
|
|
</span> <span>bar</span>
|
|
</div>
|
|
|
|
<!-- whitespace: 'preserve' -->
|
|
<div> <span>
|
|
foo
|
|
</span> <span>bar</span> </div>
|
|
|
|
<!-- whitespace: 'condense' -->
|
|
<div><span> foo </span> <span>bar</span></div>
|
|
```
|
|
|
|
- `modules`
|
|
|
|
It's possible to hook into the compilation process to support custom template features. **However, beware that by injecting custom compile-time modules, your templates will not work with other build tools built on standard built-in modules, e.g `vue-loader` and `vueify`.**
|
|
|
|
An array of compiler modules. For details on compiler modules, refer to the `ModuleOptions` type in [flow declarations](https://github.com/vuejs/vue/blob/dev/flow/compiler.js#L38-L45) and the [built-in modules](https://github.com/vuejs/vue/tree/dev/src/platforms/web/compiler/modules).
|
|
|
|
- `directives`
|
|
|
|
An object where the key is the directive name and the value is a function that transforms an template AST node. For example:
|
|
|
|
``` js
|
|
compiler.compile('<div v-test></div>', {
|
|
directives: {
|
|
test (node, directiveMeta) {
|
|
// transform node based on directiveMeta
|
|
}
|
|
}
|
|
})
|
|
```
|
|
|
|
By default, a compile-time directive will extract the directive and the directive will not be present at runtime. If you want the directive to also be handled by a runtime definition, return `true` in the transform function.
|
|
|
|
Refer to the implementation of some [built-in compile-time directives](https://github.com/vuejs/vue/tree/dev/src/platforms/web/compiler/directives).
|
|
|
|
- `preserveWhitespace` **Deprecated since 2.6**
|
|
- Type: `boolean`
|
|
- Default: `true`
|
|
|
|
By default, the compiled render function preserves all whitespace characters between HTML tags. If set to `false`, whitespace between tags will be ignored. This can result in slightly better performance but may affect layout for inline elements.
|
|
|
|
---
|
|
|
|
### compiler.compileToFunctions(template)
|
|
|
|
Similar to `compiler.compile`, but directly returns instantiated functions:
|
|
|
|
``` js
|
|
{
|
|
render: Function,
|
|
staticRenderFns: Array<Function>
|
|
}
|
|
```
|
|
|
|
This is only useful at runtime with pre-configured builds, so it doesn't accept any compile-time options. In addition, this method uses `new Function()` so it is not CSP-compliant.
|
|
|
|
---
|
|
|
|
### compiler.ssrCompile(template, [options])
|
|
|
|
> 2.4.0+
|
|
|
|
Same as `compiler.compile` but generates SSR-specific render function code by optimizing parts of the template into string concatenation in order to improve SSR performance.
|
|
|
|
This is used by default in `vue-loader@>=12` and can be disabled using the [`optimizeSSR`](https://vue-loader.vuejs.org/en/options.html#optimizessr) option.
|
|
|
|
---
|
|
|
|
### compiler.ssrCompileToFunctions(template)
|
|
|
|
> 2.4.0+
|
|
|
|
Same as `compiler.compileToFunction` but generates SSR-specific render function code by optimizing parts of the template into string concatenation in order to improve SSR performance.
|
|
|
|
---
|
|
|
|
### compiler.parseComponent(file, [options])
|
|
|
|
Parse a SFC (single-file component, or `*.vue` file) into a descriptor (refer to the `SFCDescriptor` type in [flow declarations](https://github.com/vuejs/vue/blob/dev/flow/compiler.js)). This is used in SFC build tools like `vue-loader` and `vueify`.
|
|
|
|
---
|
|
|
|
### compiler.generateCodeFrame(template, start, end)
|
|
|
|
Generate a code frame that highlights the part in `template` defined by `start` and `end`. Useful for error reporting in higher-level tooling.
|
|
|
|
#### Options
|
|
|
|
#### `pad`
|
|
|
|
`pad` is useful when you are piping the extracted content into other pre-processors, as you will get correct line numbers or character indices if there are any syntax errors.
|
|
|
|
- with `{ pad: "line" }`, the extracted content for each block will be prefixed with one newline for each line in the leading content from the original file to ensure that the line numbers align with the original file.
|
|
- with `{ pad: "space" }`, the extracted content for each block will be prefixed with one space for each character in the leading content from the original file to ensure that the character count remains the same as the original file.
|