Skip to content

CSS Referência da API

A referência da API CSS cobre a camada de componentes baseada em classes do pantoken: componentes, utilities, regras globais e declarações construídas sobre o sistema de tokens.

Componentes

NomeClasseResumo
agent-shell.instui-agent-shellUm contêiner de superfície para agentes de IA.
alert.instui-alertUma mensagem inline com uma barra de cor de status e um glifo de status mascarado do conjunto de ícones compartilhado.
avatar.instui-avatarUm avatar de usuário mostrando iniciais ou uma imagem, circular por padrão.
badge.instui-badgeUm pequeno ponto de contagem ou estado colocado sobre o canto de um alvo.
banner.instui-bannerUma superfície de mensagem descartável com ícone para anúncios em nível de página ou no contexto.
billboard.instui-billboardUm grande bloco de estado vazio ou call-to-action: um ícone ou imagem hero, um título e uma mensagem.
breadcrumb.instui-breadcrumbUma trilha de breadcrumbs com separadores; a última migalha é a página atual.
breadcrumb.linkliUma migalha (InstUI Breadcrumb.Link), um <li> no <ol> do pai; a última é a página atual.
button.instui-buttonUm controle de ação acessível, estilizado a partir da paleta de tokens; primário por padrão.
byline.instui-bylineUm objeto de mídia: uma figura hero ao lado de um título e descrição.
calendar.instui-calendarUma grade de mês estática com navegação, cabeçalhos dos dias da semana e células de dia.
calendar.day.dayUma célula de dia (InstUI Calendar.Day); -today, -selected e -outside-month marcam seu estado.
card.instui-cardUm contêiner de superfície que aceita conteúdo arbitrário.
checkbox.instui-checkboxUma checkbox nativa e seu rótulo, ou um switch via -variant-toggle.
close-button.instui-close-buttonUm botão de ícone transparente que desenha seu próprio glifo ×, em três tamanhos mais uma variante on-color.
context-view.instui-context-viewUm chamado elevado com um caret, posicionável em qualquer lado; funciona como um [popover] nativo.
drawer-layout.instui-drawer-layoutUm layout dividido com uma gaveta lateral recolhível e um painel de conteúdo principal rolável.
drawer-layout.content.contentO painel de conteúdo primário que preenche o espaço restante ao lado da gaveta.
drawer-layout.tray.trayO painel lateral ao lado do conteúdo principal, com overlay opcional e modificadores de superfície estilo gaveta.
file-drop.instui-file-dropUma zona de drop de arquivos com estados hover, aceito e rejeitado.
form-field.instui-form-fieldUm wrapper de campo de formulário: um rótulo, seus controles e layouts inline, required ou readonly.
form-field-group.instui-form-field-groupUm grupo <fieldset> com legend, layout em coluna ou inline, e espaçamento configurável.
form-field-messages.instui-form-field-messagesAjuda de campo e mensagens de validação — hint, error, success e apenas para leitor de tela — com um glifo em error e success.
heading.instui-headingTipografia de heading de -level-h1 a -level-h6.
img.instui-imgUm <img> estilizado com modificadores de display, crop e effect que se empilham.
in-place-edit.instui-in-place-editUm [contenteditable] que é lido como texto até receber foco, então mostra a chrome de input.
input-group.instui-input-groupUma fachada ao redor de um campo de texto com slots de ícone leading e trailing.
link.instui-linkUm hyperlink estilizado com tamanhos, uma variante inverse para fundos escuros, e formas inline ou unstyled.
list.instui-listUma lista com espaçamento de itens dirigido por tokens.
list.item.instui-listUm item de lista (InstUI List.Item).
mask.instui-maskUma sobreposição em fluxo que preenche seu pai posicionado e centraliza seu conteúdo — por exemplo, um spinner sobre um card. Para um modal, prefira um <dialog> nativo (sua ::backdrop é a máscara). Cada um desses modificadores também está disponível globalmente (puro, ou encadeado em qualquer outro componente) — veja a utility global mask.
menu.instui-menuUma superfície dropdown de itens, grupos e separadores.
menu.group.groupUm cabeçalho de grupo rotulado (InstUI Menu.Group/Menu.ItemGroup).
menu.item.itemUma entrada de menu (InstUI Menu.Item); adicione -disabled, -highlighted ou -active/[aria-checked].
menu.separator.separatorUma regra divider entre itens (InstUI Menu.Separator).
metric.instui-metricUma estatística rotulada — um valor grande sobre uma legenda.
modal.instui-modalUma superfície de dialog (funciona em um <dialog> nativo); partes header/body/footer.
modal.body.bodyA região de conteúdo (InstUI Modal.Body); um único <img> fica full-bleed.
modal.footer.footerA linha de ações (InstUI Modal.Footer).
modal.header.headerA linha de título (InstUI Modal.Header).
number-input.instui-number-inputUma fachada de entrada numérica com uma coluna de spinner +/-.
pagination.instui-paginationNavegação de página: páginas numeradas, primeiro, anterior, próximo e último, e uma reticência para lacunas.
pagination.page.pageUm link ou botão de página (InstUI Pagination.Page); a página atual carrega [aria-current].
pill.instui-pillUm rótulo de status compacto; adicione um glifo inicial com o formulário compartilhado -icon-<name>.
popover.instui-popoverUma superfície elevada para um [popover] nativo, posicionada com CSS anchor positioning.
progress.instui-progressUma barra de progresso determinate com um medidor colorido, tamanhos e um rótulo de valor opcional.
progress-circle.instui-progress-circleUm anel de progresso circular acionado por propriedades customizadas --value e --value-max.
radio.instui-radioUm radio nativo e seu rótulo.
radio-input-group.instui-radio-input-groupUm <fieldset> radio single-select, simples ou como um toggle segmentado conectado.
range-input.instui-range-inputUm slider range estilizado com um bubble de valor inverso.
rating.instui-ratingUma classificação por estrelas com glifos preenchidos e vazios e um rótulo numérico opcional.
side-nav-bar.instui-side-nav-barUma régua de navegação vertical com itens ícone-sobre-rótulo, com um modo minimizado apenas de ícones.
side-nav-bar.item.itemUma entrada de navegação (InstUI SideNavBar.Item); -selected marca a ativa.
simple-select.instui-simple-selectUm <select> nativo estilizado com caret, combinando com os estados e tamanhos do campo de texto.
spinner.instui-spinnerUm anel de carregamento animado; atribua role="status" e um aria-label.
table.instui-tableUma tabela de dados estilizada para th e td mais uma legenda opcional, com layouts de hover, fixo e em cartão empilhado.
table.bodytbodyO grupo de linhas de dados da tabela (InstUI Table.Body).
table.celltdUma célula de dados (InstUI Table.Cell).
table.col-headerthUma célula de cabeçalho de coluna (InstUI Table.ColHeader); o estilo padrão th é sobrescrito por table.row-header para th[scope="row"].
table.headtheadO grupo de linhas de cabeçalho da tabela (InstUI Table.Head).
table.rowtrUma linha da tabela (InstUI Table.Row).
table.row-headerth[scope="row"]Uma célula de cabeçalho de linha (InstUI Table.RowHeader); estilizada a partir dos tokens de cabeçalho de linha, não dos de cabeçalho de coluna.
tabs.instui-tabsUm conjunto de painéis com abas: uma lista de abas, abas selecionáveis e seus painéis.
tabs.panel.panelO painel de conteúdo de uma aba (InstUI Tabs.Panel).
tabs.tab.tabUm único botão de aba (InstUI Tabs.Tab, configurado pela lista de abas do pai Tabs); -selected marca a ativa.
tag.instui-tagUm chip em linha para uma palavra-chave ou filtro.
text.instui-textTipografia de corpo de texto com modificadores de tamanho, peso, cor e estilo.
text-area.instui-text-areaUm <textarea> nativo redimensionável e estilizado com os mesmos estados e tamanhos do campo de texto.
text-input.instui-text-inputUm <input> nativo estilizado — incluindo date, time e datetime-local, onde o navegador fornece o seletor — com estados de validação e tamanhos.
toggle-details.instui-toggle-detailsUm disclosure nativo <details> estilizado com uma chevron giratória.
toggle-group.instui-toggle-groupUm disclosure com borda construído sobre <details>: uma linha de resumo com chevron e conteúdo recolhível.
tooltip.instui-tooltipUm balão de tooltip com hover e foco em CSS, posicionável em qualquer lado.
tray.instui-trayUm painel preso à borda que desliza de qualquer lado; um [popover] ou <dialog> nativo.
tree-browser.instui-tree-browserUma árvore de disclosure de coleções aninhadas e itens folha, com chevrons giratórios.
view.instui-viewO primitivo View: uma caixa neutra com modificadores chave-valor para fundo, borda, raio, sombra, display, posição, overflow e cursor. Cada um desses modificadores também está disponível globalmente (puro ou encadeado em qualquer outro componente) — veja as utilidades background/border/shadow/display/position/overflow/cursor.

