npm.io
3.1.16 • Published 1 month ago

@enso-ui/bookmarks

Licence
MIT
Version
3.1.16
Deps
4
Size
26 kB
Vulns
0
Weekly
0

Bookmarks

License Stable Downloads Vue JavaScript SCSS npm Issues Merge Requests

Description

Bookmark toolbar and bookmark-state widgets for Enso UI.

Installation

Install the package:

yarn add @enso-ui/bookmarks

This package is also available through the full enso-ui workspace bundle.

Features

  • exports the Bulma bookmark tag bar used in Enso navigation layouts
  • renders reorderable bookmark tags through vuedraggable
  • surfaces sticky, remove, clear, and active-route affordances on top of the core bookmark state machine
  • keeps the rendered contract aligned with the @enso-ui/ui route metadata model
  • keeps bookmark route queries synchronized for existing bookmarks on the same route and params

Usage

<script setup>
import Bookmarks from '@enso-ui/bookmarks';
</script>

<Bookmarks />

API

Bookmarks

Default export that renders the Bulma bookmark toolbar.

Import: @enso-ui/bookmarks

Props:

  • No public props. Bookmark data comes from the internal core bookmark state layer.

Events:

  • No public emits.

Slots:

  • No public slots.

Route query sync:

  • an existing bookmark is matched by route name and params
  • when the current route query changes, the bookmark query is updated instead of creating a duplicate
  • sticky and saved state metadata are preserved during query sync
  • tabbed EnsoForm bookmarks reopen with the saved tab query value

Depends On

Contributions

are welcome. Pull requests are great, but issues are good too.

Thank you to all the people who already contributed to Enso!

License

MIT