README.md

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

{classless}

{classless} contains a selection of classless CSS frameworks that can be used within shiny applications.

Classless frameworks use the concept semantic HTML, which is the use of HTML markup to reinforce the semantics, or meaning, of the information in web pages and web applications rather than merely to define its presentation or look. Rather than using <div> and <span> tags throughout a webpage, there are many different HTML elements that can be used to better describe what the contents include. This is particularly useful for accessibility, where screen readers can better understand the structure of the of the document.

Currently the following frameworks are included in {classless}:

• Almond.CSS
• Classless.css
• sakura

Installation

# Install the latest version from GitHub:
devtools::install_github("ashbaldry/classless")

Usage

Each framework includes a <framework>Page function that can be used to generate all the HTML from scratch.

There is also an R6 class available for each framework, that includes creating a page. This makes it very simple to switch from one framework to another with little/no change required in the code base.

Examples

To have a look at an example page, there is an example method available in the R6 class:

AlmondCSS$new()$runExample()

Additional Frameworks

To use a framework not covered by {classless}, use the Classless R6 object as the inherit class to build up your own framework. With the exception of the page function, everything is available within Classless to enable you to build a semantic webpage.

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