django-yabl

Yet another bookmarking library (yabl) for Django. Bookmark and tag arbitrary models.

AbstractBookmarkable contains bookmarks field. This enables arbitrary child models, e.g. Movies, Books, Laws, Clothes, etc., to inherit uniform properties for bookmarking and tagging.

The bookmarks field is mapped to a generic Bookmark model containing:

1. the authenticated user adding the bookmark, i.e. the bookmarker;
2. the concrete model instance referenced, i.e. the bookmarked;¹ and
3. a ManyToMany tags field which maps to a TagItem model.

AbstractBookmarkable

The abstraction makes each inheriting instance bookmarkable and taggable by authenticated users.

Modal-based UX

What is the concept?

The modal is where the user interacts – i.e. toggle bookmark status, add tags, remove tag (see table above) – with the data.

How is the modal styled?

See the htmx/hyperscript example modal.css.

How is the modal constructed during run-time?

See app-level modal.html which shows a modal via htmx click on the @launch_modal_url property.

What are the pre-made contents of the modal?

The app-level panel.html, contained within the modal, shows an actionable form for saving the bookmarable object and associating said object with tags:

1. The submission of tags is POST'ed through the add_tags_url.
2. The deletion of tags is DELETE'ed through the del_tag_url.
3. The bookmark toggle is PUT'ed through the toggle_status_url.

Setup

1. Download and install.
2. See configuration of models to be bookmarked and tagged.
3. Examine frontend setup using htmx/hyperscript.