Skip to content

Vizel API / core/src / VizelEmbedData

Interface: VizelEmbedData ​

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

Embed metadata returned from fetch

Properties ​

description? ​

ts
optional description?: string;

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

OGP/oEmbed description


favicon? ​

ts
optional favicon?: string;

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

Favicon URL


height? ​

ts
optional height?: number;

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

oEmbed height


html? ​

ts
optional html?: string;

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

oEmbed HTML content


image? ​

ts
optional image?: string;

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

OGP/oEmbed image URL


loading? ​

ts
optional loading?: boolean;

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

Whether the embed is currently loading


provider? ​

ts
optional provider?: string;

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

Provider name if detected


siteName? ​

ts
optional siteName?: string;

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

OGP site name


title? ​

ts
optional title?: string;

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

OGP/oEmbed title


type ​

ts
type: VizelEmbedType;

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

Type of embed based on available data


url ​

ts
url: string;

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

Original URL


width? ​

ts
optional width?: number;

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

oEmbed width

Released under the MIT License.