Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow for custom templates, closes #1 #2

Merged
merged 4 commits into from
Apr 22, 2024
Merged

Allow for custom templates, closes #1 #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f55f1d5
Allow for custom templates, closes #1
daviddarnes Apr 12, 2024
772a1df
Update readme and example
daviddarnes Apr 22, 2024
b127d5a
Add custom template example to docs
daviddarnes Apr 22, 2024
e8e2833
Bump to version 1.1.0
daviddarnes Apr 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 27 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ General usage example:

<template id="link-peek-template">
<figure>
<figcaption>
<a data-key="data.title, link"></a>
<p data-key="data.description"></p>
<img data-key="data.logo.url" />
<small data-key="data.publisher"></small>
</figcaption>
<img data-key="data.image.url" />
</figure>
<figcaption>
<a data-key="data.title, link"></a>
<p data-key="data.description"></p>
<img data-key="data.logo.url" />
<small data-key="data.publisher"></small>
</figcaption>
<img data-key="data.image.url" />
</figure>
</template>

<link-peek api="https://api.microlink.io/?url=${link}">
Expand All @@ -37,7 +37,8 @@ _Note that there are no defaults set for the API or template being used. `link-p
This Web Component allows you to:

- Use public APIs to return and present metadata on a linked web page
- Create custom templates for your 'unfurled' link previews for greater design control
- Create custom templates for your 'unfurled' link previews using a `<template>` element and `data-key="name"` data attributes
- Use a custom template for specific instances using the `template` attribute
- Use any public API to populate your 'unfurled' previews

## Installation
Expand Down Expand Up @@ -66,6 +67,21 @@ Here's that same example in context:
</link-peek>
```

You can also use different templates on the same page by using the template attribute to target `<template>` elements with a specific `id`:

```html
<template id="custom-template">
<a data-key="data.description, data.url"></a>
</template>

<link-peek
api="https://api.microlink.io/?url=${link}"
template="custom-template"
>
<a href="https://darn.es">David Darnes</a>
</link-peek>
```

_Note that for <a> and <img> elements the value won't be applied to it's content if the string being returned starts with http and instead will be applied to the href and src attributes respectively._

### Usage
Expand All @@ -81,15 +97,15 @@ Make sure you include the `<script>` in your project (choose one of these):
<!-- 3rd party CDN, not recommended for production use -->
<script
type="module"
src="https://www.unpkg.com/@daviddarnes/link-peek@1.0.0/link-peek.js"
src="https://www.unpkg.com/@daviddarnes/link-peek@1.1.0/link-peek.js"
></script>
```

```html
<!-- 3rd party CDN, not recommended for production use -->
<script
type="module"
src="https://esm.sh/@daviddarnes/link-peek@1.0.0"
src="https://esm.sh/@daviddarnes/link-peek@1.1.0"
></script>
```

Expand Down
21 changes: 20 additions & 1 deletion demo-simple-example.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,34 @@
<title>link-peek Web Component Demo</title>

<script type="module" src="link-peek.js"></script>

<style>
link-peek[template="custom-template"]:defined a:not([data-key]) {
display: none;
}
</style>
</head>
<body>
<h2>Simple example</h2>
<h2>Simple template example</h2>
<template id="link-peek-template">
<p data-key="data.description"></p>
</template>

<link-peek api="https://api.microlink.io/?url=${link}">
<a href="https://darn.es">David Darnes</a>
</link-peek>

<h2>Custom template example using <code>template</code> attribute</h2>

<template id="custom-template">
<a data-key="data.description, data.url"></a>
</template>

<link-peek
api="https://api.microlink.io/?url=${link}"
template="custom-template"
>
<a href="https://darn.es">David Darnes</a>
</link-peek>
</body>
</html>
4 changes: 3 additions & 1 deletion link-peek.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,9 @@ class LinkPeek extends HTMLElement {

get template() {
return document
.getElementById(`${this.localName}-template`)
.getElementById(
this.getAttribute("template") || `${this.localName}-template`
)
.content.cloneNode(true);
}

Expand Down