Skip to content

SignInPromptModel

SignInPromptModel = object

Defined in: packages/schema/src/model.ts:494

What a visitor who is not signed in is told about a resource they could use once signed in (.signIn(...)): on its list page, in place of the list, and in the dialog of a card’s favorite button or a list’s “Save search” button that saves to it. See Sign-in prompts.

optional benefits?: string[]

Defined in: packages/schema/src/model.ts:500

What the visitor can do once signed in, one short line each.


description: string

Defined in: packages/schema/src/model.ts:498

A line under it, saying what signing in gives.


optional icon?: string

Defined in: packages/schema/src/model.ts:502

The prompt’s icon, a name icon hints take; a sign-in icon when omitted.


optional signUp?: object

Defined in: packages/schema/src/model.ts:507

A page elsewhere where a visitor makes an account, https:, http: or mailto:, offered beside “Sign in”. When omitted, the app’s own sign-up is offered if the server has open sign-up, and none otherwise.

href: string

The page’s address.

label: string

The button’s text, such as “Create an account”.


title: string

Defined in: packages/schema/src/model.ts:496

The heading, such as “Keep the homes you like”.