# shiny.webawesome: Shiny Bindings for Web Awesome Components

Provides an R and [Shiny](https://shiny.posit.co) interface to the [Web
Awesome](https://webawesome.com) component library.

## Details

`shiny.webawesome` is a generator-driven package that exposes Web
Awesome components as R functions for use in Shiny applications. Most
component wrappers are generated from the upstream Web Awesome metadata
file `custom-elements.json`, which the package treats as its primary
component source of truth.

The package aims to stay close to upstream Web Awesome names,
conventions, and component APIs while adopting normal R conventions such
as snake_case argument names. Because Web Awesome lives in the browser
and Shiny spans both server and client, the package also includes a
curated Shiny binding layer plus a small set of package-level helpers
for layout, browser commands, and app-local JavaScript.

### Main package surfaces

The package exposes several complementary surfaces:

- generated component wrappers such as
  [`wa_button()`](https://www.shiny-webawesome.org/reference/wa_button.md)
  and
  [`wa_select()`](https://www.shiny-webawesome.org/reference/wa_select.md)

- layout helpers such as
  [`webawesomePage()`](https://www.shiny-webawesome.org/reference/webawesomePage.md)
  and
  [`wa_container()`](https://www.shiny-webawesome.org/reference/wa_container.md)

- generated Shiny bindings and update helpers for selected interactive
  components

- command-layer helpers such as
  [`wa_set_property()`](https://www.shiny-webawesome.org/reference/wa_set_property.md)
  and
  [`wa_call_method()`](https://www.shiny-webawesome.org/reference/wa_call_method.md)

- the narrow browser-glue helper
  [`wa_js()`](https://www.shiny-webawesome.org/reference/wa_js.md)

- the package helper
  [`wa_version()`](https://www.shiny-webawesome.org/reference/wa_version.md)
  for reporting the bundled Web Awesome version

### Package options

The package currently uses the option `shiny.webawesome.warnings` to
control selected runtime warnings and diagnostics.

This option should be a named list. Known keys currently include:

- `missing_tree_item_id`

- `command_layer`

- `command_layer_debug`

Example:

`options(shiny.webawesome.warnings = list(command_layer_debug = TRUE))`

### Learn more

For an introductory guide, see
[`vignette("get-started", package = "shiny.webawesome")`](https://www.shiny-webawesome.org/articles/get-started.md).
For function-specific details, use the package help pages such as
[`?webawesomePage`](https://www.shiny-webawesome.org/reference/webawesomePage.md),
[`?wa_set_property`](https://www.shiny-webawesome.org/reference/wa_set_property.md),
[`?wa_call_method`](https://www.shiny-webawesome.org/reference/wa_call_method.md),
[`?wa_js`](https://www.shiny-webawesome.org/reference/wa_js.md), and
[`?wa_version`](https://www.shiny-webawesome.org/reference/wa_version.md).

## See also

Useful links:

- <https://github.com/mbanand/shiny.webawesome>

- <https://www.shiny-webawesome.org>

- Report bugs at <https://github.com/mbanand/shiny.webawesome/issues>

## Author

**Maintainer**: M. B. Anand <privateanand@gmail.com>