Componentes

@pantoken/components fornece estilos de componentes baseados em classes construídos a partir dos tokens Instructure. Importe a folha de estilos e marque seu markup — nenhum framework necessário.

import "@pantoken/components/components.css";

[!NOTA] Prefere elementos personalizados? @pantoken/web-components embrulha esses mesmos estilos como <instui-button>, <instui-alert>, <instui-badge>, <instui-avatar>, <instui-progress> e mais — veja o mapa do pacote.

Convenções

As convenções de CSS neste pacote são baseadas em uma versão modificada de RSCSS.

Os modificadores são chave-valor — -<prop>-<val>, alinhados aos nomes de props do InstUI — então se leem por si mesmos: -color-secondary, -size-sm, -shape-circle, -icon-plus. Props booleanas são apenas o nome da prop, onde a presença significa true (-has-shadow, -clickable); um booleano com padrão ligado invertido desliga (-without-background, -without-border). Tamanhos aceitam grafias curtas e longas (-size-sm = -size-small). Quando um nome diverge do InstUI, a classe semântica do InstUI ainda funciona mas é obsoleta (ex.: -variant-info → use -color-info).

Exemplo

Componente React do Instructure UI:

<Alert variant="success" transition="fade" hasShadow renderCustomIcon={megaphone}>
  This is the alert content.
</Alert>

componentes pantoken:

<!-- direct instui props -->
<div
  class="instui-alert -variant-success instui-transition -fade-entered -has-shadow -render-custom-icon-megaphone"
>
  This is the alert content.
</div>

<!-- normalized color/icon props -->
<div
  class="instui-alert -color-success instui-transition -fade-entered -has-shadow -icon-megaphone"
>
  This is the alert content.
</div>

Para a prop timeout do InstUI, defina a propriedade customizada sem unidade --timeout em milissegundos e carregue a interação Alert. Um valor positivo agenda o descarte; 0 (o padrão) mantém o alerta no lugar. Adicione as classes instui-transition -fade-entered da utilidade transition para o fade do InstUI; omita-as para remoção imediata. A interação impulsiona o estado -fade-exiting e dispara um evento cancelável e em bubble dismiss antes da remoção, para que uma aplicação possa chamar preventDefault() para manter o alerta montado.

<link
  rel="stylesheet"
  href="https://cdn.jsdelivr.net/npm/@pantoken/components/dist/utilities.css"
/>
<div
  class="instui-alert -color-info instui-transition -fade-entered"
  style="--timeout: 5000"
  role="alert"
>
  This alert dismisses after five seconds.
</div>
<script src="https://cdn.jsdelivr.net/npm/@pantoken/interactions/dist/alert.iife.js"></script>

Barras de progresso aceitam escalas arbitrárias através de --min (0 por padrão), --value e --max (100 por padrão), com alias obsoletos --value-now e --value-max. Adicione -should-animate para aplicar a transição de meio segundo do InstUI sempre que um valor mudar. .value fica ao lado de .bar como filho da raiz; adicione -render-value-inside para renderizá-lo sobre a trilha, alinhado ao início, em vez disso (estilize para legibilidade contra a cor do medidor). Use um <progress> nativo para um intervalo baseado em zero e <meter> quando o mínimo for diferente de zero; os web components selecionam entre eles automaticamente a partir do atributo min. O InstUI não tem estado indeterminado, então um <progress> sem seu atributo value é um palpite específico do pantoken: progress-bar anima .bar como um segmento deslizante e progress-circle gira seu anel em um arco fixo, ambos escondendo .value.

<label>
  Uploading Document:
  <progress
    class="instui-progress -color-brand -should-animate"
    style="--value: 40; --max: 60"
    value="40"
    max="60"
  >
    40 of 60
  </progress>
</label>

Círculos de progresso aceitam as mesmas escalas arbitrárias através de --min, --value e --max. --value-now e --value-max permanecem como aliases funcionais obsoletos. Adicione -should-animate e carregue o bundle de interação focada para reproduzir a animação de montagem do InstUI; --animation-delay é um atraso sem unidade em milissegundos. As grafias obsoletas -should-animate-on-mount e -shold-animate-on-mount permanecem aliases funcionais.

<label for="upload-progress">Uploading Document</label>
<progress
  id="upload-progress"
  class="instui-progress-circle -should-animate"
  style="--value: 40; --max: 60; --animation-delay: 500"
  value="40"
  max="60"
>
  40 of 60
</progress>
<script src="https://cdn.jsdelivr.net/npm/@pantoken/interactions/dist/progress-circle.iife.js"></script>

Prefixo de classe

