Skip to content

jfbrennan/single-file-web-component

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

44 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Single File Web Component

Searching for ways to create vanilla single-file Web Components...

The original SFWC article: https://jordanbrennan.hashnode.dev/single-file-web-componentsmaybe

File structure

SFWC files are named as <tag-name>.html and the basic structure is:

<sfwc>
  <template>
    <style></style>
  </template>
  <script></script>
</sfwc>

Importing a SFWC (or a bundle of them) is done with the object element:

<object data="filename.html" type="text/html"></object>

Note that object elements must be styled with width: 0; height: 0;. They cannot be hidden.

Utils

bindTemplateEvents(element) Replaces descendents' onevent attributes with an event listener of the same type.

getTemplateRefs(element) A Proxy object that finds all descendents with an id and caches them on the returned object.

Examples

The counter component demonstrates the basic SFWC concept.

The country search component demonstrates fetching data and rendering it in a searchable and sortable table.

Other topics

Custom HTML elements and the TAC CSS methodology

Some components do not need JavaScript, so what should you do? The status quo is to turn them into React (or whatever framework you're using) components anyway. The other common approach is to define them as CSS classes. Neither is good. One is over-engineered and tightly coupled to a framework despite having no need for one, and the other introduces a completely different paradigm that lacks the ability to define a sensible API and can't scale beyond CSS. For these reasons the TAC methodology was created.

Frameworks that work with Web Components

At this point virtually all JavaScript frameworks except React are compatible with Web Components. React 19 is supposed to fix this (six years late). As of June 2023 there is no release date for React 19.

HTML Modules thread

HTML imports were abandoned. HTML modules are the potential solution, but the thread is 6 years old and there doesn't seem to be a spec advancing.

About

Example of a Single File Web Component

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published