Marcus Andrey Estudo
Read in English Biblioteca

Design systems · Passo 3 · 7 min de leitura

Composição em vez de configuração

Um componente com uma prop para cada caso fica mais difícil de usar a cada pedido. A composição dá aos times partes pequenas que se encaixam. Por que as props se acumulam, como o Ticket card do Harbour é montado com partes, os componentes, receitas e flocos de neve de Brad Frost, e onde a configuração ainda é a resposta certa.

Cada prop é um pedido que alguém fez uma vez, e o componente precisa honrá-lo para sempre. O Ticket card começou com quatro props. Depois o console quis o QR code na própria linha, o marketing quis destacar a cabine, e alguém precisou de um segundo botão. Um ano depois ele tem catorze, metade das combinações nunca foi vista junta, e a página de documentação virou um muro. Existe um jeito mais tranquilo de crescer: dar partes aos times, não interruptores.

O que você vai conseguir fazer depois de ler:

  • Reconhecer um componente que está crescendo por configuração, e quanto isso custa
  • Reconstruí-lo com partes menores que se compõem
  • Diferenciar um componente do sistema de uma receita e de um floco de neve
  • Decidir quando uma prop é o certo, e quando é um slot ou uma parte nova

1. Dois jeitos de construir o mesmo card

Configuração: um componente, uma prop para cada caso

<TicketCard
  route="Kestrel Bay → Ilha de Mara"
  status="on-time"
  showStatus={true}
  departure="09:40"
  duration={50}
  passengers="2 adultos"
  vehicle={null}
  showVehicle={false}
  primaryLabel="Ver bilhete"
  secondaryLabel="Pedir reembolso"
  secondaryVariant="ghost"
  compact={false}
  showQrInline={false}   // criada para o console
  highlightCabin={true}  // criada para uma campanha
/>

14 props, e contando. Cada tela nova acrescenta uma. Ninguém sabe quais combinações funcionam, e a documentação não consegue mostrar todas.

Composição: partes pequenas que se encaixam

  • Card
  • Card.Header
  • Heading · Badge
  • Card.Body
  • DepartureLine · DetailList
  • Card.Actions
  • Button · Button
<Card>
  <Card.Header>
    <Heading>Kestrel Bay → Ilha de Mara</Heading>
    <Badge tone="success">No horário</Badge>
  </Card.Header>
  <Card.Body>…</Card.Body>
  <Card.Actions>
    <Button size="compact">Ver bilhete</Button>
  </Card.Actions>
</Card>

Cada parte tem três ou quatro props. Um caso novo é um novo arranjo das mesmas partes, não uma prop nova.

O mesmo Ticket card construído de dois jeitos. Na configuração, o componente conhece todos os casos; na composição, o sistema entrega as partes e o time de produto as organiza. A versão composta é o que Brad Frost chama de receita (recipe): um arranjo fixo de componentes do sistema que um produto reutiliza.

Configuração é um componente que conhece todos os casos e expõe uma prop para cada um. É fácil começar: um import, preencher os campos. Fica mais difícil a cada pedido, porque cada prop nova multiplica as combinações, e o código do componente se enche de if para telas que ele nunca deveria conhecer.

Composição é ter componentes pequenos que se encaixam: um Card com Header, Body e uma área de Actions, e o Heading, o Badge e os Buttons que vão dentro deles. Cada parte tem poucas props. Um caso novo é um arranjo novo, não uma prop nova.

A documentação do React descreve a segunda abordagem numa frase: um componente que recebe children tem um "buraco" que o componente pai pode preencher com qualquer JSX (React, Passing JSX as children). Os slots do Figma, de Variantes, propriedades e slots, são a mesma ideia na ferramenta de design.


2. Componentes, receitas e flocos de neve

Brad Frost propõe um vocabulário que ajuda a decidir onde cada peça mora (Frost, Design system components, recipes, and snowflakes, 2021):

A definição de Frost Na Tidewater
Componente do design system "compartilhado, independente de conteúdo e de contexto, feito para o máximo de reúso" Card, Badge, Button, Heading: no Harbour
Receita (recipe) "composições específicas de componentes do design system" usadas de forma consistente num produto Ticket card: Card + Badge + Button, do app de reservas
Floco de neve (snowflake) componentes únicos, necessários para construir um produto, mas que não são reutilizados de verdade O mapa do convés para escolher a cabine, numa tela só

O exemplo de floco de neve do próprio Frost vem de uma companhia aérea: um componente Seat que só fazia sentido na tela de escolha de assento. Um ferry tem a mesma coisa.

Isso muda a pergunta "o Ticket card deve estar no Harbour?". A resposta é: as partes estão; o card é uma receita. O Harbour publica Card, Badge e Button, e receitas documentadas que mostram como os times os montam. O app de reservas é dono do próprio Ticket card e pode mudá-lo sem esperar uma release do Harbour.


