Skip to content

Commit 06bc163

Browse files
author
Chris Nelson
committed
initial commit, tests pass
0 parents  commit 06bc163

12 files changed

+4663
-0
lines changed

‎.editorconfig

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# EditorConfig helps developers define and maintain consistent
2+
# coding styles between different editors and IDEs
3+
# editorconfig.org
4+
5+
root = true
6+
7+
8+
[*]
9+
10+
# Change these settings to your own preference
11+
indent_style = space
12+
indent_size = 2
13+
14+
# We recommend you to keep these unchanged
15+
end_of_line = lf
16+
charset = utf-8
17+
trim_trailing_whitespace = true
18+
insert_final_newline = true
19+
20+
[*.md]
21+
trim_trailing_whitespace = false
22+
23+
[*.json]
24+
indent_size = 2
25+
26+
[*.{html,js,md}]
27+
block_comment_start = /**
28+
block_comment = *
29+
block_comment_end = */

‎.gitignore

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## editors
2+
/.idea
3+
/.vscode
4+
5+
## system files
6+
.DS_Store
7+
8+
## npm
9+
/node_modules/
10+
/npm-debug.log
11+
12+
## testing
13+
/coverage/
14+
15+
## temp folders
16+
/.tmp/
17+
18+
# build
19+
/_site/
20+
/dist/
21+
/out-tsc/
22+
23+
storybook-static
24+
custom-elements.json

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 live-template
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# \<live-template>
2+
3+
This webcomponent follows the [open-wc](https://github.com/open-wc/open-wc) recommendation.
4+
5+
## Installation
6+
7+
```bash
8+
npm i live-template
9+
```
10+
11+
## Usage
12+
13+
```html
14+
<script type="module">
15+
import 'live-template/live-template.js';
16+
</script>
17+
18+
<live-template></live-template>
19+
```
20+
21+
## Testing with Web Test Runner
22+
23+
To execute a single test run:
24+
25+
```bash
26+
npm run test
27+
```
28+
29+
To run the tests in interactive watch mode run:
30+
31+
```bash
32+
npm run test:watch
33+
```
34+
35+
36+
## Tooling configs
37+
38+
For most of the tools, the configuration is in the `package.json` to minimize the amount of files in your project.
39+
40+
If you customize the configuration a lot, you can consider moving them to individual files.
41+
42+
## Local Demo with `web-dev-server`
43+
44+
```bash
45+
npm start
46+
```
47+
48+
To run a local development server that serves the basic demo located in `demo/index.html`

‎demo/index.html

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<!doctype html>
2+
<html lang="en-GB">
3+
<head>
4+
<meta charset="utf-8">
5+
<style>
6+
body {
7+
background: #fafafa;
8+
}
9+
</style>
10+
</head>
11+
<body>
12+
<div id="demo"></div>
13+
14+
<script type="module">
15+
import { html, render } from 'lit';
16+
import '../live-template.js';
17+
18+
const header = 'Hello owc World!';
19+
render(
20+
html`
21+
<live-template .header=${header}>
22+
some light-dom
23+
</live-template>
24+
`,
25+
document.querySelector('#demo')
26+
);
27+
</script>
28+
</body>
29+
</html>

‎index.js

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export { LiveTemplateElement } from './src/live-template.js';

0 commit comments

Comments
 (0)