Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/11ty/is-land
A new performance-focused way to add interactive client-side components to your web site.
https://github.com/11ty/is-land
Last synced: about 2 months ago
JSON representation
A new performance-focused way to add interactive client-side components to your web site.
- Host: GitHub
- URL: https://github.com/11ty/is-land
- Owner: 11ty
- License: mit
- Created: 2022-05-25T22:23:02.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-22T04:35:57.000Z (about 1 year ago)
- Last Synced: 2024-04-14T11:01:16.078Z (5 months ago)
- Language: JavaScript
- Homepage: https://is-land.11ty.dev/
- Size: 221 KB
- Stars: 494
- Watchers: 6
- Forks: 12
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-islands - 11ty `is-land`
README
# ``
A new performance-focused way to add interactive client-side components to your web site.
Or, more technically: a framework independent partial hydration islands architecture implementation.
* View the [demos](https://is-land.11ty.dev/)
* Check out the [initial screencast on Eleventy’s YouTube channel](https://youtu.be/YYJpFdEaAuc?t=188) and [the follow up screencast with more framework examples](https://www.youtube.com/watch?v=V9hWgVV_5mg).
* [Learn more about Islands Architecture](https://jasonformat.com/islands-architecture/)
Features:
* Easy to add to existing components
* Zero dependencies
* Not tightly coupled to a server framework or site generator tool.
* Small footprint (5 kB minimized; 1.61 kB with Brotli compression)
* Server-rendered (SSR) component examples available for SSR-friendly frameworks (Lit, Svelte, Vue, Preact are provided)
Examples for:
* [Web Components](./demo/index.html)
* [Web Components using Declarative Shadow DOM](./demo/demo-declarative-shadow-dom.html) _(New in v3.0.0)_
* [Svelte](./demo/demo-svelte.html) (and SSR)
* [Vue (and petite-vue)](./demo/demo-vue.html) (and SSR)
* [Preact](./demo/demo-preact.html) (and SSR)
* [Lit](./demo/demo-lit.html) (and SSR)
* [Alpine.js](./demo/demo-alpine.html)
* [Embedded in Markdown](./demo/demo-markdown.md)
* [`defer-hydration` Component Attribute Support](./demo/demo-defer-hydration.html) _(New in v3.0.0)_ ([Read more about `defer-hydration` at zachleat.com](https://www.zachleat.com/web/defer-hydration/))
* _Experimental:_ [Image Loading](./demo/demo-image-loading.html)
* _Experimental:_ [Using import maps to simplify import URLs](./demo/demo-importmaps.html). This is for-future-reference when [browser support broadens](https://caniuse.com/import-maps).
Integrations in the wild:
* [Eleventy](https://is-land.11ty.dev/)
* [WebC](https://demo-webc-image-compare.netlify.app)
* [Slinkity](https://twitter.com/slinkitydotdev/status/1544322804774064133)
* [SvelteKit](https://twitter.com/geoffrich_/status/1576932300960342018)
* [Bridgetown](https://twitter.com/jaredcwhite/status/1585433466770173953)
* [Lit](https://twitter.com/techytacos/status/1590248099297259520)
## Installation
```
npm install @11ty/is-land
```
Add `is-land.js` to your primary bundle. It can be deferred and/or loaded asynchronously.
When using with web components it must be the first custom element defined (via `customElements.define`) on the page. Choose your style:
```html
```
```html
import "/is-land.js";
```
The framework `autoinit` examples shown below now require a separate `is-land-autoinit.js` file too.
## Usage
```html
This is an island.
```
Add any number of loading conditions to this tag to control how and when the island is initialized. You can mix and match:
* `on:visible`
* `on:idle`
* `on:interaction` (defaults to `touchstart,click`)
* Change events with `on:interaction="mouseenter,focusin"`
* `on:media`
* Viewport size: `on:media="(min-width: 64em)"`
* Reduced motion:
* Opt-in with `on:media="(prefers-reduced-motion)"`
* Opt-out with `on:media="(prefers-reduced-motion: no-preference)"`
* Save Data ([read about Save Data on MDN](https://developer.mozilla.org/en-US/docs/Web/API/NetworkInformation/saveData))
* Opt-in with `on:save-data`
* Opt-out with `on:save-data="false"`
```html
```
### Controlling Fallback Content
#### Pre-JS
```html
Put your pre-JS fallback content in your web component.
```
#### Post-JS with ``
Place any post-JS content inside of one or more `` elements anywhere in the ``. These will be swapped with their template content. You can nest an `` in there if you want!
```html
This component is post-JS.
```
* Use `data-island="replace"` to replace the contents of the `` with the template.
* Use `data-island="once"` to run a template’s contents once per page (keyed from template contents). _(New in v2.0.1)_
#### Run your own custom JavaScript, load your own CSS
Embed a script inside the template to run custom JS when the island’s loading conditions have been satisfied!
```html
/* My custom CSS */
console.log("Hydrating!");
```
You can also use the `ready` attribute for styling, added to the `` when the island has been hydrated.
```html
is-land[ready] {
background-color: lightgreen;
}
```
### Framework Support
[Demos and source in the HTML](https://is-land.11ty.dev/) are available for each framework listed here. These examples require the `is-land-autoinit.js` JavaScript file (in addition to `is-land.js`).
#### `autoinit`
Use the `autoinit` and `import` attributes together to import a third party library (or component code). `autoinit` can be one of `petite-vue`, `vue`, `preact`, or `svelte`. It is recommended to use a self-hosted framework library (future Eleventy integrations will automate this for you).
```html
Hello from pre-JS
Hello from pre-JS
```
#### Petite Vue
* Small library (8K)
* Rendering modes: Client
* Progressive-enhancement friendly (full control of fallback content)
* Support for `autoinit`
```html
Hello from pre-JS
```
#### Vue
* Larger library (51 kB)
* Rendering modes: Client-only, Server-only, Server + Client (Hydration)
* Support for `autoinit`
```html
Hello from pre-JS
import { createApp } from "https://unpkg.com/[email protected]/dist/vue.esm-browser.prod.js";
createApp({
data: () => ({ name: "post-JS" })
}).mount("#vue-app")
```
#### Svelte
* Smaller library (12 kB)
* Rendering modes: Client-only, Server-only, Server + Client (Hydration)
* Requires a compiler for both client and server modes (tighter server coupling)
* Support for `autoinit`
This example uses [an Eleventy/Svelte integration](./11ty/SveltePlugin.cjs) to compile a Svelte component.
```html
{% assign component = "./lib/svelte/my-component.svelte" | svelte %}
```
Example component code ./lib/svelte/my-component.svelte:
```html
// using export to allow overrides via props
export let name = 'world';
let count = 0;
function handleClick() {
count += 1;
}
h1 { color: red }
Hello {name}
Clicked {count} {count === 1 ? 'time' : 'times'}
```
#### Preact
* Very small library (~5 kB)
* Rendering modes: Client-only, Server-only, Server + Client (Hydration)
* Support for `autoinit`
This example uses [`htm` instead of JSX](https://github.com/developit/htm).
```html
```
Example component code ./lib/preact/preact-component.js:
```js
import { html, render } from 'https://unpkg.com/htm/preact/index.mjs?module'
function App (props) {
return html`
Hello ${props.name}!
`;
}
export default function(el) {
render(html`<${App} name="from Preact" />`, el);
}
```
#### Lit
* Small library (~7 kB)
* Rendering modes: Client-only, Server + Client (Hydration)
* Note: Server-only is not supported: it requires Declarative Shadow DOM support to work without JS.
* No support for `autoinit`
```html
Pre-JS Content
```
Example component code ./lib/lit/lit-component.js:
```js
import {html, css, LitElement} from "https://cdn.jsdelivr.net/gh/lit/dist@2/core/lit-core.min.js";
customElements.define('lit-component', class extends LitElement {
static properties = {
name: {type: String},
};
render() {
return html`
Hello, ${this.name || "Stranger"}!
`;
}
});
```
#### Alpine.js
* Smaller library (15 kB)
* Rendering modes: Client-only
* No `autoinit` but it is not needed (functionality included for-free by Alpine.js)
```html
Hello from Alpine.js!
⬆️ ⬇️
```