IslandOptions

Options of islandAttributes.

Import#

import type { IslandOptions } from "@shadow-js/dusk";

Signature#

interface IslandOptions {
  /** The island's key in the client registry: lowercase letters, digits and dashes. */
  readonly id: string;
  /** Default `visible`. */
  readonly client?: IslandStrategy;
  /** The media query of the `media` strategy. Required with it. */
  readonly media?: string;
  /** The props the island is given: plain data only (objects, arrays, strings, finite numbers, booleans, null). */
  readonly props?: Readonly<Record<string, unknown>>;
}

Members#

Name	Type	Description
`id`	`readonly id: string`	The island's key in the client registry: lowercase letters, digits and dashes.
`client?`	`readonly client?: IslandStrategy`	Default `visible`.
`media?`	`readonly media?: string`	The media query of the `media` strategy. Required with it.
`props?`	`readonly props?: Readonly<Record<string, unknown>>`	The props the island is given: plain data only (objects, arrays, strings, finite numbers, booleans, null).