Skip to content

Vizel API / core/src / VizelEmbedData

Interface: VizelEmbedData

Defined in: packages/core/src/utils/embed-providers.ts:34

Embed metadata returned from fetch

Properties

description?

ts
optional description?: string;

Defined in: packages/core/src/utils/embed-providers.ts:50

OGP/oEmbed description


favicon?

ts
optional favicon?: string;

Defined in: packages/core/src/utils/embed-providers.ts:56

Favicon URL


height?

ts
optional height?: number;

Defined in: packages/core/src/utils/embed-providers.ts:46

oEmbed height


html?

ts
optional html?: string;

Defined in: packages/core/src/utils/embed-providers.ts:42

oEmbed HTML content


image?

ts
optional image?: string;

Defined in: packages/core/src/utils/embed-providers.ts:52

OGP/oEmbed image URL


loading?

ts
optional loading?: boolean;

Defined in: packages/core/src/utils/embed-providers.ts:58

Whether the embed is currently loading


provider?

ts
optional provider?: string;

Defined in: packages/core/src/utils/embed-providers.ts:40

Provider name if detected


siteName?

ts
optional siteName?: string;

Defined in: packages/core/src/utils/embed-providers.ts:54

OGP site name


title?

ts
optional title?: string;

Defined in: packages/core/src/utils/embed-providers.ts:48

OGP/oEmbed title


type

ts
type: VizelEmbedType;

Defined in: packages/core/src/utils/embed-providers.ts:38

Type of embed based on available data


url

ts
url: string;

Defined in: packages/core/src/utils/embed-providers.ts:36

Original URL


width?

ts
optional width?: number;

Defined in: packages/core/src/utils/embed-providers.ts:44

oEmbed width

Released under the MIT License.