Komponenter

@pantoken/components levererar klassbaserade komponentstilar byggda från Instructure-tokens. Importera stilmallen och tagga din markup — inget ramverk krävs.

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

NOTE

Föredrar du custom elements? @pantoken/web-components kapslar in dessa samma stilar som <instui-button>, <instui-alert>, <instui-badge>, <instui-avatar>, <instui-progress>, med mera — se package map.

Konventioner

CSS-konventionerna i detta paket baseras på en modifierad version av RSCSS.

Modifikatorer är nyckel-värde — -<prop>-<val>, anpassade till InstUI-prop-namn — så de läser sig själva: -color-secondary, -size-sm, -shape-circle, -icon-plus. Booleska props är endast prop-namnet, där närvaro betyder true (-has-shadow, -clickable); en default-på boolean som stängs av inverterar (-without-background, -without-border). Storlekar accepterar både korta och långa stavningar (-size-sm = -size-small). När ett namn avviker från InstUI fungerar fortfarande InstUI-semantiska klassen men är föråldrad (t.ex. -variant-info → använd -color-info).

Exempel

Instructure UI React-komponent:

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

pantoken-komponenter:

<!-- 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>

För InstUI:s timeout prop, sätt den enhetslösa --timeout custom property i millisekunder och ladda Alert-interaktionen. Ett positivt värde schemalägger avvisning; 0 (standard) lämnar alerten på plats. Lägg till transition utilityns instui-transition -fade-entered klasser för InstUI:s fade; utelämna dem för omedelbar borttagning. Interaktionen driver -fade-exiting tillståndet och avfyrar en avbrytbar, bubblande dismiss händelse före borttagning, så en applikation kan kalla preventDefault() för att hålla alerten monterad.

<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>

Progressbars accepterar godtyckliga skalor genom --min (0 som standard), --value, och --max (100 som standard), med föråldrade alias --value-now och --value-max. Lägg till -should-animate för att tillämpa InstUI:s halva-sekunds övergång när ett värde ändras. .value sitter bredvid .bar som ett barn av roten; lägg till -render-value-inside för att rendera det ovanpå spåret, istället justerat till dess start (styla det för läsbarhet mot meterfärgen). Använd ett native <progress> för ett nollbaserat intervall och <meter> när minimum inte är noll; webkomponenterna väljer mellan dem automatiskt från sitt min attribut. InstUI har inget indeterminate-tillstånd, så en <progress> som saknar sitt value attribut är en pantoken-endast bästa gissning: progress-bar animerar .bar som ett glidande segment och progress-circle snurrar sin ring i en fast båge, båda döljer .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>

Progresscirklar accepterar samma godtyckliga skalor genom --min, --value och --max. --value-now och --value-max förblir föråldrade funktionella alias. Lägg till -should-animate och ladda focused interaction-buntet för att reproducera InstUI:s mount-animation; --animation-delay är en enhetslös millisekundfördröjning. De föråldrade stavningarna -should-animate-on-mount och -shold-animate-on-mount förblir funktionella alias.

<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>

Klassprefix

Varje klass namnrymssätts med instui- som standard. Bygg en stylesheet med ditt eget prefix — eller inget — genom att skicka prefix till någon builder. Värdet falsy (null, undefined, "", eller att utelämna det) tar bort prefixet helt, så du kan författa class="heading -level-h1" istället för class="instui-heading -level-h1":

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

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

De dash-prefixed modifikatorerna (.-color-secondary, .-level-h1) ändras inte i något av fallen. De stilmallar som levereras av paketet behåller instui prefixet.

Bas

base.css är en opt-in reset som sätter globala dokumentdefaults från tokens: box-sizing, en body reset, pagesurface, bastextfärg och font, color-scheme (så att light-dark() tokens och native kontroller följer temat), och en baslänk. Ladda den en gång, före komponent- och prose-stilar, när pantoken äger sidan.

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

Hoppa över den när du bäddar in komponenter i en host som redan themes sina egna html och body — resetten målar pagesurface, så du vill inte att den slåss med hosten. Allt den sätter använder lågspecifika :where() selektorer, så dina egna regler vinner alltid.

base.css tillämpa varumärkesfonten (font-family: var(--instui-font-family-base), med systemfallbacks); för att ladda den, importera den opt-in fonts.css — @font-face regler för Atkinson Hyperlegible Next, pekande på woff2-filerna som levereras i paketet. Den är separat eftersom typsnitten är ~350 kB och självhostade fonter är ett medvetet val.

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

Innehåll för skärmläsare

Det finns ett dolt meddelande efter denna mening.Endast skärmläsare meddelar detta.

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

.instui-screen-reader-content döljer ett element visuellt medan det behålls i tillgänglighetsträdet — för etiketter och statustexter som hjälpmedel ska läsa men designen inte ska visa.

Utilities

