mirrors/svelte
mirrors/svelte
0
0
Fork 0
mirror of https://github.com/sveltejs/svelte.git synced 2024-12-01 17:30:59 +01:00
Code Issues Releases Wiki Activity

fix options table formatting

Browse Source
This commit is contained in:
Conduitry 2017-03-09 08:15:52 -05:00
parent a412ebd451
commit e0a1483bd6
1 changed files with 13 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

88
README.md
View File

@ -70,81 +70,19 @@ The Svelte compiler exposes the following API:
The Svelte compiler optionally takes a second argument, an object of configuration options:
<table>
<tr>
<td>
<td>**Values**
<td>**Description**
<td>**Default**
<tr>
<td>`format`
<td>`'es'`, `'amd'`, `'cjs'`, `'umd'`, `'iife'`, `'eval'`
<td>The format to output in the compiled component.<br>`'es'` - ES6/ES2015 module, suitable for consumption by a bundler<br>`'amd'` - AMD module<br>`'cjs'` - CommonJS module<br>`'iife'` - IIFE-wrapped function defining a global variable, suitable for use directly in browser<br>`'eval'` - standalone function, suitable for passing to `eval()`
<td>`'es'`
<tr>
<td>`generate`
<td>`'dom'`, `'ssr'`
<td>Whether to generate JavaScript code intended for use on the client (`'dom'`), or for use in server-side rendering (`'ssr'`).
<td>`'dom'`
<tr>
<td>`name`
<td>`string`
<td>The name of the constructor in the compiled component.
<td>`'SvelteComponent'`
<tr>
<td>`filename`
<td>`string`
<td>The filename to use in sourcemaps and compiler error and warning messages.
<td>`'SvelteComponent.html'`
<tr>
<td>`amd`.`id`
<td>`string`
<td>The AMD module ID to use for the `'amd'` and `'umd'` output formats.
<td>`undefined`
<tr>
<td>`shared`
<td>`true`, `false`, `string`
<td>Whether to import various helpers from a shared external library. When you have a project with multiple components, this reduces the overall size of your JavaScript bundle, at the expense of having immediately-usable component. You can pass a string of the module path to use, or `true` will import from `'svelte/shared.js'`.
<td>`false`
<tr>
<td>`dev`
<td>`true`, `false`
<td>Whether to enable run-time checks in the compiled component. These are helpful during development, but slow your component down.
<td>`false`
<tr>
<td>`css`
<td>`true`, `false`
<td>Whether to include code to inject your component's styles into the DOM.
<td>`true`
<tr>
<td>`globals`
<td>`object`, `function`
<td>When outputting to the `'umd'`, `'iife'` or `'eval'` formats, an object or function mapping the names of imported dependencies to the names of global variables.
<td>`{}`
<tr>
<td>`onerror`
<td>`function`
<td>Specify a callback for when Svelte encounters an error while compiling the component.
<td>(exception is thrown)
<tr>
<td>`onwarn`
<td>`function`
<td>Specify a callback for when Svelte encounters a non-fatal warning while compiling the component.
<td>(warning is logged to console)
</table>
| | **Values** | **Description** | **Defaults** |
|---|---|---|---|
| `format` | `'es'`, `'amd'`, `'cjs'`, `'umd'`, `'iife'`, `'eval'` | The format to output in the compiled component.<br>`'es'` - ES6/ES2015 module, suitable for consumption by a bundler<br>`'amd'` - AMD module<br>`'cjs'` - CommonJS module<br>`'iife'` - IIFE-wrapped function defining a global variable, suitable for use directly in browser<br>`'eval'` - standalone function, suitable for passing to `eval()` | `'es'` |
| `generate` | `'dom'`, `'ssr'` | Whether to generate JavaScript code intended for use on the client (`'dom'`), or for use in server-side rendering (`'ssr'`). | `'dom'` |
| `name` | `string` | The name of the constructor in the compiled component. | `'SvelteComponent'` |
| `filename` | `string` | The filename to use in sourcemaps and compiler error and warning messages. | `'SvelteComponent.html'` |
| `amd`.`id` | `string` | The AMD module ID to use for the `'amd'` and `'umd'` output formats. | `undefined` |
| `shared` | `true`, `false`, `string` | Whether to import various helpers from a shared external library. When you have a project with multiple components, this reduces the overall size of your JavaScript bundle, at the expense of having immediately-usable component. You can pass a string of the module path to use, or `true` will import from `'svelte/shared.js'`. | `false` |
| `dev` | `true`, `false` | Whether to enable run-time checks in the compiled component. These are helpful during development, but slow your component down. | `false` |
| `css` | `true`, `false` | Whether to include code to inject your component's styles into the DOM. | `true` |
| `globals` | `object`, `function` | When outputting to the `'umd'`, `'iife'` or `'eval'` formats, an object or function mapping the names of imported dependencies to the names of global variables. | `{}` |
| `onerror` | `function` | Specify a callback for when Svelte encounters an error while compiling the component. | (exception is thrown) |
| `onwarn` | `function` | Specify a callback for when Svelte encounters a non-fatal warning while compiling the component. | (warning is logged to console) |
## Example/starter repos