SakuraCSS: Sakura.CSS

In ashbaldry/classless: Include Classless CSS Frameworks in 'Shiny' Applications

Sakura.CSS

Description

A ...

Super class

classless::Classless -> SakuraCSS

Methods

Public methods

• SakuraCSS$new()

• SakuraCSS$createPage()

• SakuraCSS$textInput()

• SakuraCSS$passwordInput()

• SakuraCSS$textAreaInput()

• SakuraCSS$numericInput()

• SakuraCSS$dateInput()

• SakuraCSS$checkboxInput()

• SakuraCSS$selectInput()

• SakuraCSS$sakuraInput()

• SakuraCSS$clone()

Inherited methods

• classless::Classless$actionButton()

• classless::Classless$addServer()

• classless::Classless$addUI()

• classless::Classless$getFramework()

• classless::Classless$getServer()

• classless::Classless$getUI()

• classless::Classless$runApp()

• classless::Classless$runExample()

---

Method new()

Create a new sakura.css object

Usage

SakuraCSS$new()

Returns

A new SakuraCSS object

---

Method createPage()

Create a page with sakura.css

Usage

SakuraCSS$createPage(..., title = NULL, theme = NULL, lang = NULL)

Arguments

...

The contents of the document body

title

The browser window title (defaults to the host URL of the page)

theme

Theme to give to the UI

lang

ISO 639-1 language code for the HTML page

---

Method textInput()

Create an input control for entry of unstructured text values

Usage

SakuraCSS$textInput(input_id, label, value = "", placeholder = "")

Arguments

input_id

The input slot that will be used to access the value.

label

Display label for the control

value

Initial value

placeholder

A character string giving the user a hint as to what can be entered into the control

Returns

A text input control that can be added to a UI definition

---

Method passwordInput()

Create an password control for entry of passwords

Usage

SakuraCSS$passwordInput(input_id, label, value = "", placeholder = "")

Arguments

input_id

The input slot that will be used to access the value.

label

Display label for the control

value

Initial value

placeholder

A character string giving the user a hint as to what can be entered into the control

Returns

A password input control that can be added to a UI definition

---

Method textAreaInput()

Create a textarea input control for entry of unstructured text values

Usage

SakuraCSS$textAreaInput(input_id, label, value = "", placeholder = "")

Arguments

input_id

The input slot that will be used to access the value.

label

Display label for the control

value

Initial value

placeholder

A character string giving the user a hint as to what can be entered into the control

Returns

A textarea input control that can be added to a UI definition

---

Method numericInput()

Create a numeric input control for entry of unstructured text values

Usage

SakuraCSS$numericInput(
  input_id,
  label,
  value = "",
  min = NULL,
  max = NULL,
  placeholder = ""
)

Arguments

input_id

The input slot that will be used to access the value.

label

Display label for the control

value

Initial value

min

Minimum valid value

max

Maximum valid value

placeholder

A character string giving the user a hint as to what can be entered into the control

Returns

A numeric input control that can be added to a UI definition

---

Method dateInput()

Create a date input control for entry of unstructured text values

Usage

SakuraCSS$dateInput(
  input_id,
  label,
  value = "",
  min = NULL,
  max = NULL,
  placeholder = ""
)

Arguments

input_id

The input slot that will be used to access the value.

label

Display label for the control

value

Initial value

min

Minimum valid value

max

Maximum valid value

placeholder

A character string giving the user a hint as to what can be entered into the control

Returns

A date input control that can be added to a UI definition

---

Method checkboxInput()

Create a checkbox that can be used to specify logical values

Usage

SakuraCSS$checkboxInput(input_id, label, value = FALSE)

Arguments

input_id

The input slot that will be used to access the value.

label

Display label for the control

value

Initial value

Returns

A checkbox control that can be added to a UI definition

---

Method selectInput()

Create a select list that can be used to choose a single or multiple items from a list of values

Usage

SakuraCSS$selectInput(
  input_id,
  label,
  choices,
  selected = NULL,
  multiple = FALSE
)

Arguments

input_id

The input slot that will be used to access the value.

label

Display label for the control

choices

List of values to select from

selected

The initially selected value (or multiple values if multiple = TRUE).

multiple

Is selection of multiple items allowed?

Returns

A select list control that can be added to a UI definition

---

Method sakuraInput()

sakura.css wraps a <p> tag around classless form inputs to achieve the correct style

Usage

SakuraCSS$sakuraInput(input)

Arguments

input

Some UI input

---

Method clone()

The objects of this class are cloneable with this method.

Usage

SakuraCSS$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

sakuraPage, listSakuraThemes

selectCLInput Convert Classless Input to sakura.css Input

ashbaldry/classless documentation built on June 2, 2022, 12:55 a.m.