Skip to content

CSS API-viite

CSS-API-viite kattaa pantokenin luokkapohjaisen komponenttikerroksen: komponentit, utiliteetit, globaalit säännöt ja deklaroinnit, jotka on rakennettu token-järjestelmän päälle.

Komponentit

NimiLuokkaYhteenveto
agent-shell.instui-agent-shellPinta-astia AI-agenteille.
alert.instui-alertTässä rivissä oleva viesti, jossa on tilaväripalkki ja maskattu tilakuvake jaetusta ikonipaketista.
avatar.instui-avatarKäyttäjän avatar, joka näyttää nimikirjaimet tai kuvan; oletuksena pyöreä.
badge.instui-badgePieni laskuri- tai tilapiste, joka sijoitetaan kohteen kulmaan.
banner.instui-bannerSuljettava, ikonoitu viestipinta sivutason tai kontekstissa annettaville ilmoituksille.
billboard.instui-billboardSuuri tyhjän tilan tai toimintakehotuksen lohko: sankari-ikoni tai kuva, otsikko ja viesti.
breadcrumb.instui-breadcrumbMurupolku erottimilla; viimeinen muru on nykyinen sivu.
breadcrumb.linkliMurupala (InstUI Breadcrumb.Link), <li> vanhemman <ol>-elementissä; viimeinen on nykyinen sivu.
button.instui-buttonSaavutettavissa oleva toimintokontrolli, tyylitelty token-palettien mukaan; oletuksena päätoiminto.
byline.instui-bylineMediaobjekti: sankari-kuva otsikon ja kuvauksen vieressä.
calendar.instui-calendarStaattinen kuukausiruudukko, jossa navigaatio, viikonpäiväotsikot ja päiväsellit.
calendar.day.dayPäiväselli (InstUI Calendar.Day); -today, -selected ja -outside-month merkitsevät sen tilan.
card.instui-cardPinta-astia, joka hyväksyy mielivaltaisen sisällön.
checkbox.instui-checkboxNatiivivalintaruutu ja sen etiketti, tai kytkin käyttämällä -variant-toggle.
close-button.instui-close-buttonLäpinäkyvä ikoni-painike, joka piirtää oman ×-kuvakkeen, kolmessa koossa ja on-värivariaantilla.
context-view.instui-context-viewKorotettu huomautus, jossa on huuli (caret), sijoitettavissa mille tahansa puolelle; toimii natiivina [popover]-elementtinä.
drawer-layout.instui-drawer-layoutJaettu asettelu, jossa on kutistettavissa oleva sivulaatikko ja pääasiallinen vieritettävä sisältöruutu.
drawer-layout.content.contentPääsisältöruutu, joka täyttää jäljellä olevan tilan laukun vieressä.
drawer-layout.tray.traySivupaneeli pääsisällön vieressä, valinnaisella peitteellä ja laatikkomainen pinta-muokkaus.
file-drop.instui-file-dropTiedostojen pudotusalue, jossa hover-, hyväksytty- ja hylätty-tilat.
form-field.instui-form-fieldLomakekentän kääre: etiketti, sen kontrollit ja inline-, pakollinen- tai readonly-asettelut.
form-field-group.instui-form-field-group<fieldset>-ryhmä, jossa legend, sarake- tai riviasettelu ja konfiguroitava väli.
form-field-messages.instui-form-field-messagesKenttäohjeet ja validointiviestit — vihje, virhe, onnistuminen ja vain ruudunlukijalle — virhe- ja onnistumiskuvakkeella.
heading.instui-headingOtsikkotyyppi -level-h1:sta -level-h6:iin.
img.instui-imgTyylitelty <img>, jossa on display-, crop- ja effect-modifikaattoreita, jotka pinoutuvat.
in-place-edit.instui-in-place-edit[contenteditable], joka lukee tekstinä kunnes fokus, jolloin se näyttää syötekehyksen.
input-group.instui-input-groupTekstisyötteen julkisivu, jossa on leading- ja trailing-ikonipaikat.
link.instui-linkTyylitelty hyperlinkki, kokoja, invertattu varianti tummille taustoille sekä inline- tai ilman tyyliä -muodot.
list.instui-listLista, jossa on token-ohjattu kohteiden väli.
list.item.instui-listListan kohde (InstUI List.Item).
mask.instui-maskVirtausmukainen peite, joka täyttää positionoidun vanhemman ja keskittää sisältönsä — esim. spinner kortin päällä. Modaalille suositaan natiivia <dialog>-elementtiä (sen ::backdrop on maski). Jokainen näistä modifikaattoreista on myös saatavilla globaalisti (paljaana tai ketjutettuna mihin tahansa komponenttiin) — katso mask-globaalinen utiliteetti.
menu.instui-menuItemeistä, ryhmistä ja erotusviivoista koostuva pudotusvalikon pinta.
menu.group.groupEtiketöity ryhmän otsikko (InstUI Menu.Group/Menu.ItemGroup).
menu.item.itemValikon merkintä (InstUI Menu.Item); lisää -disabled, -highlighted tai -active/[aria-checked].
menu.separator.separatorErotusviiva kohteiden välillä (InstUI Menu.Separator).
metric.instui-metricEtiketöity tilasto — suuri arvo ja sen alapuolella kuvateksti.
modal.instui-modalDialogipinta (toimii natiivin <dialog> kanssa); header/body/footer-osat.
modal.body.bodySisältöalue (InstUI Modal.Body); ainoa <img> venyy täyteen leveyteen.
modal.footer.footerToimintorivi (InstUI Modal.Footer).
modal.header.headerOtsikkorivi (InstUI Modal.Header).
number-input.instui-number-inputNumero-syötteen julkisivu, jossa +/- spinner-sarake.
pagination.instui-paginationSivunavigaatio: numeroidut sivut, ensimmäinen, edellinen, seuraava ja viimeinen nuoli sekä kapeneva ellipsi väleille.
pagination.page.pageSivulinkki tai -painike (InstUI Pagination.Page); nykyisellä sivulla on [aria-current].
pill.instui-pillKompakti tilatunniste; lisää edellä oleva kuvake käyttäen jaettua -icon-<name>-muotoa.
popover.instui-popoverKorotettu pinta natiiville [popover]-elementille, sijoitettu CSS-anchor-asettelulla.
progress.instui-progressDeterministinen edistymispalkki värillisellä mittarilla, kooilla ja valinnaisella arvolabelilla.
progress-circle.instui-progress-circlePyöreä edistymisrengas, jota ohjaavat --value- ja --value-max-custom-propertyt.
radio.instui-radioNatiiviradiopainike ja sen etiketti.
radio-input-group.instui-radio-input-groupYhden valinnan radio <fieldset>, yksinkertainen tai yhdistetty segmentoituna kytkimenä.
range-input.instui-range-inputTyylitelty liukusäädin, jossa käänteinen arvo-kupla.
rating.instui-ratingTähtiarvostelu, jossa on täytettyjä ja tyhjiä kuvakkeita sekä valinnainen numeerinen etiketti.
side-nav-bar.instui-side-nav-barPystysuuntainen navigointiraita, jossa kuvakkeet ovat etikettien yläpuolella, ja minimoitu pelkkien kuvakkeiden tila.
side-nav-bar.item.itemNavigaatiokohta (InstUI SideNavBar.Item); -selected merkitsee aktiivista.
simple-select.instui-simple-selectTyylitelty natiivinen <select> nuolimerkillä, joka vastaa tekstikentän tiloja ja kokoja.
spinner.instui-spinnerAnimoitu latausrengas; anna sille role="status" ja aria-label.
table.instui-tableTyylitelty tietotaulukko th- ja td-elementeille sekä valinnaiselle kuvatekstille, joka tukee hover-, kiinteää ja pinottu-kortti-asettelua.
table.bodytbodyTaulukon tietoriviryhmä (InstUI Table.Body).
table.celltdTietosolu (InstUI Table.Cell).
table.col-headerthSarakkeen otsikkosolu (InstUI Table.ColHeader); oletusarvoinen th-tyyli, jonka table.row-header korvaa th[scope="row"]-elementeille.
table.headtheadTaulukon otsikkoriviryhmä (InstUI Table.Head).
table.rowtrTaulukon rivi (InstUI Table.Row).
table.row-headerth[scope="row"]Rivin otsikkosolu (InstUI Table.RowHeader); muotoiltu rivin otsikon tokeneista, ei sarakkeen otsikon tokeneista.
tabs.instui-tabsVälilehtinen paneelisarja: välilehtiluettelo, valittavat välilehdet ja niiden paneelit.
tabs.panel.panelVälilehden sisältöpaneeli (InstUI Tabs.Panel).
tabs.tab.tabYksi välilehtipainike (InstUI Tabs.Tab, määritetty emokomponentin Tabs välilehtilistan kautta); -selected merkitsee aktiivista.
tag.instui-tagRivinsisäinen chip avainsanalle tai suodattimelle.
text.instui-textLeipätekstin typografia, jossa on koko-, paino-, väri- ja tyylimuokkaimet.
text-area.instui-text-areaTyylitelty, koon muutettava natiivi <textarea>, jolla on samat tilat ja samat koot kuin tekstikentällä.
text-input.instui-text-inputTyylitetty natiivinen <input> — mukaan lukien date, time ja datetime-local, joiden valitsimen selain toimittaa — validointitilat ja koot.
toggle-details.instui-toggle-detailsMuotoiltu natiivi <details>-elementti, jossa on pyörivä nuoli.
toggle-group.instui-toggle-groupReunuksellinen paljastus, joka on rakennettu <details>-elementin päälle: chevron-yhteenvetorivi ja kutistuva sisältö.
tooltip.instui-tooltipCSS-pohjainen työkaluvihjekupla, joka aktivoituu hover- ja focus-tiloissa ja voidaan sijoittaa mille tahansa puolelle.
tray.instui-trayReunaan kiinnitetty paneeli, joka liukuu sisään mistä tahansa sivulta; natiivi [popover] tai <dialog>.
tree-browser.instui-tree-browserPaljastuspuu, jossa on sisäkkäisiä kokoelmia ja lehtikohteita sekä pyörivät nuolimerkit.
view.instui-viewView-primitivi: neutraali laatikko, jossa on avain–arvo‑muokkaimia taustalle, reunukselle, pyöristykselle, varjolle, displaylle, positionille, overflow’lle ja cursorille. Jokainen näistä muokkaimista on myös saatavilla globaalisti (tyhjänä tai ketjutettuna mihin tahansa muuhun komponenttiin) — katso background/border/shadow/display/position/overflow/cursor-utilit.

