useHypothesis {hypothesis}

Use hypothesis annotations

Description

Function used to initialize hypothesis annotations in Shiny app or R Markdown document.

Usage

useHypothesis(
  openSidebar = TRUE,
  showHighlights = c("whenSidebarOpen", "always", "never"),
  theme = c("classic", "clean"),
  branding = hypothesisBranding(),
  sidebarAppUrl = NULL,
  onLayoutChange = as_json("tryHideHypothesis"),
  services = hypothesisServices(),
  enableExperimentalNewNoteButton = NULL,
  usernameUrl = NULL,
  externalContainerSelector = NULL,
  focus = NULL,
  requestConfigFromFrame = NULL,
  assetRoot = NULL,
  notebookAppUrl = NULL,
  enableShareLinks = FALSE,
  ...
)

Arguments

openSidebar

Set to TRUE if annotations sidebar should be opened in initial state.

showHighlights

Configure when annotated text should be highlighted. "whenSidebarOpen" highlights content only when annotations sidebar is open (default). The remaining options are "always" and "never".

theme

Annotations sidebar theme. Available options "classic" (default) and "clean".

branding

Configure annotations tool branding (e.g. sidebar background). See hypothesisBranding for possible options.

sidebarAppUrl, onLayoutChange, services, enableExperimentalNewNoteButton, usernameUrl, externalContainerSelector, focus, requestConfigFromFrame, assetRoot, notebookAppUrl, enableShareLinks

Extra arguments used for external services configuration and assets configuration. Visit config for more details.

...

Extra arguments passed to client configuration.

Value

A list of class 'shiny.tag.list' storing the package JS/CSS dependencies.