Classless: Classless Framework

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

Classless Framework

Description

XxX

Methods

Public methods

• Classless$new()

• Classless$getFramework()

• Classless$createPage()

• Classless$addUI()

• Classless$getUI()

• Classless$addServer()

• Classless$getServer()

• Classless$runApp()

• Classless$runExample()

• Classless$textInput()

• Classless$passwordInput()

• Classless$textAreaInput()

• Classless$numericInput()

• Classless$dateInput()

• Classless$checkboxInput()

• Classless$selectInput()

• Classless$actionButton()

• Classless$clone()

---

Method new()

Create a new Classless object

Usage

Classless$new(framework)

Arguments

framework

Name of the framework

Returns

A new Classless object

---

Method getFramework()

Get the name of the selected classless framework

Usage

Classless$getFramework()

Returns

The name of the framework

---

Method createPage()

Method required to create a UI page with the required framework

By default this method is not available and must be created in the extended R6 class

Usage

Classless$createPage(...)

Arguments

...

Ignored

---

Method addUI()

Set UI Code

Usage

Classless$addUI(ui)

Arguments

ui

UI code

---

Method getUI()

Get UI code

Usage

Classless$getUI()

---

Method addServer()

Set server function

Usage

Classless$addServer(fun)

Arguments

fun

Server function

---

Method getServer()

Get server function

Usage

Classless$getServer()

---

Method runApp()

Run shiny application

Usage

Classless$runApp(...)

Arguments

...

Arguments passed to shinyApp

---

Method runExample()

Run an example application, showing off components available in the classless framework

See runClasslessExample for more details

Usage

Classless$runExample(...)

Arguments

...

Arguments to passed to shinyApp

Returns

A shiny application with example components

---

Method textInput()

Create an input control for entry of unstructured text values

Usage

Classless$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

Classless$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

Classless$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

Classless$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

Classless$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

Classless$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

Classless$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 actionButton()

Creates an action button whose value is initially zero, and increments by one each time it is pressed.

Usage

Classless$actionButton(input_id, label, ...)

Arguments

input_id

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

label

Display label for the control

...

Named attributes to be applied to the button or link.

Returns

Abutton control that can be added to a UI definition

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Classless$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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