Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add&update external mdn and standard link of manifest member #757

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add&update external mdn and standard link of manifest member #757

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 33 additions & 6 deletions src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -438,11 +438,7 @@ export interface ShareTargetFiles {
accept: string | string[]
}

/**
* @see https://developer.mozilla.org/en-US/docs/Web/Manifest/launch_handler#launch_handler_item_values
*/
export type LaunchHandlerClientMode = 'auto' | 'focus-existing' | 'navigate-existing' | 'navigate-new'

export type Display = 'fullscreen' | 'standalone' | 'minimal-ui' | 'browser'
export type DisplayOverride = Display | 'window-controls-overlay'
export type IconPurpose = 'monochrome' | 'maskable' | 'any'
Expand Down Expand Up @@ -472,14 +468,20 @@ export interface IconResource {
export interface ManifestOptions {
/**
* @default _npm_package_name_
* @see https://developer.mozilla.org/en-US/docs/Web/Manifest/name
* @see https://w3c.github.io/manifest/#name-member
*/
name: string
/**
* @default _npm_package_name_
* @see https://developer.mozilla.org/en-US/docs/Web/Manifest/short_name
* @see https://w3c.github.io/manifest/#short_name-member
*/
short_name: string
/**
* @default _npm_package_description_
* @see https://developer.mozilla.org/en-US/docs/Web/Manifest/description
* @see https://w3c.github.io/manifest-app-info/#description-member
*/
description: string
/**
Expand All @@ -499,18 +501,26 @@ export interface ManifestOptions {
}[]
/**
* @default `routerBase`
* @see https://developer.mozilla.org/en-US/docs/Web/Manifest/start_url
* @see https://w3c.github.io/manifest/#start_url-member
*/
start_url: string
/**
* Restricts what web pages can be viewed while the manifest is applied
* @see https://developer.mozilla.org/en-US/docs/Web/Manifest/scope
* @see https://w3c.github.io/manifest/#scope-member
*/
scope: string
/**
* A string that represents the identity for the application
* @see https://developer.mozilla.org/en-US/docs/Web/Manifest/id
* @see https://w3c.github.io/manifest/#id-member
*/
id: string
/**
* Defines the default orientation for all the website's top-level
* @see https://developer.mozilla.org/en-US/docs/Web/Manifest/orientation
* @see https://w3c.github.io/manifest/#orientation-member
*/
orientation: 'any' | 'natural' | 'landscape' | 'landscape-primary' | 'landscape-secondary' | 'portrait' | 'portrait-primary' | 'portrait-secondary'
/**
Expand All @@ -527,18 +537,24 @@ export interface ManifestOptions {
display_override: DisplayOverride[]
/**
* @default `#ffffff`
* @see https://developer.mozilla.org/en-US/docs/Web/Manifest/background_color
* @see https://w3c.github.io/manifest/#background_color-member
*/
background_color: string
/**
* @default '#42b883
* @see https://developer.mozilla.org/en-US/docs/Web/Manifest/theme_color
* @see https://w3c.github.io/manifest/#theme_color-member
*/
theme_color: string
/**
* @default `ltr`
* @see https://w3c.github.io/manifest/#dir-member
*/
dir: 'ltr' | 'rtl'
/**
* @default `en`
* @see https://w3c.github.io/manifest/#lang-member
*/
lang: string
/**
Expand All @@ -547,6 +563,8 @@ export interface ManifestOptions {
publicPath: string
/**
* @default []
* @see https://developer.mozilla.org/en-US/docs/Web/Manifest/related_applications
* @see https://w3c.github.io/manifest/#related_applications-member
*/
related_applications: {
platform: string
Expand All @@ -555,10 +573,14 @@ export interface ManifestOptions {
}[]
/**
* @default false
* @see https://developer.mozilla.org/en-US/docs/Web/Manifest/prefer_related_applications
* @see https://w3c.github.io/manifest/#prefer_related_applications-member
*/
prefer_related_applications: boolean
/**
* @default []
* @see https://developer.mozilla.org/en-US/docs/Web/Manifest/protocol_handlers
* @see https://wicg.github.io/manifest-incubations/#protocol_handlers-member
*/
protocol_handlers: {
protocol: string
Expand All @@ -579,6 +601,7 @@ export interface ManifestOptions {
/**
* @default []
* @see https://developer.mozilla.org/en-US/docs/Web/Manifest/screenshots
* @see https://w3c.github.io/manifest-app-info/#screenshots-member
*/
screenshots: {
src: string
Expand All @@ -590,15 +613,18 @@ export interface ManifestOptions {
}[]
/**
* @default []
* @see https://developer.mozilla.org/en-US/docs/Web/Manifest/categories
* @see https://w3c.github.io/manifest-app-info/#categories-member
*/
categories: string[]
/**
* @default ''
* @see https://w3c.github.io/manifest-app-info/#iarc_rating_id-member
*/
iarc_rating_id: string
/**
* @see https://developer.mozilla.org/en-US/docs/Web/Manifest/share_target
* @see https://w3c.github.io/web-share-target/level-2/#share_target-member
* @see https://w3c.github.io/web-share-target/#share_target-member
*/
share_target: {
action: string
Expand All @@ -616,7 +642,8 @@ export interface ManifestOptions {
*/
handle_links?: 'auto' | 'preferred' | 'not-preferred'
/**
* @see https://developer.mozilla.org/en-US/docs/Web/Manifest/launch_handler#launch_handler_item_values
* @see https://developer.mozilla.org/en-US/docs/Web/Manifest/launch_handler
* @see https://wicg.github.io/web-app-launch/#launch_handler-member
*/
launch_handler?: {
client_mode: LaunchHandlerClientMode | LaunchHandlerClientMode[]
Expand Down