File: scaffoldWidget.Rd

package info (click to toggle)
r-cran-htmlwidgets 1.5.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 492 kB
  • sloc: javascript: 599; makefile: 2
file content (26 lines) | stat: -rw-r--r-- 876 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/scaffold.R
\name{scaffoldWidget}
\alias{scaffoldWidget}
\title{Create implementation scaffolding for an HTML widget}
\usage{
scaffoldWidget(name, bowerPkg = NULL, edit = interactive())
}
\arguments{
\item{name}{Name of widget}

\item{bowerPkg}{Optional name of \href{https://bower.io/}{Bower} package upon
which this widget is based. If you specify this parameter then bower will
be used to automatically download the widget's source code and dependencies
and add them to the widget's YAML.}

\item{edit}{Automatically open the widget's JavaScript source file after
creating the scaffolding.}
}
\description{
Add the minimal code required to implement an HTML widget to an R package.
}
\note{
This function must be executed from the root directory of the package
  you wish to add the widget to.
}