Toda classe é namespaceada como instui- por padrão. Construa uma folha de estilos com seu próprio prefixo — ou nenhum — passando prefix a qualquer builder. Qualquer valor falsy (null, undefined, "", ou omitindo-o) remove o prefixo inteiramente, para que você possa autorar class="heading -level-h1" em vez de class="instui-heading -level-h1":

import { componentsCss } from "@pantoken/components";

componentsCss({ prefix: "ui" }); // .ui-button
componentsCss({ prefix: null }); // .button, .alert — no prefix

Os modificadores prefixados com traço (.-color-secondary, .-level-h1) permanecem inalterados de qualquer modo. As folhas de estilo fornecidas pelo pacote mantêm o prefixo instui.

Base

base.css é um reset opt-in que define padrões globais do documento a partir dos tokens: box-sizing, um reset body, a superfície da página, cor e fonte de texto base, color-scheme (para que os tokens light-dark() e controles nativos acompanhem o tema), e um link base. Carregue-o uma vez, antes das folhas de componentes e prose, quando o pantoken for dono da página.

import "@pantoken/components/base.css";
import "@pantoken/components/components.css";

Ignore-o quando estiver incorporando componentes em um host que já tema seu próprio html e body — o reset pinta a superfície da página, então você não quer que ele dispute com o host. Tudo o que ele define usa seletores de baixa especificidade :where(), então suas próprias regras sempre vencem.

base.css aplica a fonte da marca (font-family: var(--instui-font-family-base), com fallbacks do sistema); para carregá-la, importe o opt-in fonts.css — regras @font-face para Atkinson Hyperlegible Next, apontando para os woff2s fornecidos no pacote. É separado porque as fontes são ~350 kB e auto-hospedar fontes é uma escolha deliberada.

import "@pantoken/components/base.css"; // applies the font (falls back to system without fonts.css)
import "@pantoken/components/fonts.css"; // loads the Atkinson Hyperlegible Next woff2s

Conteúdo para leitores de tela

Há uma mensagem oculta após esta frase.Apenas leitores de tela anunciam isto.

<span class="instui-screen-reader-content">Only screen readers announce this.</span>

.instui-screen-reader-content esconde um elemento visualmente enquanto o mantém na árvore de acessibilidade — para labels e textos de status que a tecnologia assistiva deve ler mas o design não deve mostrar.

Utilitários

utilities.css é uma camada opt-in de classes transversais: um primitivo View, espaçamento na escala de tokens, e sobrescritas semânticas de cor. Diferente das classes de componentes -modifier, estas usam um duplo traço (--mod) para que nunca colidam com nomes de modificadores próprios de um componente, e aplicam-se a qualquer elemento — isolado, ou composto sobre um componente.

import "@pantoken/components/utilities.css";

Superfície accent-blue com texto on-color.

Centralizado com mx-auto.

<div class="instui-view --bg-accent-blue --text-on-color --p-md">…</div>
<div class="instui-view --bg-muted --p-sm --mx-auto">…</div>

View — .instui-view é o View do InstUI. É a base sobre a qual aplica-se espaçamento e cor, e carrega modificadores chave-valor para suas próprias props visuais para que você não precise recorrer a utilitários: -background-* (suas superfícies), -border-radius-{small,medium,large,circle,pill}, -border-width-{small,medium,large} + -border-color-*, -shadow-{resting,above,topmost}, -display-*, -position-*, -overflow-x-*/-overflow-y-*, e -cursor-* — estes são os modificadores de traço-único de view, não relacionados aos utilitários de duplo traço abaixo. Props de valor livre (largura/altura/inset) permanecem como estilos inline; margin/padding usam os utilitários de espaçamento.

Espaçamento — classes por lado na escala de espaçamento. Leia-as como {m|p}{side}-{step}: m para margem ou p para padding (ou as palavras completas margin/padding), um lado lógico opcional, então um passo. Assim .--m-lg e .--margin-lg são equivalentes, assim como .--pt-md e .--paddingt-md.

• Lados: none (todos), t/b (início/fim de bloco), s/e (início/fim inline), x/y (eixo inline/block). Lados lógicos permanecem corretos em layouts RTL.
• Passos: 0, 2xs, xs, sm, md, lg, xl, 2xl, mais auto apenas para margin.

Compose-os para o atalho margin="small auto large" do InstUI: class="--mt-sm --mx-auto --mb-lg".

Cor — sobrescritas semânticas que permanecem na paleta: .--bg-<name> (background), .--text-<name> (cor do texto), e .--border-<name> (cor da borda). Cada <name> é um token de cor semântico — as intenções (base, brand, muted, success, warning, error, info, inverse, on-color, strong, …) mais a paleta accent-* (accent-blue, accent-green, e assim por diante). Um nome só existe se o token existir nessa família, então text-brand não é uma classe — texto não tem token de marca. Não há como alcançar um primitivo ou um hex arbitrário, e cada sobrescrita segue o tema.

