Include

Includes give you the power to embed external HTML files into the page.

Included files are asynchronously requested using window.fetch(). Requests are cached, so the same file can be included multiple times, but only one request will be made.

The included content will be inserted into the <wa-include> element's default slot so it can be easily accessed and styled through the light DOM.

<wa-include src="https://shoelace.style/assets/examples/include.html"></wa-include>

Examples Jump to heading

Listening for Events Jump to heading

When an include file loads successfully, the wa-load event will be emitted. You can listen for this event to add custom loading logic to your includes.

If the request fails, the wa-include-error event will be emitted. In this case, event.detail.status will contain the resulting HTTP status code of the request, e.g. 404 (not found).

<wa-include src="https://shoelace.style/assets/examples/include.html"></wa-include>

<script>
  const include = document.querySelector('wa-include');

  include.addEventListener('wa-load', event => {
    if (event.eventPhase === Event.AT_TARGET) {
      console.log('Success');
    }
  });

  include.addEventListener('wa-include-error', event => {
    if (event.eventPhase === Event.AT_TARGET) {
      console.log('Error', event.detail.status);
    }
  });
</script>

Importing Jump to heading

If you're using the autoloader or a hosted project, components load on demand — no manual import needed. To cherry-pick a component manually, use one of the following snippets.

import 'https://ka-f.webawesome.com/webawesome@0.14.0/components/include/include.js';

import '@awesome.me/webawesome/dist/components/include/include.js';

import './webawesome/dist/components/include/include.js';

import WaInclude from '@awesome.me/webawesome/dist/react/include/index.js';

Attributes & Properties Jump to heading

Learn more about attributes and properties.

Events Jump to heading

Learn more about events.