R/cicerone_guide.R

In designer: 'Shiny' UI Prototype Builder

#' Application Guide
#' @noRd
guide <- cicerone::Cicerone$new(
)$step(
  el = "settings-page_type_button",
  title = "Page Type",
  description = paste(
    "First thing to do is select the type of page:<ul>",
    "<li>Fluid Page is the most commonly used page for shiny applications</li>",
    "<li>Navigation Bar Page enables multiple tabs to be included in the application</li>",
    "<li>Fill Page will set the height and width to the whole browser window</li>",
    "<li>Basic Page and Bootstrap Page are for those who will use more HTML/CSS after the application is designed</li>",
    "</ul>"
  )
)$step(
  el = "sidebar-accordion",
  title = "Components",
  description = paste(
    "Components are the bread and butter of building a UI.",
    "The selection of components include rows and columns for designing the layout,",
    "and the all important inputs and outputs."
  )
)$step(
  el = "sidebar-header-body",
  title = "Component Settings",
  description = paste(
    "After a component is selected, some customisation is available ",
    "such as the text in the component and how wide it should be."
  )
)$step(
  el = "component_delete",
  title = "Delete Component",
  description = paste(
    "If you do include something in the UI that you no longer need, drag it here for it to be removed.",
    "Alternatively, right-click on an element and delete from the menu instead."
  )
)$step(
  el = "settings-code_button",
  title = "R Code",
  description = paste(
    "Once you are happy with the layout, you can copy or download the R code required to replicate the UI below."
  )
)$step(
  el = "settings-template_button",
  title = "R Code",
  description = paste(
    "Alternatively if you want to load a previously saved template, select one of the templates here."
  )
)$step(
  el = "settings-options_button",
  title = "Additional Options",
  description = paste(
    "Here you can toggle development tools, such as labels and the dotted borders,",
    "as well as changing the title and a full page preview of the application."
  )
)