Skip to content

Commit 38c0223

Browse files
committed
Spruce up readme
1 parent fe035e1 commit 38c0223

File tree

1 file changed

+10
-2
lines changed
  • packages/babel-plugin-transform-jsx-to-tagged-templates

1 file changed

+10
-2
lines changed

packages/babel-plugin-transform-jsx-to-tagged-templates/README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,20 @@ npm i -D babel-plugin-transform-jsx-to-tagged-templates
2828

2929
## Options
3030

31-
There's only one option: `tag`. It lets you specify the function to use for prefixing templates. The default is "html":
31+
The following options are available:
32+
33+
| Option | Type | Default | Description
34+
|--------|---------|----------|------------
35+
| `tag` | String | `"html"` | The "tag" function to prefix [Tagged Templates] with.<br> _Useful when [Auto-importing a tag function](#auto-importing-the-tag)._
36+
| `html` | Boolean | `false` | `true` outputs HTML-like templates for use with [lit-html].<br> _The is default XML-like, with self-closing tags._
37+
38+
Options are passed to a Babel plugin using a nested Array:
3239

3340
```js
3441
"plugins": [
3542
["babel-plugin-transform-jsx-to-tagged-templates", {
36-
"tag": "custom.html"
43+
"tag": "$$html",
44+
"html": true
3745
}]
3846
]
3947
```

0 commit comments

Comments
 (0)