Window

In this article, we will explain the basic concepts of window plugins.

PreviousPlugin Types NextBackground Service

Last updated 8 months ago

Window

In this article, we will explain the basic concepts of window plugins.

The vast majority of plugins should be developed using this method. It provides a browser window where you can develop the desired features, and this window will automatically pop up when the user clicks on the plugin.

We can set the window properties by setting the main field in the manifest.json file.

{
    "main": {}
}

Set the default open link URL for the window:

{
    "main": {
        "url": "index.html"
    }
}

Set the default width and height of the window:

{
    "main": {
        "url": "index.html",
        "width": 640,
        "height": 480
    }
}

After setting other metadata.json fields, the final code is as follows:

{
    "id": "LBCZE8V6LPCKD",
    "version": "1.0.0",
    "name": "Window Plugin",
    "logo": "/logo.png",
    "keywords": [],
    "main":
    {
        "url": "index.html",
        "width": 640,
        "height": 480
    }
}

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no" />
    <script type="text/javascript" src="js/plugin.js"></script>
</head>

<body>
    <div id="message"></div>
</body>
</html>

eagle.onPluginCreate((plugin) => {
    console.log('eagle.onPluginCreate');
    console.log(plugin);
    document.querySelector('#message').innerHTML = `
    <ul>
        <li>id: ${plugin.manifest.id}</li>
        <li>version: ${plugin.manifest.version}</li>
        <li>name: ${plugin.manifest.name}</li>
        <li>logo: ${plugin.manifest.logo}</li>
        <li>path: ${plugin.path}</li>
    </ul>
`;
});

eagle.onPluginShow(() => {
    console.log('eagle.onPluginShow');
});

eagle.onPluginHide(() => {
    console.log('eagle.onPluginHide');
});

eagle.onPluginBeforeExit((event) => {
    console.log('eagle.onPluginBeforeExit');
});

Check out this sample code!

Looking for inspiration? Come and explore our sample code; there's a wealth of exciting content waiting for you!

Sample code for Multilanguage + Multitheme

For developers aiming to achieve multilanguage internationalization (i18n), this GitHub project is your best learning companion! Click the link below to explore how to cleverly combine i18n with multitheme design, adding a touch of magic to your application's multilanguage support.