Ir para o conteúdo principal

BaseWindowConstructorOptions Object

  • width Inteiro (opcional) - A largura da janela em pixels. O padrão é 800.
  • height Inteiro (opcional) - A altura da janela em pixels. O padrão é 600.
  • x Inteiro (opcional) - (obrigatório se y for usado) O deslocamento da janela com relação à esquerda da tela. O padrão é centralizar a janela.
  • y Inteiro (opcional) - (obrigatório se x for usado) O deslocamento da janela com relação ao topo da tela. O padrão é centralizar a janela.
  • useContextSize booleana (opcional) - A width e a height serão usadas como o tamanho da página web, o que significa que o tamanho da janela em si irá conter o tamanho da página e será um pouco maior. O padrão é false.
  • center booleana (opcional) - Mostra a janela no centro da tela. O padrão é false.
  • minWidth Inteiro (opcional) - A largura mínima da janela. O padrão é 0.
  • minHeight Inteiro (opcional) - A altura mínima da janela. O padrão é 0.
  • maxWidth Inteiro (opcional) - A largura máxima da janela. O padrão é sem limite.
  • maxHeight Inteiro (opcional) - A altura máxima da janela. O padrão é sem limite.
  • resizable booleana (opcional) - Se a janela é redimensionável. O padrão é true.
  • movable booleana (opcional) macOS Windows - Se a janela pode ser movida. Não é implementado no Linux. O padrão é true.
  • minimizable booleana (opcional) macOS Windows Se a janela é minimizável. Não é implementado no Linux. O padrão é true.
  • maximizable booleana (opcional) macOS Windows - Se a janela é maximizável. Não é implementado no Linux. O padrão é true.
  • closable booleana (opcional) macOS Windows - Se a janela pode ser fechada. Não é implementado no Linux. O padrão é true.
  • focusable booleana (opcional) - Se a janela pode ser focada. O padrão é true No Windows, definir focusable: false também implica em skipTaskbar: true. No Linux, definir focusable: false faz a janela parar de interagir com o wm, então a janela sempre ficará no topo em todos os ambientes de trabalho.
  • alwaysOnTop booleana (opcional) - Se a janela deve sempre ficar acima de outras janelas. O padrão é false. Not supported on Wayland (Linux).
  • fullscreen booleana (opcional) - Se a janela deve aparecer em tela cheia. Se explicitamente definida como false o botão de tela cheia será oculto e desabilitado no macOS. O padrão é false.
  • fullscreenable booleana (opcional) - Se a janela pode ser posta em modo detela cheia. No macOS, também define se o botão de maximizar/zoom pode alternar o modo de tela cheia ou maximizar a janela. O padrão é true.
  • simpleFullscreen booleana (opcional) macOS - Usa a versão de tela cheia anterior à versão Lion no macOS. O padrão é false.
  • skipTaskbar booleana (opcional) macOS Windows - Se a janela deve aparecer na barra de tarefas. O padrão é false.
  • hiddenInMissionControl booleana (opcional) macOS - Se a janela deve ser oculta quando o usuário entra no modo mission control.
  • kiosk booleana (opcional) - Se a janela está em modo quiosque. O padrão é false.
  • name string (opcional) - Um identificador único da janela, usado internamente pelo Electron para habilitar recursos como persistência de estado. Cada janela deve ter um nome distinto. Pode ser reutilizado depois que a janela correspondente é destruída. Um erro é lançado quando o nome já está em uso. Não é um título visível mostrado aos usuários na barra de título.
  • windowStatePersistence (WindowStatePersistence | boolean) (opcional) - Configura ou habilita a persistência de estado de janelas (posição, tamanho, estado de maximização, etc.) across application restarts. Não tem efeito se o name da janela não for definido. Automaticamente desabilitada se não houver um monitor disponível. Experimental
  • title string (opcional) - Título padrão da janela. O padrão é "Electron". Se a tag HTML <title> for definida no arquivo HTML carregado por loadURL(), esta propriedade será ignorada.
  • icon (NativeImage | string) (opcional) - O ícone da janela. No Windows é recomendado que se use ícones ICO para obter melhores efeitos visuais, você também pode deixá-lo indefinido para que o ícone do executável seja usado.
  • show booleana (opcional) - Se a janela pode ser mostrada quando é criada. O padrão é true
  • frame booleana (opcional) - Defina false para criar uma janela frameless. O padrão é true.
  • parent BaseWindow (opcional) - Defina a janela pai. O padrão é null.
  • modal booleana (opcional) - Se esta janela é modal. Só funciona se a janela for uma janela filha. O padrão é false.
  • appShim AppShimHost (opcional) macOS Experimental - Cria uma janela nativa no processo do shim deste aplicativo, para que ele pertença ao ícone da Dock do shim e não do seu aplicativo. Consulte AppShimHost para ver quais funções são dadas à janela.
  • acceptFirstMouse booleana (opcional) macOS - Se clicar em uma janela inativa também irá clicar em seu conteúdo web. O padrão é false no macOS. Esta opção não é configurável em outras plataformas.
  • disableAutoHideCursor booleana (opcional) - Se o cursor deve ser oculto quando se estiver digitando. O padrão é false.
  • autoHideMenuBar booleana (opcional) Linux Windows - Auto-oculta a barra de menu a menos que a tecla Alt esteja pressionada. O padrão é false.
  • enableLargerThanScreen booleana (opcional) macOS - Permite que a janela seja redimensionada maior que a tela. Apenas relevante para o macOS, visto que outros sistemas operacionais permitem janelas maiores que a tela por padrão. O padrão é false.
  • backgroundColor string (opcional) - A cor de fundo da janela em Hex, RGB, RGBA, HSL, HSLA ou no formato de uma cor nomeada de CSS. Há suporte de alpha em formato #AARRGGBB se transparent for definida como true. O padrão é #FFF (branco). Consulte win.setBackgroundColor para mais informações.
  • hasShadow booleana (opcional) - Se a janela deve ter sombra. O padrão é true.
  • opacity número (opcional) macOS Windows - Define a opacidade inicial da janela, entre 0.0 (completamente transparente) e 1.0 (completamente opaca). Só é implementado no Windows e no macOS.
  • darkTheme booleana (opcional) - Força o uso do tema escuro na janela, só funciona em alguns ambientes desktop GTK+3. O padrão é false.
  • transparent booleana (opcional) - Torna a janela transparente. O padrão é false. No Windows, não funciona a não ser que a janela seja frameless. Quando você adiciona uma View a uma BaseWindow, você precisará chamar view.setBackgroundColor com uma cor de fundo transparente nessa view para que sua cor de fundo seja também transparente.
  • type string (opcional) - O tipo de janela, no padrão é uma janela normal. Veja mais sobre isso abaixo.
  • visualEffectState string (opcional) macOS - Especifica se a aparência material deve refletir o estado de atividade da janela no macOS. Deve ser usado com a propriedade vibrancy. Possible values are:
    • followWindow - O plano de fundo deve automaticamente aparecer ativo quando a janela estiver ativa, e inativo quando ela não estiver. This is the default.
    • active - O plano de fundo deve sempre aparecer ativo.
    • inactive - O plano de fundo deve sempre aparecer inativo.
  • titleBarStyle string (opcional) - O estilo da barra de título da janela. O padrão é default. Possible values are:
    • default - Resulta em uma barra de título padrão no macOS e no Windows respectivamente.
    • hidden - Resulta em uma barra de título oculta e uma janela em que o conteúdo ocupa todo seu tamanho. No macOS, a janela ainda deve ter os controles padrão de janelas (as "luzes de semáforo") no topo esquerdo. No Windows e no Linux, quando combinada com titleBarOverlay: true ativará o Overlay de Controles de Janela (veja titleBarOverlay para mais informações), caso contrário nenhum controle de janela será exibido.
    • hiddenInset macOS - Resulta em uma barra de título com uma aparência alternativa onde os botões semáforo ficam levemente mais dentro da borda da janela.
    • customButtonsOnHover macOS - Resulta em uma barra de título oculta e uma janela em que o conteúdo ocupa todo seu tamanho, e os botões de semáforo aparecerão quando o cursor passar no topo esquerdo da janela. Nota: Esta opção é experimental atualmente.
  • titleBarOverlay Object | booleana (opcional) - Quando se estiver usando uma janela frameless em conjunto com win.setWindowButtonVisibility(true) no macOS ou usando um titleBarStyle no qual os controles de janela padrão ("luzes de semáforo" no macOS) ficam visíveis, esta propriedade habilita o Overlay de Controles de Janela das APIs Javascript e as Variáveis de Ambiente CSS. Definir true resultará em um overlay com cores padrão do sistema. O padrão é false.
    • color String (opcional) Windows Linux - A cor CSS do Overlay de Controles de Janela quando habilitado. O padrão é a cor do sistema.
    • symbolColor String (opcional) Windows Linux - A cor CSS dos símbolos no Overlay de Controles de Janela quando habilitado. O padrão é a cor do sistema.
    • height Integer (optional) - The height of the title bar and Window Controls Overlay in pixels. O padrão é a altura do sistema.
  • accentColor booleana | string (opcional) Windows - A cor de destaque da janela. Por padrão, segue a preferência do usuário nas Configurações do Sistema. Defina como false para desabilitar explicatamente, ou defina a cor em Hex, RGB, RGBA, HSL, HSLA ou no formato de uma cor nomeada do CSS. Valores alpha serão ignorados.
  • trafficLightPosition Point (opcional) macOS - Define uma posição personalizada para os botões de semáforo em janelas frameless.
  • roundedCorners booleana (opcional) - Se a janela frameless deve ter cantos arrendodados. O padrão é true. Em versões do Windows anteriores ao Windows 11 Build 22000 esta propriedade não tem efeito, e janelas frameless não terão cantos arrendondados. No Linux, os cantos arredondados só são desenhados quando o ambiente desktop tem suporte a decorações client-side.
  • thickFrame booleana (opcional) Windows - Usa o estilo WS_THICKFRAME em janelas frameless no Windows, que adiciona o frame de janela padrão. Definir como false removerá a sombra e as animações da janela, e desabilitará o redimensionamento de janela através do arrasto dos seus cantos. O padrão é true.
  • vibrancy string (opcional) macOS - Adiciona um tipo de efeito vibrante à janela, somente no macOS. Pode ser appearance-based, titlebar, selection, menu, popover, sidebar, header, sheet, window, hud, fullscreen-ui, tooltip, content, under-window, ou under-page.
  • backgroundMaterial string (opcional) Windows - Define o material de fundo da janela desenhado pelo sistema, incluindo atrás da área fora do aplicativo. Pode ser auto, none, mica, acrylic ou tabbed. Consulte win.setBackgroundMaterial para mais informações.
  • zoomToPageWidth boolean (opcional) macOS - Controla o comportamento no macOS quando se clica nas opções do botão semáforo verde na barra da janela ou ao clicar no item do menu Window > Zoom. Se true, a janela aumentará para a largura preferida da página web quando aumentada, false fará com que ela aumente para a largura da tela. Isto também afetará o comportamento quando maximize() for chamado diretamente. O padrão é false.
  • tabbingIdentifier string (opcional) macOS - O nome do grupo de abas, quer permite abrir a janela como uma aba nativa. Janelas com o mesmo identificador serão agrupadas juntas. Isto também adiciona um novo botão de aba nativo à barra de abas da sua janela e permite que seu app e janela recebam o evento new-window-for-tab.