3. Onde a configuração ainda é a certa

Composição nem sempre é melhor. Algumas coisas devem ser uma lista fechada, de propósito:

  • Significado e importância. variant="danger" deve ser uma prop com quatro valores, não um slot onde qualquer pessoa coloca qualquer cor.
  • Tamanho e densidade. Uma escala fixa, vinda dos tokens.
  • Comportamento que o sistema precisa garantir. O foco num diálogo, as regras de teclado de um combobox. Isso fica dentro do componente, onde os times não conseguem quebrar (veja Componentes acessíveis).

Uma regra útil: configure o que precisa ser consistente, componha o que precisa ser flexível. A variante do Button é configurada; o corpo do Card é composto.


4. Sinais de que um componente precisa ser dividido

  • Pares de booleanas: showStatus e status, showVehicle e vehicle. Os dados já dizem se há algo para mostrar.
  • Props com nome de tela ou de time: consoleMode, campaignHighlight. É uma receita escondida no sistema.
  • Props que só funcionam juntas: secondaryLabel precisa de secondaryVariant, que precisa de secondaryOnClick. É um Button aninhado querendo sair.
  • Uma página de documentação que não consegue mostrar todas as combinações.
  • Mais desvinculações no Figma. As pessoas desvinculam quando o componente não faz o que elas precisam. O Figma observa que os slots ajudam a reduzir os componentes desvinculados, para que as instâncias continuem recebendo atualizações (Figma Help, slots).

Quando você vir dois ou três desses sinais, divida: encontre as partes, dê a cada uma uma API pequena e publique o componente antigo como uma receita feita com elas.


5. Mantendo a composição consistente

O risco da composição é o oposto do da configuração: tanta liberdade que cada time monta o card de um jeito. O Harbour usa três proteções:

  1. Receitas documentadas. A receita do Ticket card está no site de documentação, com o código e a versão do Figma. Copiar é mais fácil do que inventar.
  2. Limites nos slots. Instâncias preferidas e um número máximo de itens no Figma; no código, a área de Actions aceita só Buttons e avisa quando recebe outra coisa.
  3. Revisão, não policiamento. Uma receita nova usada por dois produtos é candidata a entrar no sistema. Essa conversa é a de Modelos de contribuição.

6. Erros comuns

  • Acrescentar uma prop para cada pedido em vez de perguntar quais são as partes.
  • Colocar receitas de produto na biblioteca do sistema, e depois precisar de uma release do sistema para mudar um produto.
  • Deixar tudo componível, até o que precisa ser consistente, como o significado de um botão.
  • Slots sem orientação, e cada time organiza as partes de um jeito.
  • Quebrar a API do componente antigo ao dividi-lo, em vez de mantê-lo como receita por um tempo (veja Descontinuação e breaking changes).

7. Vocabulário

Termo Significado
Configuração Mudar um componente por props, a partir de uma lista que o componente conhece
Composição Construir um componente com outros menores, colocados um dentro do outro
children No React, o conteúdo colocado entre as tags de um componente; o "buraco" dele
Receita Um arranjo fixo de componentes do sistema que um produto reutiliza
Floco de neve Um componente único para uma tela, sem intenção de reúso
Explosão de props Um componente com tantas props que ninguém sabe quais combinações funcionam

8. Experimente (sem ferramentas)

  1. Encontre o componente com mais props ou variantes num produto que você conhece.
  2. Liste as props. Marque os pares de booleanas, as props com nome de tela e as props que só funcionam juntas.
  3. Desenhe o componente como uma árvore de partes menores, como o lado direito da figura.

Perguntas para refletir: Quais props sumiriam se ele fosse composto? Quais precisam ficar, porque protegem a consistência?


9. Se você já pratica

  • Acompanhe o número de props por componente ao longo do tempo; uma subida constante é um aviso antecipado.
  • Publique as receitas numa seção própria da documentação, com donos nos times de produto.
  • No Figma, veja com que frequência cada componente é desvinculado, e comece a dividir pelo topo dessa lista.
  • Ao dividir, mantenha a API antiga como uma receita fina por um ciclo de releases, com um aviso de descontinuação.

Checklist

Para saber mais

Livros, cursos e vídeos para ir mais fundo

Os links dos livros são de afiliado da Amazon: como associado, recebo por compras qualificadas, sem custo a mais para você.

Relacionadas

Variantes, propriedades e slots · Componentes acessíveis · Anatomia e API de um componente · De componentes a padrões · Modelos de contribuição · Descontinuação e breaking changes

Salvo só neste dispositivo.

↑ ↓ para mover · Enter para abrir · Esc para fechar