utilities.css är ett opt-in lager av tvärgående klasser: en View primitiv, spacing på token-skalan, och semantiska färgöverslag. Till skillnad från komponentens -modifier klasser använder dessa en dubbel dash (--mod) så de aldrig kolliderar med en komponents egna modifikatornamn, och de kan appliceras på vilket element som helst — löst, eller komponerat ovanpå en komponent.

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

Accent-blue-ytan med on-color text.

Centrerad med 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 är InstUI:s View. Det är basen du lägger spacing och färg på, och den bär nyckel-värde modifikatorer för sina egna visuella props så du inte behöver nå efter utilities: -background-* (dess ytor), -border-radius-{small,medium,large,circle,pill}, -border-width-{small,medium,large} + -border-color-*, -shadow-{resting,above,topmost}, -display-*, -position-*, -overflow-x-*/-overflow-y-*, och -cursor-* — dessa är view's egna enkla-dash modifikatorer, orelaterade till dubbel-dash utilities nedan. Frivärdesprops (width/height/inset) förblir inline-stilar; margin/padding använder spacing-utilities.

Spacing — per-sida klasser på spacing-skalan. Läs dem som {m|p}{side}-{step}: m för margin eller p för padding (eller fulla orden margin/padding), en valfri logisk sida, sedan ett steg. Så .--m-lg och .--margin-lg är samma, liksom .--pt-md och .--paddingt-md.

• Sidor: none (alla), t/b (block start/slut), s/e (inline start/slut), x/y (inline/block axel). Logiska sidor förblir korrekta i höger-till-vänster layouter.
• Steg: 0, 2xs, xs, sm, md, lg, xl, 2xl, plus auto för margin endast.

Kombinera dem för InstUI:s margin="small auto large" shorthand: class="--mt-sm --mx-auto --mb-lg".

Färg — semantiska överslag som håller sig på paletten: .--bg-<name> (bakgrund), .--text-<name> (textfärg), och .--border-<name> (kantfärg). Varje <name> är en semantisk färgtoken — intents ( base, brand, muted, success, warning, error, info, inverse, on-color, strong, …) plus accent-* paletten (accent-blue, accent-green, och så vidare). Ett namn finns endast om token existerar i den familjen, så text-brand är inte en klass — text har ingen brand-token. Det finns inget sätt att nå en primitiv eller ett godtyckligt hexvärde, och varje överslag följer temat.

Tokengemenskaper — varje "en token, en egenskap" familj får en klass per token, namngiven efter token. Kombinera fritt:

• .--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 (och -depth1…-card) → box-shadow

Varje klass sätter endast sin enda egenskap, så border-width/border-radius behöver en border-* färg och en kantstil för att faktiskt rita en ram. Dessa använder det fulla token-namnet (.--border-radius-md), medan färg- och spacing-helpers ovan använder korta alias (.--bg-brand, .--mt-lg) — aliasen är ergonomiska genvägar; token-klasserna är bokstavliga och uttömmande.

Layout — .--display-<value> (block, inline-block, inline, flex, inline-flex, none) och .--text-align-<value> (start, center, end, justify) täcker InstUI:s tvärgående display och textAlign props (View, Button, Metric, Tabs, …) som komponerbara klasser — så de är inte per-komponent modifikatorer.

Varje dubbel-dash klass vinner kaskaden deterministiskt över en likanamnig enkel-dash komponentsmodifikator, oavsett ordningen på stilbladen — se Authoring conventions för mekanismen.

Allt här är ren CSS styrd av --instui-* tokens, så det följer InstUI genom token-lagret. Se API reference för componentsCss och per-komponent builders.

Overlay: dialog och popover

Overlay-komponenterna använder native plattformsprimitiv, så de beter sig tillgängligt med liten eller ingen JavaScript.

Modal — sätt .instui-modal på en native <dialog>. Den får fokusfångst, Esc-to-close, och en ::backdrop gratis; backdrop dimmas med samma --instui-component-mask-background-color token som .instui-mask (lägg till -blur för frostning). Öppna och stäng med invoker-kommandon — ingen 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 — sätt .instui-context-view på ett [popover] element och växla det med popovertarget. Det ligger i topplagret och light-dismissas vid klick utanför eller Esc, återigen utan script:

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

