Skip to content

CSS Referans API

Referans API CSS la kouvri kouch konpozan pantoken ki baze sou klas: konpozan, sèvis itil (utilities), règ global, ak deklarasyon yo bati sou sistèm token an.

Konpozan

NonKlasRezime
agent-shell.instui-agent-shellYon kontenè sifas pou ajan AI.
alert.instui-alertYon mesaj anliy ak yon ba koulè estati ak yon glif estati kache ki soti nan ansanm ikon pataje a.
avatar.instui-avatarYon avatar itilizatè ki montre inisyal oswa yon imaj, sikilè pa defo.
badge.instui-badgeYon ti koulè oswa pwen estati pou konte ki plase sou kwen sib la.
banner.instui-bannerYon sifas mesaj ki ka fèmen, ak ikon, pou anons nivo paj oswa an-konteks.
billboard.instui-billboardYon gwo blòk eta vid oswa apèl-a-aksyon: yon ikon oswa imaj ewo, yon tit, ak yon mesaj.
breadcrumb.instui-breadcrumbYon tras breadcrumb ak separatè; dènye moso a se paj aktyèl la.
breadcrumb.linkliYon moso (InstUI Breadcrumb.Link), yon <li> nan <ol> paran an; dènye a se paj aktyèl la.
button.instui-buttonYon kontwòl aksyon aksesib, estilize soti nan palèt token la; prensipal pa defo.
byline.instui-bylineYon objè medya: yon figi ewo sou kote yon tit ak deskripsyon.
calendar.instui-calendarYon griy mwa estatik ak navigasyon, tèt jou semèn, ak selil jou.
calendar.day.dayYon selil jou (InstUI Calendar.Day); -today, -selected, ak -outside-month make eta li.
card.instui-cardYon kontenè sifas ki aksepte kontni anvaryab.
checkbox.instui-checkboxYon ti bwat chèk natif natal ak etikèt li, oswa yon switch atravè -variant-toggle.
close-button.instui-close-buttonYon bouton ikon transparan ki trase pwòp glif × li, nan twa gwosè plis yon varyant sou-koulè.
context-view.instui-context-viewYon callout leve ak yon caret, pozisyonab sou nenpòt bò; fonksyone kòm yon [popover] natif natal.
drawer-layout.instui-drawer-layoutYon layout separe ak yon tiwa bò ki ka fèmen epi yon panèl kontni prensipal ki ka scroll.
drawer-layout.content.contentPanèl kontni prensipal la ki ranpli espas ki rete bò tiwa a.
drawer-layout.tray.trayPanno bò a bò kote kontni prensipal la, ak opsyon pou overlay ak modifikatè sifas tankou tiwa.
file-drop.instui-file-dropYon zòn depo dosye ak eta hover, aksepte, ak rejte.
form-field.instui-form-fieldYon vlope chan fòm: yon etikèt, kontwòl li yo, ak layout anliy, obligatwa, oswa readonly.
form-field-group.instui-form-field-groupYon gwoup <fieldset> ak yon lejann, yon layout kolòn oswa anliy, ak espas konfigirab.
form-field-messages.instui-form-field-messagesÈd chan ak mesaj validasyon — konsèy, erè, siksè, ak sèlman pou lektè ekran — ak yon glif sou erè ak siksè.
heading.instui-headingTipografi tit soti nan -level-h1 rive -level-h6.
img.instui-imgYon <img> estilize ak modifikatè ekspozisyon, koupe, ak efè ki pile.
in-place-edit.instui-in-place-editYon [contenteditable] ki li kòm tèks jiskaske li pran fokus, epi li montre chrome antre.
input-group.instui-input-groupYon fasad alantou yon antre tèks ak plas ikon devan ak dèyè.
link.instui-linkYon lyen estilize ak gwosè, yon varyant envès pou background fè nwa, ak fòm anliy oswa san stil.
list.instui-listYon lis ak espas atik kondwi pa token.
list.item.instui-listYon atik lis (InstUI List.Item).
mask.instui-maskYon overlay nan koule ki ranpli paran pozisyone li epi santre kontni li — egzanp: yon spinner sou yon kat. Pou yon modal, prefere yon <dialog> natif natal (mask li se ::backdrop). Chak youn nan modifikatè sa yo disponib tou globalman (tèt, oswa chèn sou nenpòt lòt konpozan) — wè utilite global mask.
menu.instui-menuYon sifas dropdown ki gen atik, gwoup, ak separatè.
menu.group.groupYon tit gwoup ki gen etikèt (InstUI Menu.Group/Menu.ItemGroup).
menu.item.itemYon antre meni (InstUI Menu.Item); ajoute -disabled, -highlighted, oswa -active/[aria-checked].
menu.separator.separatorYon règ divizè ant atik (InstUI Menu.Separator).
metric.instui-metricYon estatistik ki gen etikèt — yon valè gwo sou yon caption.
modal.instui-modalYon sifas dyalòg (fonksyone sou yon <dialog> natif natal); pati header/body/footer.
modal.body.bodyRejyon kontni an (InstUI Modal.Body); yon sèl <img> ale full-bleed.
modal.footer.footerRanje aksyon yo (InstUI Modal.Footer).
modal.header.headerRanje tit la (InstUI Modal.Header).
number-input.instui-number-inputYon fasad antre nimewo ak yon kolòn spinner +/-.
pagination.instui-paginationNavigasyon paj: paj nimewote, premye, anvan, pwochen, ak dènye flèch, ak yon elips pou espas vid.
pagination.page.pageYon lyen paj oswa bouton (InstUI Pagination.Page); paj aktyèl la pote [aria-current].
pill.instui-pillYon etikèt estati kontra; ajoute yon glif devan ak fòm pataje -icon-<name>.
popover.instui-popoverYon sifas leve pou yon [popover] natif natal, pozisyone ak pozisyon anchè CSS.
progress.instui-progressYon ba pwogrè detèmine ak yon mezi koulè, gwosè, ak yon etikèt valè opsyonèl.
progress-circle.instui-progress-circleYon bag pwogrè sikilè ki kondwi pa pwopriyete koutim --value ak --value-max.
radio.instui-radioYon bouton radyo natif natal ak etikèt li.
radio-input-group.instui-radio-input-groupYon <fieldset> radio sèl-chwazi, senp oswa kòm yon toggle segmante konekte.
range-input.instui-range-inputYon slider ranje estilize ak yon boul valè inverse.
rating.instui-ratingYon evalyasyon etwal ak glif plen ak vid e yon etikèt nimewik opsyonèl.
side-nav-bar.instui-side-nav-barYon rail navigasyon vètikal ki gen atik ikon sou etikèt, ak yon mòd minimize ki montre sèlman ikon yo.
side-nav-bar.item.itemYon antre navigasyon (InstUI SideNavBar.Item); -selected make youn ki aktif la.
simple-select.instui-simple-selectYon <select> natif estilize ak yon karekèt, ki matche ak eta ak gwosè antre tèks yo.
spinner.instui-spinnerYon bag chajman anime; bay li role="status" ak yon aria-label.
table.instui-tableYon tablo done estilize pou th ak td plis yon caption opsyonèl, ak modèl hover, fiks, ak kat-stake.
table.bodytbodyGwoup ranje done tablo a (InstUI Table.Body).
table.celltdYon selil done (InstUI Table.Cell).
table.col-headerthYon selil tèt kolòn (InstUI Table.ColHeader); style defo th la, ranplase pa table.row-header pou th[scope="row"].
table.headtheadGwoup ranje tèt tablo a (InstUI Table.Head).
table.rowtrYon ranje tablo (InstUI Table.Row).
table.row-headerth[scope="row"]Yon selil tèt ranje (InstUI Table.RowHeader); estilize soti nan tokens tèt ranje yo, pa sa ki pou tèt kolòn yo.
tabs.instui-tabsYon seri panèl ak tab: yon lis tab, tab seleksyone, ak panèl yo.
tabs.panel.panelPanèl kontni pou yon tab (InstUI Tabs.Panel).
tabs.tab.tabYon sèl bouton tab (InstUI Tabs.Tab, configured via parent Tabs's tab list); -selected make youn ki aktif la.
tag.instui-tagYon chip an liy pou yon mo kle oswa filtè.
text.instui-textTipografi tèks kò ak modifye gwosè, pwa, koulè, ak estil.
text-area.instui-text-areaYon <textarea> natif estilize, rezizable, ak menm eta ak gwosè kòm antre tèks la.
text-input.instui-text-inputYon <input> natif estilize — enkli date, time, ak datetime-local, kote navigatè a bay picker la — ak eta validasyon ak gwosè.
toggle-details.instui-toggle-detailsYon <details> natif estilize disclosure ak yon chevron ki vire.
toggle-group.instui-toggle-groupYon disclosure ak bor bati sou <details>: yon ranje rezime chevron ak kontni kolapsab.
tooltip.instui-tooltipYon bul tooltip CSS pou hover ak focus, pozisyone sou nenpòt bò.
tray.instui-trayYon panèl pinen sou kwen ki glise depi nenpòt bò; yon [popover] natif oswa <dialog>.
tree-browser.instui-tree-browserYon pyebwa disclosure ak koleksyon nidifye ak atik fèy, ak chevron ki vire.
view.instui-viewPrimiti View la: yon bwat netral ak modifye kle-valè pou background, bor, radius, lonbraj, ekspozisyon, pozisyon, debòde, ak kousè. Chak youn nan modifye sa yo disponib tou globalman (bare, oswa chèn sou nenpòt lòt konponent) — wè utiliti background/border/shadow/display/position/overflow/cursor.

Itilite

NonKlasRezime
color.--text-dangerUtiliti koulè semantik: .--bg-<name>, .--text-<name> (aliase kòm .--color-<name>), ak .--border-<name> pou palèt semantik kouvri a. Chak youn nan sa yo gen tou yon alias modifye atache a konpozan (pa egzanp -bg-danger sou nenpòt .instui-<component>).
cursor.--cursor-pointercursor kòm yon klas global konpoze — .--cursor-<value> — ki ka itilize bare oswa chèn sou nenpòt konpozan (.instui-button.--cursor-pointer).
gap.--gap-mdUtiliti flex/grid gap sou echèl espas la, òt (--gap-sm) oswa long (--gap-small) òtograf. Kapab itilize bare oswa chèn sou nenpòt konpozan (.instui-view.--gap-sm) — konpozan ki deja mete pwòp gap yo pa yon token espesifik ka gen li ranplase.
icon.instui-iconSistèm ikon an: gwosè .instui-icon plis pent ki pataje -icon-<name> ki kouvri yon glif (nan currentColor) anvan nenpòt eleman.
layout.--display-flexUtiliti ekspozisyon ak aliman tèks — .--display-<value> ak .--text-align-<value> — kòm klas global konpoze, ki ka itilize bare oswa chèn sou nenpòt konpozan.
maskglobal.--mask-overlayYon kopi dual global nan modifye overlay konpozan mask la — --mask-overlay, --mask-fullscreen, --mask-blur — kap itilize bare oswa chèn sou nenpòt konpozan, san anvlòp nan yon eleman .instui-mask.
overflow.--overflow-x-hiddenoverflow-x/overflow-y kòm klas global konpoze — .--overflow-x-<value> / .--overflow-y-<value> — kap itilize bare oswa chèn sou nenpòt konpozan.
position.--position-relativeposition kòm yon klas global konpoze — .--position-<value> — kap itilize bare oswa chèn sou nenpòt konpozan (.instui-button.--position-relative).
responsive[class*="-hidden-"],[class*="-show-"]Klas montre/kache sou lajè Viewport oswa konteynè atravè yon echèl breakpoint tèm.
screen-reader-content.instui-screen-reader-contentKache vizyèlman kontni pandan w kenbe li disponib pou teknoloji asistans (modèl clip estanda).
spacing.--p-mdItilite margin ak padding — .--m<side>-<step> / .--margin-<side>-<step> ak .--p<side>-<step> / .--padding-<side>-<step> sou echèl espas (bò t/b/s/e/x/y oswa pa gen youn, ekri kout oswa long — pa egzanp --mb-sm ak --margin-bottom-small se menm règ la; margin pran tou auto). Ka itilize poukont oswa chenn sou nenpòt konpozan (pa egzanp class="instui-view --mb-sm").
stacking.--stack-topmostItilite pwofondè z-index — .--stack-<level> (deepest, below, above, topmost) — ka itilize poukont oswa chenn sou nenpòt konpozan, konsa kouch yo empile previzib olye de lè w ap sèvi ak nimewo reglaj manyèl.
transition.instui-transition.-transition-fade-enteringKlas eta animasyon pou konpozan Transition.instui-transition ak klas eta (-transition-fade-entering, -transition-scale-exited, elatriye) — ka itilize poukont oswa chenn sou nenpòt konpozan.
truncate.--truncateTroncature ak elips ak konpresyon liy kontwole pa --lines — ka itilize poukont oswa chenn sou nenpòt konpozan (.instui-button.--truncate).
visual-debug.-with-visual-debugYon kontou pou débogaj layout: konpoze .-with-visual-debug sou nenpòt eleman pou trase bwat la ak timoun imedya li yo, konsa estrikti layout la vizib an yon kout je.

Règleman

NonKlasRezime
base*Reset global opt-in: box-sizing, sifas paj la, koulè tèks baz ak polis, color-scheme, ak defo lyen yo.
prose:where(body)Default tipografik pou HTML brit — tit, paragraf, lis, lyen, ak kòd — aplike otomatikman kote li enpòte (default :where(body)); pase options.scope pou vize yon rasin kontni diferan (egzanp .vp-doc).

Plugins

NonKlasRezime
logos.logosLogo pwodwi Instructure kòm token imaj CSS: --instui-logo-<product>-<layout>-<mode> kenbe yon SVG data-URI, konsa yon logo ka pentire pa egzanp background-image: var(--instui-logo-canvas-horizontal-color).
primitives.instui-bg-primitive-color-whiteKlas sèvis opt-in pou palèt primitif brit la: .instui-bg-/fg-/border-primitive-color-<name> pentire yon koulè soti nan token koulè primitif yo, plis itilite font-family/font-weight pou token polis primitif yo. Kenbe yo izole nan itilite semantik yo pou override yo rete sèlman semantik.
visual-debug.-with-visual-debugYon kontou pou débogaj layout: konpoze .-with-visual-debug sou nenpòt eleman pou trase bwat la ak timoun imedya li yo, konsa estrikti layout la vizib an yon kout je.

layout

NonKlasRezime
calloutdiv[class~="instui-callout"]Alèt enfòmasyon anliy pou yon rapèl kout oswa nòt.
herodiv[class~="instui-hero"]Seksyon header lajè tout ekran ak tit, sou-tit, ak imaj background opsyonèl.
page-layoutdiv[class~="instui-page-layout"]Layout paj estanda twa kolòn ak header, sidebar, ak kontni prensipal.
rubric-notediv[class~="instui-rubric-note"]Nòt estriktire ak kategori rubrik ak endikatè nòtaj.
testimonialdiv[class~="instui-testimonial"]Afichaj sitasyon oswa temwayaj ak atribisyon ak imaj opsyonèl.
two-columndiv[class~="instui-two-column"]Layout de kolòn ak rejyon kontni gòch ak dwat.
wrapperbody[class~="instui-display-flex"]Ranje app-shell: nav bò, kontenè ak header, ak yon panèl opsyonèl.