mirror of
https://github.com/shoelace-style/webawesome.git
synced 2026-01-12 20:19:13 +00:00
8121faa1d4
* keep header styles with repositioned description text * `animated-image` move description to component * code style * `avatar` add summary from docs * `badge` add summary from docs * `breadcrumb` add summary from docs * `button` add summary from docs * lead sentence is now part of the header * `button-group` add summary from docs * `card` add summary from docs * `checkbox` add summary from docs * `color-picker` add summary from docs * `details` add summary from docs * `dialog` add summary from docs * `divider` add summary from docs * `drawer` add summary from docs * `dropdown` add summary from docs * `format-bytes` add summary from docs * `format-date` add summary from docs * `format-number` add summary from docs * `icon` add summary from docs * `icon-button` add summary from docs * `image-comparer` add summary from docs * `include` add summary from docs * `input` add summary from docs * `menu` add summary from docs * `menu-item` add summary from docs * `menu-label` add summary from docs * `popup` add summary from docs * `progressbar` add summary from docs * `progress-ring` add summary from docs * `radio` add summary from docs * `radio-button` add summary from docs * `range` add summary from docs * `rating` add summary from docs * `relative-time` add summary from docs * `select` add summary from docs * `skeleton` add summary from docs * `spinner` add summary from docs * `split-panel` add summary from docs * `switch` add summary from docs * `tab-group` add summary from docs * `tag` add summary from docs * `textarea` add summary from docs * `tooltip` add summary from docs * `visually-hidden` add summary from docs * `animation` add summary from docs * `breadcrumb-item` add summary from docs * `mutation-observer` add summary from docs * `radio-group` add summary from docs * `resize-observer` add summary from docs * `tab` add summary from docs * `tab-panel` add summary from docs * `tree` add summary from docs * `tree-item` add summary from docs * remove `title` for further usage of `Sl` classnames in docs * revert: use markdown parser for component summary
48 lines
1.5 KiB
Markdown
48 lines
1.5 KiB
Markdown
# Include
|
|
|
|
[component-header:sl-include]
|
|
|
|
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 `<sl-include>` element's default slot so it can be easily accessed and styled through the light DOM.
|
|
|
|
```html preview
|
|
<sl-include src="https://shoelace.style/assets/examples/include.html"></sl-include>
|
|
```
|
|
|
|
```jsx react
|
|
import { SlInclude } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const App = () => <SlInclude src="https://shoelace.style/assets/examples/include.html" />;
|
|
```
|
|
|
|
## Examples
|
|
|
|
### Listening for Events
|
|
|
|
When an include file loads successfully, the `sl-load` event will be emitted. You can listen for this event to add custom loading logic to your includes.
|
|
|
|
If the request fails, the `sl-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).
|
|
|
|
```html
|
|
<sl-include src="https://shoelace.style/assets/examples/include.html"></sl-include>
|
|
|
|
<script>
|
|
const include = document.querySelector('sl-include');
|
|
|
|
include.addEventListener('sl-load', event => {
|
|
if (event.eventPhase === Event.AT_TARGET) {
|
|
console.log('Success');
|
|
}
|
|
});
|
|
|
|
include.addEventListener('sl-error', event => {
|
|
if (event.eventPhase === Event.AT_TARGET) {
|
|
console.log('Error', event.detail.status);
|
|
}
|
|
});
|
|
</script>
|
|
```
|
|
|
|
[component-metadata:sl-include]
|