Drawer layout — sätt .instui-drawer-layout på en layoutrot med .tray och .content barn. Lägg till open attributet (eller -open) för att avslöja brickan, och använd placement="end" (eller -placement-end) för att docka det till inline-end sidan — placering löses genom logiska inset-inline-*/flex-direction egenskaper, så den vänder automatiskt under dir="rtl" utan extra regler. Det fokuserade interaction-buntet lägger till Invoker-kommando-routing och växlar overlay-läge (should-overlay-tray) när bredden korsar --drawer-layout-min-width (standard --instui-breakpoints-sm, sedan 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 används för in-flow overlays (en spinner över ett kort); en modals ::backdrop täcker modal-fallet.

Båda mönstren är också inlindade som beteendemässiga custom elements i @pantoken/web-components: <instui-modal open> (en <dialog> driven av sitt open attribut) och <instui-context-view> (en native popover).

Browserstöd: popover API:n och popovertarget är Baseline 2024; invoker-kommandon (command/commandfor) är Baseline 2025, så på äldre webbläsare koppla knapparna till dialog.showModal() som en enkel fallback. Positionering av en popover intill dess trigger använder CSS anchor-positionering där stödd (Chromium); annars centrerar den i topplagret.

Formulär

FormField — .instui-form-field är en CSS-Grid wrapper som lägger ut en label, kontrollen och eventuella meddelanden. Sätt den på en <label> så etiketten associeras med sin kontroll nativt. Den har tre grid områden — 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 (standard) staplar områdena; -layout-inline placerar etiketten bredvid kontrollen (justera med -label-align-{start,end} och -v-align-{top,middle,bottom}). -readonly recolorerar etiketten.

Den obligatoriska asterisken visas när fältet är obligatoriskt av antingen -required klassen eller en native required kontroll inuti det — så du kan bara sätta required på inputen och markeringen visas. Den är dekorativ (en ::after på etiketten, utanför tillgänglighetsträdet); para ihop den med en notis som "fält märkta * är obligatoriska" om inte formuläret är självförklarande.

FormFieldGroup — .instui-form-field-group grupperar relaterade fält i en <fieldset> med en <legend> beskrivning. Det är ren layout (inga dedikerade tokens): standard staplar fälten; -layout-columns / -layout-inline flödar dem i responsiva kolumner, med -row-spacing-* / -col-spacing-* och -v-align-* för att finjustera grid:en.

RadioInputGroup — .instui-radio-input-group är samma <fieldset>/<legend> gruppering, specialiserad för radios. Eftersom barnradios delar en name, är selektionen nativt enkvalig — så en uppsättning toggle-knappar beter sig som en kontroll, inte lösa knappar. -variant-simple (standard) lägger ut standardradios (-layout-columns/-inline flödar dem i en rad); -variant-toggle kopplar barnens .instui-radio.-variant-toggle knappar till en enda segmenterad kontroll (ihopklämda kanter, avrundade yttre ändar):

<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>

Meddelanden — .instui-form-field-messages är containern; varje .instui-form-field-message tar en -type-*: -type-hint (grå, standard), -type-error (röd text + cirkel-varningsikon), -type-success (grön text + cirkel-check ikon), och -type-screenreader-only (visuellt klippt, men fortfarande meddelat). Ikonerna målas i currentColor, så de matchar alltid meddelandefärgen. -type-new-error är en föråldrad alias för -type-error. Koppla containern till kontrollen med aria-describedby, och sätt aria-invalid på kontrollen när ett fel föreligger.

Inuti en FormField följer ett -type-error meddelande klient-side validering: det förblir dolt tills fältets kontroll är :user-invalid (naturligt, efter användarinteraktion) — eller du tvingar fram det med -invalid på .instui-form-field (för ett server-side fel). En fristående .instui-form-field-messages (inte i ett fält) påverkas inte. Kontrollens fokusring följer efter: danger när :user-invalid/-invalid, success på -success.

Textkontroller — .instui-text-input (native <input>), .instui-text-area (native <textarea>, resizbar), och .instui-simple-select (native <select> med en caret) delar ett utseende och samma tillstånd: -invalid (felram), -success (success-ram), -readonly, native :disabled, och -size-{sm,md,lg}. För en ledande/släpande ikon (InstUI:s renderBeforeInput/renderAfterInput), wrappa inputen i .instui-input-group och lägg till en .before/.after slot (en -icon-* ikon); -should-not-wrap håller den på en rad. .instui-number-input är det facaden plus en .arrows +/- spinner-kolumn (native type="number"; koppla knapparna till stepUp()/stepDown()). .instui-range-input är en stylad input[type="range"] vars värde renderas i en .instui-range-input-value invers bubbla. För en rik combobox med en listbox-popover, använd @instructure/ui — detta bibliotek täcker de native kontrollerna.

Stylad select-dropdown (experimentell) — en opt-in select.css uppgraderar samma.instui-simple-select element: den stylar den öppna dropdownen (panelen och varje option, med hover och valda tillstånd) med CSS Customizable Select-modellen.

WARNING

select.css är beroende av appearance: base-select / ::picker(select), vilket är experimentellt (Chrome 135+, ännu inte Baseline). Den levereras som ett separat opt-in-ark och varje regel är spärrad bakom @supports (appearance: base-select), så den gör ingenting i icke-stödjande webbläsare — .instui-simple-select kontrollen förblir bara den vanliga native select. Ladda den endast om du vill ha den förbättrade dropdownen och accepterar det begränsade stödet.

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