Utilitários

NomeClasseResumo
color.--text-dangerUtilitários de cor semântica: .--bg-<name>, .--text-<name> (alias como .--color-<name>) e .--border-<name> para a paleta semântica curada. Cada um também tem um modificador de alias anexado ao componente (por exemplo -bg-danger em qualquer .instui-<component>).
cursor.--cursor-pointercursor como uma classe global composável — .--cursor-<value> — utilizável pura ou encadeada em qualquer componente (.instui-button.--cursor-pointer).
gap.--gap-mdUtilitários flex/grid gap na escala de espaçamento, grafia curta (--gap-sm) ou longa (--gap-small). Utilizável puro ou encadeado em qualquer componente (.instui-view.--gap-sm) — componentes que já definem seu próprio gap a partir de um token específico de componente podem tê-lo sobrescrito.
icon.instui-iconO sistema de ícones: dimensionamento .instui-icon mais o pintor compartilhado -icon-<name> que mascara um glifo (em currentColor) antes de qualquer elemento.
layout.--display-flexUtilitários de display e alinhamento de texto — .--display-<value> e .--text-align-<value> — como classes globais composáveis, utilizáveis puras ou encadeadas em qualquer componente.
maskglobal.--mask-overlayUma cópia global dupla dos modificadores de sobreposição do componente mask--mask-overlay, --mask-fullscreen, --mask-blur — utilizáveis puros ou encadeados em qualquer componente, sem envolver em um elemento .instui-mask.
overflow.--overflow-x-hiddenoverflow-x/overflow-y como classes globais composáveis — .--overflow-x-<value> / .--overflow-y-<value> — utilizáveis puras ou encadeadas em qualquer componente.
position.--position-relativeposition como uma classe global composável — .--position-<value> — utilizável pura ou encadeada em qualquer componente (.instui-button.--position-relative).
responsive[class*="-hidden-"],[class*="-show-"]Classes de mostrar/ocultar por largura de viewport ou container através de uma escala de breakpoints tematizada.
screen-reader-content.instui-screen-reader-contentOculta visualmente o conteúdo mantendo-o disponível para tecnologia assistiva (o padrão padrão clip).
spacing.--p-mdUtilitários de margem e padding — .--m<side>-<step> / .--margin-<side>-<step> e .--p<side>-<step> / .--padding-<side>-<step> na escala de espaçamento (lados t/b/s/e/x/y ou nenhum, escrito curto ou por extenso — por exemplo --mb-sm e --margin-bottom-small são a mesma regra; margin também aceita auto). Usável isolado ou encadeado em qualquer componente (por exemplo class="instui-view --mb-sm").
stacking.--stack-topmostUtilitários de profundidade z-index — .--stack-<level> (deepest, below, above, topmost) — usável isolado ou encadeado em qualquer componente, para que camadas empilhem de forma previsível em vez de usar números ajustados manualmente.
transition.instui-transition.-transition-fade-enteringClasses de estado de animação para o componente Transition.instui-transition e classes de estado (-transition-fade-entering, -transition-scale-exited, etc.) — usáveis isoladas ou encadeadas em qualquer componente.
truncate.--truncateTruncamento com reticências controlado por clamp de linhas via --lines — usável isolado ou encadeado em qualquer componente (.instui-button.--truncate).
visual-debug.-with-visual-debugUm contorno para depuração de layout: componha .-with-visual-debug em qualquer elemento para destacar a caixa e seus filhos imediatos, tornando a estrutura do layout visível de relance.