Famílias de tokens — cada família "um token, uma propriedade" recebe uma classe por token, nomeada pelo token. Componha livremente:

• .--font-family-heading, .--font-family-code, … → font-family
• .--font-weight-body-strong, .--font-weight-interactive, … → font-weight
• .--line-height-* → line-height
• .--border-radius-md, .--border-radius-full, … → border-radius
• .--border-width-sm/-md/-lg → border-width
• .--opacity-base, .--opacity-disabled → opacity
• .--elevation-resting/-above/-topmost (e -depth1…-card) → box-shadow

Cada uma define apenas sua propriedade, então border-width/border-radius precisam de uma cor border-* e um estilo de borda para realmente desenhar uma borda. Estas usam o nome completo do token (.--border-radius-md), enquanto os helpers de cor e espaçamento acima usam aliases curtos (.--bg-brand, .--mt-lg) — os aliases são atalhos ergonômicos; as classes de token são literais e exaustivas.

Layout — .--display-<value> (block, inline-block, inline, flex, inline-flex, none) e .--text-align-<value> (start, center, end, justify) cobrem as props transversais display e textAlign do InstUI (View, Button, Metric, Tabs, …) como classes compostas — portanto não são modificadores por componente.

Toda classe de duplo traço vence a cascata deterministically sobre um modificador de componente de mesmo nome e traço-único, independentemente da ordem de importação das folhas — veja Convenções de authoring para o mecanismo.

Tudo aqui é CSS puro guiado pelos tokens --instui-*, então acompanha o InstUI através da camada de tokens. Veja a referência da API para componentsCss e os builders por componente.

Sobreposições: dialog e popover

Os componentes de overlay utilizam primitivas nativas da plataforma, então comportam-se de forma acessível com pouco ou nenhum JavaScript.

Modal — coloque .instui-modal em um <dialog> nativo. Ele ganha trap de foco, fechamento via Esc, e um ::backdrop gratuitamente; o backdrop é escurecido com o mesmo token --instui-component-mask-background-color que .instui-mask (adicione -blur para esbranquiçar). Abra e feche com invoker commands — sem script:

<button class="instui-button" command="show-modal" commandfor="dlg">Open</button>
<dialog id="dlg" class="instui-modal">
  <div class="header">Title</div>
  <div class="body">…</div>
  <div class="footer">
    <button class="instui-button" command="close" commandfor="dlg">Close</button>
  </div>
</dialog>

Context view / popover — coloque .instui-context-view em um elemento [popover] e alterne com popovertarget. Ele fica na camada superior e fecha com clique externo ou Esc, novamente sem script:

<button class="instui-button" popovertarget="cv">Details</button>
<div id="cv" popover class="instui-context-view">…</div>

Layout de gaveta (drawer) — coloque .instui-drawer-layout em uma raiz de layout com filhos .tray e .content. Adicione o atributo open (ou -open) para revelar a bandeja, e use placement="end" (ou -placement-end) para ancorá-la ao lado inline-end — o posicionamento resolve através de propriedades lógicas inset-inline-*/flex-direction, então inverte automaticamente sob dir="rtl" sem regras adicionais. O bundle de interação focada adiciona roteamento de comandos Invoker e alterna o modo overlay (should-overlay-tray) quando a largura cruza --drawer-layout-min-width (padrão --instui-breakpoints-sm, depois 30rem):

<button class="instui-button" command="--toggle" commandfor="drawer">Toggle panel</button>
<div id="drawer" class="instui-drawer-layout" open>
  <aside class="tray">…</aside>
  <main class="content" role="region">…</main>
</div>
<script src="https://cdn.jsdelivr.net/npm/@pantoken/interactions/dist/drawer-layout.iife.js"></script>

Mask — .instui-mask serve para overlays em fluxo (um spinner sobre um cartão); o ::backdrop de um modal cobre o caso do modal.

Ambos os padrões também são embrulhados como elementos custom comportamentais em @pantoken/web-components: <instui-modal open> (um <dialog> dirigido por seu atributo open) e <instui-context-view> (um popover nativo).

Compatibilidade de navegador: a API de popover e popovertarget são Baseline 2024; invoker commands (command/commandfor) são Baseline 2025, então em navegadores mais antigos conecte os botões a dialog.showModal() como fallback de uma linha. Posicionar um popover ao lado do seu trigger usa anchor positioning em CSS onde suportado (Chromium); em outros, centraliza-o na camada superior.

Formulários

FormField — .instui-form-field é um wrapper CSS-Grid que organiza um label, o controle e quaisquer mensagens. Coloque-o em um <label> para que o label se associe ao controle nativamente. Possui três áreas de grid — label, controls, messages:

