Skip to contents

Create a catalogue of room comments or testimonials

Source: R/comments.R
indoorCommentCatalog.Rd

Each row associates a plain-text comment with a feature identifier supplied to addIndoor(). Repeating an identifier displays several comments in row order. Comments open from a separate map icon, leaving room popups and photo carousels available through the room itself.

Usage

indoorCommentCatalog(
  layerId,
  text,
  author = "",
  date = "",
  source = "",
  title = ""
)

Arguments

layerId

Feature identifiers matching layerId in addIndoor().

text

Non-empty plain-text comments.

author, date

Optional plain-text attribution and date labels. An empty string omits the field. Dates are displayed as supplied.

source

Optional absolute HTTP(S) source URLs, or empty strings.

title

Optional plain-text headings, for example to distinguish a published excerpt from a summary.

Value

A data frame of class leaflet_indoor_comments.

Details

Fields of length one are recycled to the number of comments. Content is rendered as text, including strings wrapped in HTML(). Authors are responsible for permission and accurate attribution when displaying third-party material.

Examples

comments <- indoorCommentCatalog(
  layerId = c("room-01", "room-01"),
  text = c("A quiet place to read.", "The entrance is easy to find."),
  author = c("Example visitor A", "Example visitor B")
)
comments
#>   layerId                          text            author date source title
#> 1 room-01        A quiet place to read. Example visitor A                  
#> 2 room-01 The entrance is easy to find. Example visitor B