Regras

NomeClasseResumo
base*Reset global opt-in: box-sizing, a superfície da página, cor e fonte base do texto, color-scheme e padrões de links.
prose:where(body)Padrões tipográficos para HTML bruto — títulos, parágrafos, listas, links e código — aplicados automaticamente onde for importado (padrão :where(body)); passe options.scope para direcionar a uma raiz de conteúdo diferente (por exemplo .vp-doc).

Plugins

NomeClasseResumo
logos.logosLogotipos de produtos Instructure como tokens de imagem CSS: --instui-logo-<product>-<layout>-<mode> contém um SVG em data-URI, assim um logo é renderizado via p.ex. background-image: var(--instui-logo-canvas-horizontal-color).
primitives.instui-bg-primitive-color-whiteClasses utilitárias opt-in para a paleta primitiva: .instui-bg-/fg-/border-primitive-color-<name> pintam uma cor a partir dos tokens de cor primitivos, além de utilitários font-family/font-weight para os tokens de fonte primitivos. Mantidas fora das utilidades semânticas para que sobrescritas ali permaneçam apenas semânticas.
visual-debug.-with-visual-debugUm contorno para depuração de layout: componha .-with-visual-debug em qualquer elemento para destacar a caixa e seus filhos imediatos, tornando a estrutura do layout visível de relance.

layout

NomeClasseResumo
calloutdiv[class~="instui-callout"]Alerta informativo inline para um lembrete curto ou nota.
herodiv[class~="instui-hero"]Seção de cabeçalho em largura total com título, subtítulo e imagem de fundo opcional.
page-layoutdiv[class~="instui-page-layout"]Layout padrão de página em três colunas com cabeçalho, barra lateral e conteúdo principal.
rubric-notediv[class~="instui-rubric-note"]Nota estruturada com categorias de rubrica e indicadores de pontuação.
testimonialdiv[class~="instui-testimonial"]Exibição de citação ou depoimento com atribuição e imagem opcional.
two-columndiv[class~="instui-two-column"]Layout de duas colunas com regiões de conteúdo esquerda e direita.
wrapperbody[class~="instui-display-flex"]Linha do app-shell: navegação lateral, container com cabeçalho e painel opcional.