Skip to content

A web component for dynamically loading hypermedia content into an element.

Notifications You must be signed in to change notification settings

sbracegirdle/data-frame

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Dynamic Frame Web Component

A web component for dynamically loading hypermedia content into an element.

Inspired by htmx and Hypermedia Systems, this takes a slightly different approach by introducing a web-component instead of adding attributes to standard elements.

Not disimilar to the concept of iframes, but with a radically different implementation, the data frame components allow you to load content dynamically with fetch and without creating separate browsing contexts.

Data frames work with forms, and anchors, enabling automatic updates as needed. The project also supports browser history, optional initial content retention, and targeted frame updates from anywhere on the page.

Usage

Include the data-frame.js script on your page.

Add a data-frame component:

* <data-frame>
 *   Hello <a href="/world">world</a>
 * </data-frame>

When the user clicks the link, the response will load in the data frame.

Supported attributes:

  • src — Load content initially from a URL.
  • push — Navigation will push to browser history and URL.
  • default — If true, all supported elements will target this frame.

Development setup

  1. Clone the repository
  2. Install the required Python dependencies from the provided requirements.txt file.
  3. Run the sample flask app python app.py for testing.

About

A web component for dynamically loading hypermedia content into an element.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published