<label class="instui-form-field">
  <span class="label">Email address</span>
  <span class="controls"><input class="instui-text-input" type="email" required /></span>
  <div class="instui-form-field-messages">
    <span class="instui-form-field-message -type-hint">We'll never share it.</span>
  </div>
</label>

-layout-stacked (padrão) empilha as áreas; -layout-inline coloca o label ao lado do controle (ajuste com -label-align-{start,end} e -v-align-{top,middle,bottom}). -readonly recolore o label.

O asterisco de obrigatório aparece quando o campo é obrigatório por ou a classe -required ou um controle nativo required dentro dele — então você pode simplesmente definir required no input e a marca aparece. É decorativo (um ::after no label, fora da árvore de acessibilidade); pareie com uma nota como "campos marcados * são obrigatórios" a menos que o formulário seja auto-evidente.

FormFieldGroup — .instui-form-field-group agrupa campos relacionados em um <fieldset> com uma descrição <legend>. É puramente layout (sem tokens dedicados): por padrão empilha os campos; -layout-columns / -layout-inline os fluxam em colunas responsivas, com -row-spacing-* / -col-spacing-* e -v-align-* para ajustar a grid.

RadioInputGroup — .instui-radio-input-group é o mesmo agrupamento <fieldset>/<legend>, especializado para radios. Como os radios filhos compartilham um name, a seleção é nativamente de escolha única — assim um conjunto de botões toggle comporta-se como um único controle, não botões soltos. -variant-simple (padrão) layouta rádios padrão (-layout-columns/-inline os fluxam em uma linha); -variant-toggle conecta os botões filhos .instui-radio.-variant-toggle em um único controle segmentado (bordas colapsadas, extremidades externas arredondadas):

<fieldset class="instui-radio-input-group -variant-toggle">
  <legend>T-shirt size</legend>
  <label class="instui-radio -variant-toggle"
    ><input type="radio" name="size" checked /> Small</label
  >
  <label class="instui-radio -variant-toggle"><input type="radio" name="size" /> Medium</label>
  <label class="instui-radio -variant-toggle"><input type="radio" name="size" /> Large</label>
</fieldset>

Mensagens — .instui-form-field-messages é o contêiner; cada .instui-form-field-message recebe um -type-*: -type-hint (cinza, padrão), -type-error (texto vermelho + glifo de alerta em círculo), -type-success (texto verde + glifo de check em círculo), e -type-screenreader-only (visualmente recortada, ainda anunciada). Os glifos pintam em currentColor, então sempre combinam com a cor da mensagem. -type-new-error é um alias obsoleto de -type-error. Conecte o contêiner ao controle com aria-describedby, e defina aria-invalid no controle quando houver um erro.

Dentro de um FormField, uma mensagem -type-error segue a validação do lado do cliente: ela permanece oculta até que o controle do campo seja :user-invalid (nativo, após o usuário interagir) — ou você a force com -invalid no .instui-form-field (para um erro do servidor). Um .instui-form-field-messages independente (não em um campo) não é afetado. O anel de foco do controle acompanha: perigo quando :user-invalid/-invalid, sucesso em -success.

Controles de texto — .instui-text-input (<input> nativo), .instui-text-area (<textarea> nativo, redimensionável) e .instui-simple-select (<select> nativo com caret) compartilham uma aparência e os mesmos estados: -invalid (borda de erro), -success (borda de sucesso), -readonly, :disabled nativo, e -size-{sm,md,lg}. Para um ícone leading/trailing (InstUI's renderBeforeInput/renderAfterInput), envolva o input em .instui-input-group e adicione um slot .before/.after (um glifo -icon-*); -should-not-wrap mantém tudo em uma linha. .instui-number-input é essa fachada mais uma coluna spinner +/- .arrows (type="number" nativo; ligue os botões a stepUp()/stepDown()). .instui-range-input é um input[type="range"] estilizado cujo valor é renderizado em um balão inverso .instui-range-input-value. Para um combobox rico com um popover listbox, use @instructure/ui — esta biblioteca cobre os controles nativos.

Select estilizado (experimental) — um opt-in select.css atualiza o mesmo elemento .instui-simple-select: estiliza o dropdown aberto (o painel e cada opção, com estados hover e selecionado) usando o modelo CSS Customizable Select.

[!AVISO] select.css depende de appearance: base-select / ::picker(select), que é experimental (Chrome 135+, ainda não Baseline). É entregue como uma folha opt-in separada e cada regra é condicionada por @supports (appearance: base-select), então não faz nada em navegadores não suportados — o controle .instui-simple-select apenas permanece o select nativo simples. Carregue-o somente se quiser o dropdown aprimorado e aceitar o suporte limitado.

import "@pantoken/components/components.css";
import "@pantoken/components/select.css"; // opt-in, experimental: styles the open dropdown