1.4.0 • Published 1 year ago

mica-electron-ts v1.4.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
1 year ago

npm

Mica Electron demo image

Mica Electron is a library to add Windows 11 Mica Effect in your Electron app.
This library is created by GregVido and forked by DeMineArchiver.
Mica Electron is now compatible with Windows 10!

Quickstart

$ npm install mica-electron-ts
import { MicaBrowserWindow, Theme, Mica } from "mica-electron-ts";
import path from "path";

app.on("ready", () => {
  const window = new MicaBrowserWindow({
    width: 800,
    height: 600,
    autoHideMenuBar: true
  });

  // Set window to use dark theme
  window.setTheme(Theme.Dark);
  // Set window effect to Mica
  window.setMicaEffect(Mica.Normal);

  window.loadFile(path.join(__dirname, "index.html"));
});
import { MicaBrowserWindow, Mica } from "mica-electon-ts";
// ...
window.setMicaEffect(Mica.Normal); // Change Mica effect to traditional
window.setMicaEffect(Mica.Acrylic); // Change Mica effect to acrylic
window.setMicaEffect(Mica.Tabbed); // Change Mica effect to tabbed
import { MicaBrowserWindow, Theme } from "mica-electon-ts";
// ...
window.setTheme(Theme.Auto); // Automatically determine theme
window.setTheme(Theme.Dark); // Change theme to dark
window.setTheme(Theme.Light); // change theme to light
import { MicaBrowserWindow } from "mica-electon-ts";
// ...
window.setTransparent(); // Transparent window
window.setBlur(); // Blurred window
window.setAcrylic(); // Acrylic window
import { MicaBrowserWindow, CornerRadius } from "mica-electon-ts";
// ...
window.setCornerRadius(CornerRadius.Default); // Default corner radius
window.setCornerRadius(CornerRadius.Sharp); // Sharp corners
window.setCornerRadius(CornerRadius.SmallRound); // Slightly rounded corners
window.setCornerRadius(CornerRadius.Round); // Fully rounded corners
win.setBorderColor('#f40b0b');  // Border color
win.setCaptionColor('#262626'); // Titlebar background color
win.setTitleTextColor('#fff');  // Title text color

Source Install / Manual Compilation

To compile from source it's easiest to use node-gyp:

$ npm install -g node-gyp

Now you can compile mica-electron-ts:

$ cd .\node_modules\mica-electron-ts\
$ node-gyp rebuild

Objects details

isWindows11: boolean constant showing if the OS is Windows 11.

FAQ

If you want use mica-electron-ts with 32 bits electron app, rebuild C++ script

$ cd .\node_modules\mica-electron-ts\
$ node-gyp rebuild --arch=ia32
$ cd ..\..\
$ electron-rebuild -f -w --arch=ia32 mica-electron-ts

Awesome applications using Mica Electron

1.4.0

1 year ago

1.3.0

1 year ago

1.2.8

1 year ago

1.2.7

1 year ago

1.2.6

1 year ago

1.2.5

1 year ago

1.2.3

1 year ago

1.2.2

1 year ago