Apuohjelmat

NimiLuokkaYhteenveto
color.--text-dangerSemanttiset väriapuohjelmat: .--bg-<name>, .--text-<name> (alias .--color-<name>), ja .--border-<name> kuratoidulle semanttiselle paletille. Jokaisella näistä on myös komponenttiin kiinnitetty alias-modifikaattori (esimerkiksi -bg-danger mille tahansa .instui-<component>-luokalle).
cursor.--cursor-pointercursor komponoitavana, globaalina luokkana — .--cursor-<value> — käytettävissä sellaisenaan tai ketjuttuna mihin tahansa komponenttiin (.instui-button.--cursor-pointer).
gap.--gap-mdFlex-/grid-gap-utilityt välistysasteikolla, lyhyt (--gap-sm) tai pitkä (--gap-small) muoto. Voidaan käyttää sellaisenaan tai ketjuttaa mihin tahansa komponenttiin (.instui-view.--gap-sm) — komponentit, jotka ovat jo asettaneet oman gap-arvonsa komponenttikohtaisesta tokenista, saattavat saada sen ylikirjoitetuksi.
icon.instui-iconIkonijärjestelmä: .instui-icon-koko sekä yhteinen -icon-<name>-piirtäjä, joka käyttää maskia glyfin peittämiseen (väri currentColor) ennen mitä tahansa elementtiä.
layout.--display-flexDisplay- ja text-align-utilityt — .--display-<value> ja .--text-align-<value> — koostettavina, globaaleina luokkina, joita voi käyttää itsenäisinä tai ketjuttaa mihin tahansa komponenttiin.
maskglobal.--mask-overlayGlobaali, kaksinkertainen kopio mask-komponentin overlay-modifikaattoreista — --mask-overlay, --mask-fullscreen, --mask-blur — käytettävissä sellaisenaan tai ketjutettuna mihin tahansa komponenttiin ilman, että niitä tarvitsee kääriä .instui-mask-elementin sisään.
overflow.--overflow-x-hiddenoverflow-x/overflow-y koostettavina, globaalina luokkina — .--overflow-x-<value> / .--overflow-y-<value> — käytettävissä sellaisenaan tai ketjutettuna mihin tahansa komponenttiin.
position.--position-relativeposition koostettavana, globaalina luokkana — .--position-<value> — käytettävissä sellaisenaan tai ketjutettuna mihin tahansa komponenttiin (.instui-button.--position-relative).
responsive[class*="-hidden-"],[class*="-show-"]Näytön tai kontainerin leveyteen perustuvat näytä-/piilota-luokat teemallisen murtopisteasteikon mukaan.
screen-reader-content.instui-screen-reader-contentPiilottaa sisällön visuaalisesti mutta pitää sen saatavilla avustaville teknologioille (vakio 'clip'-kuvio).
spacing.--p-mdMarginaali- ja täyte-apuluokat — .--m<side>-<step> / .--margin-<side>-<step> ja .--p<side>-<step> / .--padding-<side>-<step> välilyöntiasteikolla (sivut t/b/s/e/x/y tai ei lainkaan, lyhyenä tai täydellisenä — esimerkiksi --mb-sm ja --margin-bottom-small ovat sama sääntö; marginaali hyväksyy myös auto). Käytettävissä suoraan tai ketjutettuna mihin tahansa komponenttiin (esim. class="instui-view --mb-sm").
stacking.--stack-topmostz-index-kerrostusapuohjeet — .--stack-<level> (deepest, below, above, topmost) — käytettävissä suoraan tai ketjutettuna mihin tahansa komponenttiin, jotta kerrokset pinoutuvat ennustettavasti eivätkä käsin säädetyillä numeroilla.
transition.instui-transition.-transition-fade-enteringAnimaation tilaluokat komponentille Transition.instui-transition ja tilaluokat (-transition-fade-entering, -transition-scale-exited, jne.) — käytettävissä suoraan tai ketjutettuna mihin tahansa komponenttiin.
truncate.--truncateEllipsin katkaisu (truncation) rivitiivistyksellä, jota ohjataan --lines:lla — käytettävissä suoraan tai ketjutettuna mihin tahansa komponenttiin (.instui-button.--truncate).
visual-debug.-with-visual-debugAsettelun vianmäärityksen kehys: yhdistä koostettu .-with-visual-debug mihin tahansa elementtiin korostamaan laatikkoa ja sen välittömiä lapsia, jotta asettelun rakenne näkyy yhdellä silmäyksellä.

