Usage

Web Awesome components are just regular HTML elements, or custom elements to be precise. You can use them like any other element. Each component has detailed documentation that describes its full API, including properties, events, methods, and more.

If you're new to custom elements, often referred to as "web components," this section will familiarize you with how to use them.

Attributes & Properties Jump to heading #

Many components have properties that can be set using attributes. For example, buttons accept a size attribute that maps to the size property which dictates the button's size.

<wa-button size="small">Click me</wa-button>

Some properties are boolean, so they only have true/false values. To activate a boolean property, add the corresponding attribute without a value.

<wa-button disabled>Click me</wa-button>

Events Jump to heading #

You can listen for standard events such as click, mouseover, etc. as you normally would. However, it's important to note that many events emitted within a component's shadow root will be retargeted to the host element. This may result in, for example, multiple click handlers executing even if the user clicks just once. Furthermore, event.target will point to the host element, making things even more confusing.

As a result, you should almost always listen for Web Awesome events instead. For example, instead of listening to click to determine when an <wa-checkbox> gets toggled, listen to wa-change.

<wa-checkbox>Check me</wa-checkbox>

<script>
  const checkbox = document.querySelector('wa-checkbox');
  checkbox.addEventListener('wa-change', event => {
    console.log(event.target.checked ? 'checked' : 'not checked');
  });
</script>

All Web Awesome events are prefixed with wa- to prevent collisions with standard events and other libraries. Refer to a component's documentation for a complete list of its events.

Methods Jump to heading #

Some components have methods you can call to trigger various behaviors. For example, you can set focus on a Web Awesome input using the focus() method.

<wa-input></wa-input>

<script>
  const input = document.querySelector('wa-input');
  input.focus();
</script>

Refer to a component's documentation for a complete list of its methods and their arguments.

Slots Jump to heading #

Many components use slots to accept content inside of them. The most common slot is the default slot, which includes any content inside the component that doesn't have a slot attribute.

For example, a button's default slot is used to populate its label.

<wa-button>Click me</wa-button>

Some components also have named slots. A named slot can be populated by adding a child element with the appropriate slot attribute. Notice how the icon below has the slot="prefix" attribute? This tells the component to place the icon into its prefix slot.

<wa-button>
  <wa-icon slot="prefix" name="gear" variant="solid"></wa-icon>
  Settings
</wa-button>

The location of a named slot doesn't matter. You can put it anywhere inside the component and the browser will move it to the right place automatically!

Refer to a component's documentation for a complete list of available slots.

Don't Use Self-closing Tags Jump to heading #

Custom elements cannot have self-closing tags. Similar to <script> and <textarea>, you must always include the full closing tag.

<!-- Don't do this -->
<wa-input />

<!-- Always do this -->
<wa-input></wa-input>

Differences from Native Elements Jump to heading #

You might expect similarly named elements to share the same API as native HTML elements, but this is not always the case. Web Awesome components are not designed to be one-to-one replacements for their HTML counterparts. While they usually share the same API, there may be subtle differences.

For example, <button> and <wa-button> both have a type attribute, but the native one defaults to submit while the Web Awesome one defaults to button since this is a better default for most users.

Waiting for Components to Load Jump to heading #

Web components are registered with JavaScript, so depending on how and when you load Web Awesome, you may notice a Flash of Undefined Custom Elements (FOUCE) when the page loads. There are a couple ways to prevent this, both of which are described in the linked article.

One option is to use the :defined CSS pseudo-class to "hide" custom elements that haven't been registered yet. You can scope it to specific tags or you can hide all undefined custom elements as shown below.

:not(:defined) {
  visibility: hidden;
}

As soon as a custom element is registered, it will immediately appear with all of its styles, effectively eliminating FOUCE. Note the use of visibility: hidden instead of display: none to reduce shifting as elements are registered. The drawback to this approach is that custom elements can potentially appear one by one instead of all at the same time.

Another option is to use customElements.whenDefined(), which returns a promise that resolves when the specified element gets registered. You'll probably want to use it with Promise.allSettled() in case an element fails to load for some reason.

A clever way to use this method is to hide the <body> with opacity: 0 and add a class that fades it in as soon as all your custom elements are defined.

<style>
  body {
    opacity: 0;
  }

  body.ready {
    opacity: 1;
    transition: 0.25s opacity;
  }
</style>

<script type="module">
  await Promise.allSettled([
    customElements.whenDefined('wa-button'),
    customElements.whenDefined('wa-card'),
    customElements.whenDefined('wa-rating')
  ]);

  // Button, card, and rating are registered now! Add
  // the `ready` class so the UI fades in.
  document.body.classList.add('ready');
</script>

Component Rendering and Updating Jump to heading #

Web Awesome components are built with Lit, a tiny library that makes authoring custom elements easier, more maintainable, and a lot of fun! As a Web Awesome user, here is some helpful information about rendering and updating you should probably be aware of.

To optimize performance and reduce re-renders, Lit batches component updates. This means changing multiple attributes or properties at the same time will result in just a single re-render. In most cases, this isn't an issue, but there may be times you'll need to wait for the component to update before continuing.

Consider this example. We're going to change the checked property of the checkbox and observe its corresponding checked attribute, which happens to reflect.

const checkbox = document.querySelector('wa-checkbox');
checkbox.checked = true;

console.log(checkbox.hasAttribute('checked')); // false

Most developers will expect this to be true instead of false, but the component hasn't had a chance to re-render yet so the attribute doesn't exist when hasAttribute() is called. Since changes are batched, we need to wait for the update before proceeding. This can be done using the updateComplete property, which is available on all Lit-based components.

const checkbox = document.querySelector('wa-checkbox');
checkbox.checked = true;

checkbox.updateComplete.then(() => {
  console.log(checkbox.hasAttribute('checked')); // true
});

This time we see an empty string, which means the boolean attribute is now present!