EmbedDefinition
Table of contents
interface EmbedDefinition<Config = never> {}Properties
backgroundColor
readonlyoptional
readonly backgroundColor?: string;canEditWhileLocked
readonlyoptional
readonly canEditWhileLocked?: boolean;doesResize
readonly
readonly doesResize: boolean;embedOnPaste
readonlyoptional
readonly embedOnPaste?: boolean;fromEmbedUrl
readonly
readonly fromEmbedUrl: (url: string) => string | undefined;height
readonly
readonly height: number;hostnames
readonly
readonly hostnames: readonly string[];instructionLink
readonlyoptional
readonly instructionLink?: string;isAspectRatioLocked
readonlyoptional
readonly isAspectRatioLocked?: boolean;minHeight
readonlyoptional
readonly minHeight?: number;minWidth
readonlyoptional
readonly minWidth?: number;overrideOutlineRadius
readonlyoptional
readonly overrideOutlineRadius?: number;overridePermissions
readonlyoptional
readonly overridePermissions?: TLEmbedShapePermissions;sizeToContentAspectRatio
readonlyoptional
When true, the embed shape corrects its size after creation to match the real aspect ratio of its content, so fixed-aspect media (like video) isn't letterboxed inside the default box. The dimensions are resolved from the URL's OpenGraph metadata via the editor's url asset handler (the same "unfurl" path used for bookmarks), so it degrades gracefully when no metadata is available.
readonly sizeToContentAspectRatio?: boolean;title
readonly
readonly title: string;toEmbedUrl
readonly
readonly toEmbedUrl: (url: string, config?: Config) => string | undefined;type
readonly
readonly type: string;width
readonly
readonly width: number;Prev
ElbowArrowTargetBoxNext
EmbedShapeOptions