Comentários
Como criar e personalizar plugins no Sketch
Editado 2 meses atrás por ExtremeHow Equipe Editorial
SketchPluginsPersonalizaçãoDesenvolvimentoExtensõesFerramentasFluxo de TrabalhoMelhoriasScriptingTerceiro
Tradução atualizada 2 meses atrás
Sketch é uma ferramenta de design popular que permite aos designers criar belos designs de interface do usuário. Uma das principais forças do Sketch é sua extensibilidade através de plugins. Plugins podem ajudar a automatizar tarefas, adicionar novas funcionalidades e adaptar melhor a funcionalidade do Sketch ao seu fluxo de trabalho de design. Este guia detalhado irá introduzi-lo ao processo de criação de plugins no Sketch e personalizá-los.
Entendendo o básico
Antes de mergulhar na criação de plugins, é importante entender o que são plugins e por que são úteis. Um plugin no Sketch é essencialmente um script que interage com a API do Sketch para executar certas tarefas. Isso pode variar de tarefas simples, como mudar cores, a tarefas complexas, como criar um componente de interface do usuário completo.
A API do Sketch permite que os desenvolvedores interajam com documentos, páginas, camadas e mais, tornando possível construir ferramentas poderosas. Essas ferramentas ajudam a simplificar os processos de design, economizando tempo e esforço.
Configurando seu ambiente
Antes de começar a criar plugins, você precisa configurar seu ambiente de desenvolvimento. Aqui estão os passos para começar:
- Instale o Sketch: Certifique-se de que você tenha a versão mais recente do Sketch instalada em seu computador. O Sketch está atualmente disponível para macOS.
- Configure um editor de texto: Um bom editor de texto é essencial para escrever código. Algumas opções populares são Visual Studio Code, Sublime Text e Atom. Escolha aquele com o qual você se sinta mais confortável.
- Familiarize-se com JavaScript: Os plugins do Sketch são escritos em JavaScript, portanto, uma compreensão básica de JavaScript é essencial. Aprender o básico da sintaxe JavaScript, variáveis, funções e objetos é um bom começo.
Criando um plugin simples no Sketch
Agora vamos passar para a criação de um plugin simples no Sketch. Este exemplo mostrará como criar um plugin que adiciona um retângulo vermelho ao seu documento do Sketch.
Passo 1: Crie sua pasta de plugin
Comece criando uma nova pasta com um nome significativo para seu plugin, como “RedRectanglePlugin”. Esta pasta conterá todos os arquivos que seu plugin precisa.
Passo 2: Crie o arquivo de manifesto
O arquivo manifest.json informa ao Sketch sobre o seu plugin. Ele contém informações como o nome do plugin, versão e o script que ele irá executar.
{
"name": "Red Rectangle Plugin",
"identifier": "com.example.redrectangleplugin",
"version": "1.0",
"description": "Um plugin simples do Sketch para adicionar um retângulo vermelho.",
"author": "Seu Nome",
"commands": [
{
"name": "Add Red Rectangle",
"identifier": "addRedRectangle",
"script": "./addRedRectangle.js"
}
]
}
Coloque o arquivo manifest.json dentro da sua pasta de plugins.
Passo 3: Escreva o script do plugin
Crie um novo arquivo JavaScript chamado addRedRectangle.js dentro da sua pasta de plugin. Este script adicionará um retângulo vermelho à página existente no Sketch. Aqui está um exemplo simples:
function onAddRedRectangle(context) {
var sketch = require('sketch/dom');
var document = sketch.getSelectedDocument();
var page = document.selectedPage;
// Crie um novo retângulo
var rectangle = new sketch.Rectangle({
parent: page,
frame: { x: 0, y: 0, width: 100, height: 100 },
style: { fills: [{ color: '#FF0000', fillType: 'Color' }] }
});
page.layers.push(rectangle);
}
module.exports = onAddRedRectangle;
Salve este script na sua pasta de plugins.
Passo 4: Instale e teste seu plugin
Para instalar seu plugin, siga estas etapas:
- Abra o Sketch.
- Vá para Plugins > Gerenciar Plugins...
- Clique no ícone de engrenagem e selecione Mostrar Pasta de Plugins.
- Copie sua pasta de plugin para a pasta de plugins mostrada.
- Reinicie o Sketch ou vá para Plugins > Executar Scripts > Recarregar Plugins.
- Seu plugin agora deve aparecer no menu de Plugins!
Teste: Abra qualquer documento no Sketch, vá para Plugins > Red Rectangle Plugin > Add Red Rectangle. Você deve ver um retângulo vermelho aparecer no seu canvas.
Personalizando seu plugin
Agora que você criou um plugin simples, vamos ver como você pode personalizá-lo ainda mais.
Adicionar configurações do usuário
Às vezes, você pode querer dar aos usuários a capacidade de configurar como um plugin funciona. Para isso, você pode criar uma interface de configuração usando as ferramentas integradas do Sketch.
function onAddRectangleWithSettings(context) {
var sketch = require('sketch/dom');
var UI = require('sketch/ui');
UI.getInputFromUser(
"Rectangle Size",
{ type: UI.INPUT_TYPE.string, initialValue: "100" },
(err, value) => {
if (err) { return; }
var document = sketch.getSelectedDocument();
var page = document.selectedPage;
var size = parseInt(value, 10);
var rectangle = new sketch.Rectangle({
parent: page,
frame: { x: 0, y: 0, width: size, height: size },
style: { fills: [{ color: '#FF0000', fillType: 'Color' }] }
});
page.layers.push(rectangle);
}
);
}
module.exports = onAddRectangleWithSettings;
Neste exemplo, quando você executar o plugin, ele perguntará ao usuário o tamanho preferencial do retângulo.
Usar uma biblioteca de terceiros
Às vezes, as APIs padrão do Sketch podem não ser suficientes para alcançar seu objetivo. Você pode querer usar bibliotecas JavaScript de terceiros para estender a funcionalidade.
Aqui está como você pode usar uma biblioteca de terceiros:
- Selecione uma biblioteca e baixe seu arquivo JavaScript.
- Inclua o arquivo na pasta do seu plugin.
- Use
require()para incluí-lo e usá-lo em seu script.
var _ = require('./lodash.min.js');
function main(context) {
var numbers = [1, 2, 3, 4, 5];
var doubled = _.map(numbers, function(n) {
return n * 2;
});
console.log(doubled);
}
module.exports = main;
Neste exemplo, estamos usando a biblioteca Lodash para dobrar um array de números.
Teste e depuração
Assim como em qualquer outro desenvolvimento de software, testes e depuração são muito importantes no desenvolvimento de plugins também. Aqui estão algumas dicas:
- Registro no console: Use
console.log()para imprimir variáveis e saídas no console, que pode ser visto no Sketch usando Plugins > Executar Script > Mostrar Ferramentas > Mostrar Console. - Divida o script: Separe o script em tarefas menores e mais gerenciáveis. Isso facilita descobrir onde estão os problemas.
- Dados fictícios: Use dados fictícios para testar a funcionalidade do seu plugin independentemente do ambiente do Sketch.
Publicando seu plugin
Uma vez que você esteja satisfeito com seu plugin, você pode querer compartilhar com a comunidade. Aqui está como você pode publicar seu plugin:
- Prepare a documentação: Crie um arquivo
README.mdcom instruções sobre como instalar e usar seu plugin. Forneça o código e explicações para qualquer configuração específica. - Escolha uma licença para seu código: Escolha uma licença apropriada para seu código. Muitos desenvolvedores usam a Licença MIT ou a Licença Apache.
- Hospede seu plugin: Use uma plataforma como o GitHub para hospedar o código-fonte do seu plugin. Isso o torna acessível a outros e dá a eles uma chance de contribuir.
- Submeta ao diretório de plugins do Sketch: Você pode submeter seu plugin ao diretório de plugins do Sketch para mais visibilidade. Certifique-se de seguir as diretrizes do diretório.
Conclusão
Criar e personalizar plugins no Sketch pode estender muito sua funcionalidade e adaptá-la às suas necessidades específicas. Ao seguir este guia, você aprendeu a configurar seu ambiente, criar um plugin básico, personalizá-lo, usar bibliotecas de terceiros e até mesmo publicar suas criações. Com prática e criatividade, você pode fazer contribuições significativas para o ecossistema de plugins do Sketch, tornando os processos de design mais eficientes e inovadores. Feliz programação!
Se você encontrar algo errado com o conteúdo do artigo, você pode