@cdransf/api-text
v1.8.1
Published
A web component to load text from an API and display it.
Downloads
413
Maintainers
Readme
<api-text>
web component
A web component to load text from an API and display it.
npm i @cdransf/api-text
Example usage
Add the api-text.js
to your markup and define the necessary markup within your web component:
<script type="module" src="api-text.js"></script>
<api-text api-url="/api/now-playing">
<p class="loading">🎧 Loading...</p>
<p class="content"></p>
<noscript>
<!-- Fallback content if JavaScript is disabled; also used as fallback content in the event of an API error. -->
</noscript>
</api-text>
Optional attributes:
- display: sets the display property of the element when the content is loaded. Default is
block
. - storage: sets the storage API to be used. Defaults to
sessionStorage
, but can also be set to "local
forlocalStorage
. - transition-duration: sets the duration of the transition when the content is loaded. Default is
0.3s
.
I use this component to load media data from a Netlify edge function and describe an earlier iteration in this blog post.