Säännöt

NimiLuokkaYhteenveto
base*Valinnainen globaali nollaus: box-sizing, sivun pinta, perustekstin väri ja fontti, color-scheme sekä linkkien oletusarvot.
prose:where(body)Typografian oletusarvot raakalle HTML:lle — otsikot, kappaleet, listat, linkit ja koodi — sovelletaan automaattisesti aina, kun se tuodaan (oletus :where(body)); lähetä options.scope kohdistamaan eri sisältöjuureen (esim. .vp-doc).

Plugins

NimiLuokkaYhteenveto
logos.logosInstructure-tuotteiden logot CSS-kuvatokeneina: --instui-logo-<product>-<layout>-<mode> sisältää data-URI SVG:n, joten logo piirretään esim. background-image: var(--instui-logo-canvas-horizontal-color):lla.
primitives.instui-bg-primitive-color-whiteValinnaiset apuluokat raakalle primitiivipalettiin: .instui-bg-/fg-/border-primitive-color-<name> maalaavat värin primitiiviväritokeneista, plus font-family/font-weight apuluokkia primitiivifonttitokeneille. Pidetään erillään semanttisista apuluokista, jotta niiden ylikirjoitukset pysyvät pelkästään semanttisina.
visual-debug.-with-visual-debugAsettelun vianmäärityksen kehys: yhdistä koostettu .-with-visual-debug mihin tahansa elementtiin korostamaan laatikkoa ja sen välittömiä lapsia, jotta asettelun rakenne näkyy yhdellä silmäyksellä.

layout

NimiLuokkaYhteenveto
calloutdiv[class~="instui-callout"]Rivissä näytettävä lyhyt informaatioilmoitus muistutusta tai huomautusta varten.
herodiv[class~="instui-hero"]Koko leveydeltään ulottuva otsikkosektio, jossa on otsikko, alaotsikko ja valinnainen taustakuva.
page-layoutdiv[class~="instui-page-layout"]Vakio kolmipalstainen sivuasettelu, jossa on otsikko, sivupalkki ja pääsisältö.
rubric-notediv[class~="instui-rubric-note"]Rakenneopas-merkintä, jossa on arviointikategoriat ja pisteytyksen indikaattorit.
testimonialdiv[class~="instui-testimonial"]Lainaus- tai suositusnäyttö, jossa on lähdeilmoitus ja valinnainen kuva.
two-columndiv[class~="instui-two-column"]Kaksipalstainen asettelu, jossa vasen ja oikea sisältöalue.
wrapperbody[class~="instui-display-flex"]Sovelluksen runkorivi: sivunavigaatio, sisältökontti otsikolla ja valinnainen paneeli.