Manifest

The web app manifest. The fields follow the W3C manifest; display is one of its modes.

Import#

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

Signature#

interface Manifest {
  readonly name?: string;
  readonly short_name?: string;
  readonly description?: string;
  readonly id?: string;
  readonly start_url?: string;
  readonly scope?: string;
  readonly display?: "fullscreen" | "standalone" | "minimal-ui" | "browser";
  readonly display_override?: readonly string[];
  readonly orientation?: string;
  readonly theme_color?: string;
  readonly background_color?: string;
  readonly lang?: string;
  readonly dir?: "ltr" | "rtl" | "auto";
  readonly icons?: readonly ManifestIcon[];
  readonly categories?: readonly string[];
  readonly shortcuts?: readonly {
    readonly name: string;
    readonly url: string;
    readonly short_name?: string;
    readonly description?: string;
    readonly icons?: readonly ManifestIcon[];
  }[];
  readonly screenshots?: readonly {
    readonly src: string;
    readonly sizes?: string;
    readonly type?: string;
    readonly form_factor?: "narrow" | "wide";
    readonly label?: string;
  }[];
  readonly related_applications?: readonly {
    readonly platform: string;
    readonly url?: string;
    readonly id?: string;
  }[];
  readonly prefer_related_applications?: boolean;
}

Members#

Name	Type	Description
`name?`	`readonly name?: string`
`short_name?`	`readonly short_name?: string`
`description?`	`readonly description?: string`
`id?`	`readonly id?: string`
`start_url?`	`readonly start_url?: string`
`scope?`	`readonly scope?: string`
`display?`	`readonly display?: "fullscreen" \| "standalone" \| "minimal-ui" \| "browser"`
`display_override?`	`readonly display_override?: readonly string[]`
`orientation?`	`readonly orientation?: string`
`theme_color?`	`readonly theme_color?: string`
`background_color?`	`readonly background_color?: string`
`lang?`	`readonly lang?: string`
`dir?`	`readonly dir?: "ltr" \| "rtl" \| "auto"`
`icons?`	`readonly icons?: readonly ManifestIcon[]`
`categories?`	`readonly categories?: readonly string[]`
`shortcuts?`	`readonly shortcuts?: readonly { readonly name: string; readonly url: string; readonly short_name?: string; readonly description?: string; readonly icons?: readonly ManifestIcon[]; }[]`
`screenshots?`	`readonly screenshots?: readonly { readonly src: string; readonly sizes?: string; readonly type?: string; readonly form_factor?: "narrow" \| "wide"; readonly label?: string; }[]`
`related_applications?`	`readonly related_applications?: readonly { readonly platform: string; readonly url?: string; readonly id?: string; }[]`
`prefer_related_applications?`	`readonly prefer_related_applications?: boolean`