Skip to content

@get-advantage/advantage / types / AdvantageFormatOptions

Interface: AdvantageFormatOptions

types.AdvantageFormatOptions

Properties

adLabel

Optional adLabel: string

Defined in

src/types/index.ts:104


autoCloseDuration

Optional autoCloseDuration: number

The duration in seconds before the format closes automatically. If set to 0, the format will not close automatically.

Defult

12

Defined in

src/types/index.ts:85


closeButton

Optional closeButton: boolean

Defined in

src/types/index.ts:73


closeButtonAnimationDuration

Optional closeButtonAnimationDuration: number

Defined in

src/types/index.ts:75


closeButtonText

Optional closeButtonText: string

Defined in

src/types/index.ts:74


continueToLabel

Optional continueToLabel: string

Can be used to customize the label of the continue to site

Defaul

Continue to

Defined in

src/types/index.ts:108


downArrow

Optional downArrow: boolean

Defined in

src/types/index.ts:76


height

Optional height: number

Defined in

src/types/index.ts:77


Optional logo: string

Logo file to display in Welcome page header bar, right before the continueToLabel. Accepts a path string to the image. If not set, current sites favicon will be displayed. If set to false, logo will be hidden.

Default

ts
https://icons.duckduckgo.com/ip3/[hostname].ico

Defined in

src/types/index.ts:102


scrollBackToTop

Optional scrollBackToTop: boolean

Defined in

src/types/index.ts:103


siteTitle

Optional siteTitle: string | boolean

You can customize this item to replace the default site title. When set to false, title will be hidden. Useful when you have customize continueToLabel.

Default

ts
window.location.hostname

Defined in

src/types/index.ts:93