CustomEmbedDefinition
Table of contents
Extends EmbedDefinition<Config>.
interface CustomEmbedDefinition<
Config = never,
> extends EmbedDefinition<Config> {}Properties
backgroundColor
readonlyoptional
from EmbedDefinition
readonly backgroundColor?: string;canEditWhileLocked
readonlyoptional
from EmbedDefinition
readonly canEditWhileLocked?: boolean;doesResize
readonly
from EmbedDefinition
readonly doesResize: boolean;embedOnPaste
readonlyoptional
from EmbedDefinition
readonly embedOnPaste?: boolean;fromEmbedUrl
readonly
from EmbedDefinition
readonly fromEmbedUrl: (url: string) => string | undefined;height
readonly
from EmbedDefinition
readonly height: number;hostnames
readonly
from EmbedDefinition
readonly hostnames: readonly string[];icon
readonly
readonly icon: string;instructionLink
readonlyoptional
from EmbedDefinition
readonly instructionLink?: string;isAspectRatioLocked
readonlyoptional
from EmbedDefinition
readonly isAspectRatioLocked?: boolean;minHeight
readonlyoptional
from EmbedDefinition
readonly minHeight?: number;minWidth
readonlyoptional
from EmbedDefinition
readonly minWidth?: number;overrideOutlineRadius
readonlyoptional
from EmbedDefinition
readonly overrideOutlineRadius?: number;overridePermissions
readonlyoptional
from EmbedDefinition
readonly overridePermissions?: TLEmbedShapePermissions;sizeToContentAspectRatio
readonlyoptional
from EmbedDefinition
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
from EmbedDefinition
readonly title: string;toEmbedUrl
readonly
from EmbedDefinition
readonly toEmbedUrl: (url: string, config?: Config) => string | undefined;type
readonly
from EmbedDefinition
readonly type: string;width
readonly
from EmbedDefinition
readonly width: number;Prev
CustomDebugFlagsNext
DashedPathBuilderOpts