EmbedShapeOptions

See source code

Table of contents

embedDefinitions
Properties
Methods
- getCustomDisplayValues
- getDefaultDisplayValues

Extends ShapeOptionsWithDisplayValues<TLEmbedShape, EmbedShapeUtilDisplayValues>.

interface EmbedShapeOptions extends ShapeOptionsWithDisplayValues<
  TLEmbedShape,
  EmbedShapeUtilDisplayValues
> {}

Properties

embedDefinitions

readonly

The embed definitions to use for this shape util.

readonly embedDefinitions: readonly TLEmbedDefinition[];

Methods

getCustomDisplayValues

from ShapeOptionsWithDisplayValues

Parameters

Name	Description
`editor`	`Editor;`
`shape`	`Shape;`
`theme`	`TLTheme;`
`colorMode`	`"dark" \| "light";`

Returns

Partial<DisplayValues>;

getDefaultDisplayValues

from ShapeOptionsWithDisplayValues

Parameters

Name	Description
`editor`	`Editor;`
`shape`	`Shape;`
`theme`	`TLTheme;`
`colorMode`	`"dark" \| "light";`

Returns

DisplayValues;

EmbedDefinition

EmbedShapeUtilDisplayValues