@astrouxds/rux-component

Astro Web Component for generic web component

Usage no npm install needed!

<script type="module">
  import astrouxdsRuxComponent from 'https://cdn.skypack.dev/@astrouxds/rux-component';
</script>

README

[COMPONENT]

The RUX [component] allows for a dialog style [component] box in the style of …

RUX [COMPONENT] is based on the industry standard WebComponents v1 spec and implemented with Polymer Project 3 for backwards compatibility and document binding.

RUX [Component] is available as a preview release and should not be used in production code.

For stylesheet usage outside of a WebComponent environment, please see Astro UXDS Stylesheets

Guidelines

Installation

Install the Astro Component Library. npm i @astrouxds/rux-component

Dependencies

Usage

Import the RUX Component

import { Rux[COMPONENT] } from "@astrouxds/rux-component/rux-component.js";

Basic HTML Usage

RUX [COMPONENT] …

<rux-[component]></rux-[component]>

<rux-[component]></rux-[component]>

Event Listener

RUX [COMPONENT] …

Properties

Property Type Default Required Description
prop1 string value true …
prop2 string value true
prop3 string value true
prop4 string value true