bookmark.BookmarkState

bookmark.BookmarkState(input, exclude, on_save)

The state being written while a bookmark is saved.

Shiny creates a BookmarkState instance each time a bookmark is taken and passes the instance to every session.bookmark.on_bookmark() callback. The registered callbacks may add entries to the state's values or write files into dir (if available) before the state is persisted.

App authors do not construct this class directly.

Attributes

Name Description
dir Directory to write bookmark files into, or None.
exclude Scoped input names to leave out of the bookmark.
input The session’s inputs. Every value except those named in exclude is saved.
values Arbitrary extra values to save alongside the inputs.