Grafic-CM

Biblioteca Node.js simples para criar janelas Electron.

Documentacao em HTML: docs/index.html

Para abrir no navegador pelo terminal:

grafic-cm doc

Instalacao

npm install grafic-cm electron

electron continua como peerDependency, entao ele precisa existir no projeto consumidor.

Se voce quiser empacotar pelo comando grafic-cm empacotar, instale tambem:

npm install -D electron-builder

Uso com ESM

import grafic, { janela, electron } from 'grafic-cm';

janela({
  app_nome: 'Minha App',
  tela_cheia: true,
  menu_Padrao: false,
  altura: 600,
  largura: 800,
  app: './index.html',
  icone: './image.png'
});

const { ipcMain } = electron;

Voce tambem pode usar o export default:

import grafic from 'grafic-cm';

grafic.janela({
  app_nome: 'Minha App',
  app: './index.html',
  icone: './image.png'
});

Opcoes da janela

• tela_cheia: boolean (default: false)
• menu_Padrao: boolean (default: true; se false, remove o menu)
• altura: number (default: 600)
• largura: number (default: 800)
• app: string (caminho para o HTML)
• app_nome: string (nome da app e titulo da janela)
• icone: string (caminho para o icone da janela; caminhos relativos sao resolvidos a partir de process.cwd())

Sobre o icone no app compilado

icone define o icone usado em runtime pela janela do Electron e tambem pode ser aplicado ao dock no macOS.

Para o icone final do executavel empacotado, ainda e necessario configurar a sua ferramenta de build, como electron-builder, electron-forge ou equivalente.

CLI

Ao instalar o pacote, o comando grafic-cm fica disponivel no terminal do projeto.

grafic-cm empacotar

Para abrir a documentacao HTML no navegador padrao:

grafic-cm doc

Se nenhuma plataforma for informada, o build segue o sistema operacional atual.

Voce tambem pode repassar argumentos direto para o electron-builder:

grafic-cm empacotar --win
grafic-cm empacotar --linux
grafic-cm empacotar --mac
grafic-cm empacotar --mac --publish never

Atalhos mais comuns:

• grafic-cm empacotar --win: build para Windows
• grafic-cm empacotar --linux: build para Linux
• grafic-cm empacotar --mac: build para macOS

Se preferir sem instalar globalmente, funciona tambem com:

npx grafic-cm empacotar

Exportacoes

• default: objeto grafic
• janela: funcao para abrir a janela
• electron: instancia do modulo electron

Licenca

MIT