1.4 KiB

Raw Blame History

@aomao/plugin-embed

Embed URL

By inheriting this plug-in, you can embed a specific URL to realize the preview function.

Install

$ yarn add @aomao/plugin-embed

Add to engine

import Engine, {EngineInterface} from'@aomao/engine';
import Embed, {EmbedComponent} from'@aomao/plugin-embed';

new Engine(...,{ plugins:[ Embed], cards:[ EmbedComponent ]})

`Embed` optional

//Use configuration
new Engine(...,{
    config:{
        [Embed.pluginName]:{
            //...Related configuration
        }
    }
 })

Return specific information before the first rendering

renderBefore: return some information before rendering

renderBefore?:(url: string) => {url?: string
    height?: number
    collapsed?: boolean
    ico?: string
    title?: string
    isResize?: boolean}

If you need to extend the returned information more, you can inherit the EmbedComponent class, and then override the handleSubmit method

Command

Insert URL

Parameter 1: The url to be loaded, optional, the current input url interface will be displayed by default Parameter 2: icon, the default is a web icon Parameter 3: Title, default is url Parameter 4: Whether to collapse, the default is false Parameter 5: Whether the size can be changed, the default is true

engine.command.execute(
	Math.pluginName,
	'https://editor.yanmao.cc', // optional
	'ico icon',
	'Display title',
	false,
	true,
);

1.4 KiB Raw Blame History