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');
});

Complete example code:

https://github.com/eagle-app/eagle-plugin-examples/tree/main/Window

🌐 Explore the Multilingual Support Project!

For developers needing to implement internationalization (i18n), this GitHub project offers an excellent demonstration. Click the link below to learn how to combine i18n with theme design to enhance the multilingual support of your application.

👉 Explore More

Note: You can refer to this article to learn about all the configuration methods for manifest.json

PreviousPlugin Types NextBackground Service

Last updated 1 day ago