Ao definir o tamanho mínimo ou máximo com minWidth/maxWidth/ minHeight/maxHeight, apenas restringe os usuários. Não vai te impedir de passar um tamanho que não siga os limites de tamanho para setBounds/setSize ou para o construtor de BrowserWindow.

Os valores possíveis e comportamentos da opção type dependem da plataforma. Possible values are:

  • No Linux, os possíveis tipos são desktop, dock, toolbar, splash, notification.
    • O tipo desktop põe a janela no nível de janela de fundo desktop (kCGDesktopWindowLevel - 1). Dito isso, perceba que uma janela desktop não receberá eventos de foco, de teclado, ou de mouse. Você ainda pode usar globalShortcut para receber dados com moderação.
    • O tipo dock cria uma janela com comportamento estilo dock.
    • O tipo toolbar cria uma janela com aparência de barra de ferramentas.
    • O tipo splash se comporta de uma maneira específica. Não é arrastável, mesmo se a estilização CSS do corpo da janela conter -webkit-app-region: drag. Este tipo é geralmente usado em telas de inicialização.
    • O tipo notification cria uma janela que se comporta como uma notificação do sistema.
  • No macOS, os possíveis tipos são desktop, textured, panel.
    • O tipo textured adiciona uma aparência de gradiente metálico. Esta opção é obsoleta.
    • O tipo desktop põe a janela no nível de janela de fundo desktop (kCGDesktopWindowLevel - 1). Note que essa janela desktop não receberá eventos de foco, de teclado ou de mouse, mas você pode usar globalShortcut para receber dados com moderação.
    • O tipo panel permite que a janela flutue no topo de aplicativos em tela cheia adicionando a máscara de estilo NSWindowStyleMaskNonactivatingPanel, normalmente reservado para o NSPanel, em tempo de execução. Além disso, a janela aparecerá em todos os espaços (desktops).
  • No Windows, o tipo possível é toolbar.