trodi / electron-splashscreen Goto Github PK

Use case: you need to send IPC messages from the browser process to the splashscreen so it can provide dynamic information / progress.

hi,
i'm using your splashscreen in my electron project and after packaging it , when i try to run it , it gives me an error that can't find module "@trodi/electron-splashscreen"
the code i'm using to import your module is

const Splashscreen = require('@trodi/electron-splashscreen')
and the command for electron packaging is :
electron-packager . --no-prune --ignore=/node_modules --ignore=/src --overwrite

any help please ?

Marwa

This is a place that additional changes can be discussed before a 1.0.0 release happens. Please comment if you see something missing in this module!

I opened this as a place for a chance for those who use this module to comment on API breaking changes as well and general needs, before I publish a 1.0.0 version 🙈.

Possible items:

• Project icon (Add to readme and to the examples)
• Make supported electron versions known via peer dependency
• Any doc improvements?
  • updated doc generator and typescript
• Improvements to improve npms.io score?
  • releasing 1.0

Options to possible auto generate API docs:

• Typedoc
• Markdown for Typedoc

Game Plan

• Generate API docs via Typedoc Markdown plugin
  • Ideally, I'd create a custom Typedoc template that is simpler for this type of API, but I'll punt on that for now.
• Should I commit generated API docs?
  • I don't like committing generated files; they are artifacts of the build.
  • Any issues with npm publish?

Description

Thanks for this nice project. I tried to integrate the splash screen into my electron-vue app (https://github.com/Symbolk/SmartCommit), but I found that the splash screen won't close itself after the duration time. Can you have a look at this?

Code: https://github.com/Symbolk/SmartCommit/blob/c26819c134f693eb42f0aab9b537b49bab29f276/src/background.js#L131

Environment

• electron-splashscreen version: 0.3.4
• Electron version: 5.0.0
• OS: macOS 10.14.6

Steps to Reproduce

1. Clone the project and run the following command under the root directory of the cloned repo to install dependencies:

yarn install

2. Compiles and hot-reloads for development:

yarn electron:serve

Expected behaviour

The splash window shows itself and will close itself after 1500ms.

Actual behaviour

The splash window shows itself and won't close automatically.

readme's images aren't loading on the npm page. It appears that npm isn't converting my relative img paths to their github equivalent. It use to do this just fine for my demo.gif. In my research, relative paths have worked for some repos, but I'm not sure why/when they do. However, it appears that svg images never work unless you add ?sanitize=true to the link. I also didn't want to publish my images as part of the package to reduce the size when a user npm i.

After failing to get the relative links to work, I've done the following:

• Add full links to raw.githubusercontent.com
• added ?sanitize=true for my svg

Ideally, I could specify, for npm, files that are part of the package but not downloaded when installed (e.g., docs and readme images), then I could keep my relative paths and npm would be completely in charge of serving up a package's content rather than using github links.

Description

Transparant splash screen does not work on linux (does on win 10). Command line options are passed as follows:

[
  '/home/benn/datapaq5/target/release-builds/dp5-linux-x64/dp5',
  '--enable-transparent-visuals',
  '--disable-gpu'
]

Environment

• electron-splashscreen version: 1.0.0
• Electron version: 8.8.1(packaged using electon-packager)
• OS: Ubuntu 20.04

Steps to Reproduce

Create a dynamic splash screen with trasparant: true as shown below:

  const splash: Splashscreen.DynamicSplashScreen = Splashscreen.initDynamicSplashScreen({
        windowOpts: windowOptions,
        templateUrl: path.join(__dirname, '/../dynamic-splashscreen.html'),
        delay: 0, // force show immediately to better illustrate example
        splashScreenOpts: {
            height: 900,
            icon: __dirname + path.sep + '..' + path.sep + '..' + 
							  path.sep + 'src' + path.sep + 'assets' + 
						      path.sep + 'images' + path.sep + 'dp5-256.ico',
            width: 700,
            transparent: true,
            webPreferences: {
                nodeIntegration: true,
                backgroundThrottling: false
            },
        },
    });
  win = splash.main;

  return splash;
}

Expected behaviour

A transparant splashscreen

Actual behaviour

A splashscreen with a white background

The transparent option doesn't seem to work in windows 7. I'm using a separate html page to show a png image. This does work in windows 10.

I just want splash window appear with a fade-in animation and disappear with fade-out, how can I do this?
Any help is very appreciated. thanks.

• Fill in this template.
• Use a meaningful title.
• Respect our time by providing pertinent information and doing your due diligence.

Description

Browser window is null on close

Environment

• electron-splashscreen version: 1.0.0
• Electron version: 8.1.1
• OS:Ubunutu 20.04

Steps to Reproduce

start the application from the command line and control C before the main widow appears.

Expected behaviour

The application should close

Actual behaviour

You get a modal dialog displaying a javascript error. I believe that this is because of the close event calling mainwindow.close before the main window is set. It would be easy to put a null check on that call.

• Create custom icon for project
• Add icon to readme
• Add icon to examples
• Add animated gif of updated example to readme

• Create account with travis ci
• Add build badge to readme

Description

Occasionally, an error Object has been destroyed is thrown on window startup, preventing the application from launching:

Environment

• electron-splashscreen version: 0.3.4
• Electron version: 4.1.1
• OS: Manjaro Linux x86_64 (Kernel 5.0.1-1-MANJARO)

Steps to Reproduce

I have not yet been able to reproduce this consistently. The app in question is jgierer12/pocket-casts-linux.

Expected behaviour

The application launches correctly without errors.

Actual behaviour

The above Object has been destroyed error is thrown and the application does not launch.

Related issues

Related discussions are in jgierer12/pocket-casts-linux#3, jgierer12/pocket-casts-linux#4, and jgierer12/pocket-casts-linux#7

I tried to convert the code example in the README to JavaScript, but I cannot figure it out. Can someone please show me a JavaScript implementation?

in the example in the README one of the fields is splashScreenOptions when it should be splashScreenOpts, it's causing errors if it's set as splashScreenOptions

I wasn't sure if I should make a new issue for this, or include it in the 1.0.0 issue. Sorry if this is the wrong spot.

Anyway, I have a png image with a transparent background that shows as transparent as the application icon, and anywhere else I use it, with the exception of this splash screen. Instead it shows the transparent layer with the white/gray grid you see in photoshop.

Do you have any idea why that might be the case?

My splashscreen options:
splashScreenOpts: { width: 256, height: 256, transparent: true }