Skip to content

CSS API حوالագիր

CSS API հղումը ընդգրկում է pantoken-ի դաս-ամենայն компонենտային շերտը՝ components, utilities, global rules և declarations, որոնք կառուցված են token համակարգի վրա։

Ակումբներ

ԱնունԴասԱմփոփում
agent-shell.instui-agent-shellAI գործակալների տեսողական տարա։
alert.instui-alertՄի ինլայն հաղորդագրություն՝ կարգավիճակի գունային գծով և համատարած կցագլխիկից масկացված կարգավիճակի պատկերակով։
avatar.instui-avatarՕգտվողի аваտար՝ ցուցադրվում են սկզբնատառերը կամ պատկերն, ի սկզբանե շրջանաձեւ։
badge.instui-badgeՓոքր հաշիվ կամ կարգավիճակի կետ, տեղակայված թիրախի անկյունում։
banner.instui-bannerՀետ հանվող, պատկերակով հաղորդագրության մակերես՝ էջային կամ տեղային հայտարարությունների համար։
billboard.instui-billboardՄեծ դատարկ-կարգավիճակի կամ գործողության կոչման բլոկ՝ հերո պատկերակ կամ պատկեր, վերնագրով և հաղորդագրությամբ։
breadcrumb.instui-breadcrumbՏեղորոշիչ ուղի՝ բաժանարարներով; վերջին խաչքը ներկայիս էջն է։
breadcrumb.linkliՄեկ խաչք (InstUI Breadcrumb.Link), <li> ծնողի <ol>-ի մեջ; վերջինը հանդիսանում է ներկայիս էջը։
button.instui-buttonՄեկ հասանելի գործողության կոճակ, ձևավորված token փայտով; որպես դեֆոլտ՝ primary։
byline.instui-bylineՄեդիա օբյեկտ՝ հերո լուսանկար/ֆիգուրի կողքին վերնագիր և մանրամասներ։
calendar.instui-calendarՍտատիկ ամսվա ցանց՝ նավիգացիայով, շաբաթվա օրերի վերնագրերով և օրվա բջիջներով։
calendar.day.dayՕրվա բջիջ (InstUI Calendar.Day); -today, -selected, և -outside-month նշում են դրա վիճակը։
card.instui-cardՄակերեսային տարա, որը ընդունում է ցանկացած պարունակություն։
checkbox.instui-checkboxՆատիվ checkbox և նրա պիտակ, կամ սկիչ՝ -variant-toggle միջոցով։
close-button.instui-close-buttonԹափանցիկ պատկերակ-կոճակ, որը կերտում է իր × պատկերակը, երեք չափսով և on-color տարբերակով։
context-view.instui-context-viewԲարձրացված կոչում քեռով (caret), կարող է դիրքավորվել ցանկացած կողմում; գործում է որպես նատիվ [popover]։
drawer-layout.instui-drawer-layoutՄիջնատարավակ կառուցվածք՝collapsible կողային տուփով և հիմնական գրանցվող պարունակության փնջով։
drawer-layout.content.contentՀիմնական պարունակության պատուհան, որը լցնում է մնացած տարածքը տուփի կողքին։
drawer-layout.tray.trayԿողային պանել՝ հիմնական պարունակության կողքին, ընտրված ֆոնի և տրայ-լայն մակերեսի մոդիֆայերեններով։
file-drop.instui-file-dropՖայլերի dropzone՝ hover, ընդունված և մերժված վիճակներով։
form-field.instui-form-fieldՖորմ-ֆիլդի обյեկտ՝ պիտակ, նրա կառավարչական տարաներ և ինլայն/պարտադիր/readonly դասակարգեր։
form-field-group.instui-form-field-group<fieldset> խումբ՝ լեգենդով, սյունային կամ ինլայն դասավորությամբ և կարգավորելի տեղաշարժով։
form-field-messages.instui-form-field-messagesԲաղադրիչի օգնության և վալիդացիայի հաղորդագրություններ՝ hint, error, success և միայն էկրան-կարդացողի համար՝ սխալի և հաջողության դեպքում պատկերակով։
heading.instui-headingՎերնագրային տիպոգրաֆիա -level-h1-ից -level-h6-ը։
img.instui-imgՁևավորված <img>՝ display, crop և effect մոդիֆայերով, որոնք տեղափոխվում են stack-ով։
in-place-edit.instui-in-place-edit[contenteditable] ֆասադ՝ որպես տեքստ ընթերցելի մինչև ֆոկուս, այնուհետև ցուցադրում է ինպուտի UI։
input-group.instui-input-groupՏեքստային input-ի կեղծ դիմաքեր՝ առջևի և հետևի պատկերակ-սլոտներով։
link.instui-linkՖորմավորված հիպերհղում՝ չափերով, հակառակ տարբերակ մուգ ֆոնների համար և ինլայն կամ առանց ոճի ֆորմաներով։
list.instui-listՑուցակ՝ token-ից ղեկավարվող իրերի միջակայքով։
list.item.instui-listՑուցակի տարր (InstUI List.Item).
mask.instui-maskԸստ հոսքի overlays, որը լցնում է դիրքավորված ծնողը և կենտրոնացնում իր պարունակությունը — օրինակ՝ սփինները քարտի վրա։ Մոդալների համար նախընտրելի է նատիվ <dialog> (խանութը ::backdrop է). Այս մոդիֆայերների յուրաքանչյուրն էլ հասանելի է գլոբալորեն (անմաքուր կամ chained onto այլ կոմպոնենտ) — տես mask գլոբալ utility։
menu.instui-menuԵնթելիվող իրերի, խմբերի և բաժանարարների dropdown մակերես։
menu.group.groupՊիտակավորված խմբի վերնագիր (InstUI Menu.Group/Menu.ItemGroup).
menu.item.itemՄենյու մուտք (InstUI Menu.Item); ավելացնել -disabled, -highlighted կամ -active/[aria-checked]։
menu.separator.separatorՄիջտարային բաժանարար կանոն (InstUI Menu.Separator).
metric.instui-metricՊիտակավորված վիճակագրություն — մեծ արժեք կենտրոնում և ենթագրություն։
modal.instui-modalԴիալոգային մակերես (աշխատի նատիվ <dialog>-ի վրա); header/body/footer մասեր։
modal.body.bodyՊարունակության երկիր (InstUI Modal.Body); միայնակ <img> թափվում է ամբողջ լայնությամբ։
modal.footer.footerԳործողությունների տողը (InstUI Modal.Footer).
modal.header.headerՎերնագրի տողը (InstUI Modal.Header).
number-input.instui-number-inputԹվային ինփութի ֆասադ՝ +/- սփինνώային սյունով։
pagination.instui-paginationԷջային նավիգացիա՝ թվային էջեր, առաջին, նախորդ, հաջորդ և վերջին սլաքներ, և elipsis բացարձակման համար։
pagination.page.pageԷջի հղում կամ կոճակ (InstUI Pagination.Page); ներկայիս էջը կրում է [aria-current]։
pill.instui-pillԿոմպակտ կարգավիճակի պիտակ; ավելացնել առաջատարը պատկերակ՝ փոխկապակցված -icon-<name> ձևով։
popover.instui-popoverԲարձրացված մակերես նատիվ [popover]-ի համար, դիրքավորված CSS anchor positioning-ով։
progress.instui-progressՆորոշվող պրոգրես-բար՝ գունավոր չափիչով, չափսերով և ընտրովի արժեք պիտակով։
progress-circle.instui-progress-circleՏռամած պրոգրես օղակ՝ ղեկավարվող --value և --value-max անունով կասթոմ հատկություններով։
radio.instui-radioՆատիվ ռադիո-կոճակ և նրա պիտակ։
radio-input-group.instui-radio-input-groupՄեկ ընտրությամբ ռադիո <fieldset>, պարզ կամ որպես միացած բաժանված տոգլ։
range-input.instui-range-inputՁևավորված range slider՝ հակառակ արժեքի բուբլով։
rating.instui-ratingԻր լրացված և դատարկ պատկերակներով աստղային գնահատման համակարգ, տարբերակով թվային պիտակով։
side-nav-bar.instui-side-nav-barՎերագրային նավիգացիոն ռել՝ պատկերակ-վերիքային տողերով, և մինիմալացված միայն պատկերակների ռեժիմ։
side-nav-bar.item.itemՆավիգացիոն գրանցում (InstUI SideNavBar.Item); -selected նշում է ակտիվին։
simple-select.instui-simple-selectՊայմանավորված տեսքով տեղական <select>՝ գուրտով, համընկնող տեքստային ինփութի վիճակների և չափերի հետ։
spinner.instui-spinnerԱնիմացված լոադինգ-շրջան; հատկացրեք role="status" և aria-label։
table.instui-tableՊայմանավորված տվյալների աղյուսակ th և td-ի համար՝ նաև տարբերակով ենթագրով, hover, fixed և stacked-card макետներով։
table.bodytbodyԱղյուսակի տվյալների տողերի խումբը (InstUI Table.Body).
table.celltdՏվյալների բջիջ (InstUI Table.Cell).
table.col-headerthՍյունակի-վերըցող բջիջ (InstUI Table.ColHeader); ստանդարտ th ոճավորում, որը վերազատվում է table.row-header-ով th[scope="row"]-ի համար։
table.headtheadԱղյուսակի վերնագրի տողերի խումբը (InstUI Table.Head).
table.rowtrԱղյուսակի տող (InstUI Table.Row).
table.row-headerth[scope="row"]Տող-վերըցող բջիջ (InstUI Table.RowHeader); ոճավորված է տող-վերըցող տոկեններով, ոչ սյունակ-վերըցողներով։
tabs.instui-tabsՏաբ-պանելների հավաքակազմ՝ տաբերի ցանկ, ընտրվող տաբեր և դրանց պանելները։
tabs.panel.panelՏաբի պարունակության պանել (InstUI Tabs.Panel).
tabs.tab.tabՄեկ տաբ-կոճակ (InstUI Tabs.Tab, կարգավորված ծնողական Tabs-ի տաբ ցանկով); -selected նշում է ակտիվին։
tag.instui-tagԸնդգծված չիպ՝ հիմնաբառի կամ ֆիլտրի համար։
text.instui-textՄարմնի տեքստի տիպոգրաֆիա՝ չափով, ծանրությամբ, գույնով և ոճային մոդիֆիկատորներով։
text-area.instui-text-areaՊայմանավորված, փոփոխվող բնիկ <textarea>՝ նույն վիճակներով և չափերով, ինչ տեքստային ինփութը։
text-input.instui-text-inputՊայմանավորված բնիկ <input>՝ ներառելով date, time և datetime-local, որտեղ բրաուզերը տրամադրում է ընտրիչը՝ վավերացման վիճակներով և չափերով։
toggle-details.instui-toggle-detailsՊայմանավորված բնիկ <details> բացվողը պտտվող չևրոնով։
toggle-group.instui-toggle-groupԴեմարկացված բացվող՝ կառուցված <details>-ի վրա՝ չևրոնային վերնագիր և սեղմվող բովանդակություն։
tooltip.instui-tooltipCSS hover և focus tooltip փուչիկ, դիրքավորվող ցանկացած կողմում։
tray.instui-trayԵզրակից կցվող պանել, որը սլայդով մտնում է ցանկացած կողմից; բնիկ [popover] կամ <dialog>։
tree-browser.instui-tree-browserԲացվող ծառ՝ նեստացված հավաքումներով և եզրափակիչ տարրերով, պտտվող չևրոններով։
view.instui-viewView պրիմիտիվը՝ նյուտրալ արկղ՝ բանալի-արժեք մոդիֆիկատորներով՝ ֆոն, եզր, ռադիուս, ստվեր, display, position, overflow և cursor։ Այս բոլորը նաև գլոբալ հասանելի են՝ տես background/border/shadow/display/position/overflow/cursor օգտակարություններում։

Օգտակար գործիքներ

ԱնունԴասԱմփոփում
color.--text-dangerՍեմանտիկ գույնի օգտակարություններ՝ .--bg-<name>, .--text-<name> (այլատրված որպես .--color-<name>) և .--border-<name> ընտրված սեմատիկ պալետայի համար։ Յուրաքանչյուրն ունի նաև կոմպոնենտին կցված ալիաս մոդիֆիկատոր (օրինակ -bg-danger ցանկացած .instui-<component>-ի վրա).
cursor.--cursor-pointercursor որպես կոմպոզիտային, գլոբալ կլաս — .--cursor-<value> — օգտագործելի խիստ կամ շղթանով ցանկացած կոմպոնենտի վրա (.instui-button.--cursor-pointer).
gap.--gap-mdFlex/grid gap օգտակարություններ՝ spacing սանդղակով, կարճ (--gap-sm) կամ երկար (--gap-small) ձևավորումով։ Օգտագործելի խիստ կամ շղթայական ցանկացած կոմպոնենտի վրա (.instui-view.--gap-sm) — այն կոմպոնենտները, որոնք արդեն սահմանում են իրենց gap կոմպոնենտ-սպեցիֆիկ տոկենից, կարող են վերազատվել։
icon.instui-iconՆշանի համակարգը՝ .instui-icon չափավորում և ընդհանուր -icon-<name> նկարչի մեսին, որը.mask-ով պատում է պատկերակը (ուտ currentColor) նախքան որևէ էլեմենտ։
layout.--display-flexՑուցադրում և տեքստի աջակողմյան օգտակարություններ — .--display-<value> և .--text-align-<value> — որպես կոմպոզիտային, գլոբալ կլասեր, օգտագործելի խիստ կամ շղթայական ցանկացած կոմպոնենտի վրա։
maskglobal.--mask-overlayԳլոբալ, երկակի կպչուն կրկնօրինակ mask կոմպոնենտի օվերլեյ մոդիֆիկատորների — --mask-overlay, --mask-fullscreen, --mask-blur — կիրառելի խիստ կամ շղթայական ցանկացած կոմպոնենտի վրա, առանց .instui-mask էլեմենտով փաթաթելու։
overflow.--overflow-x-hiddenoverflow-x/overflow-y որպես կոմպոզիտային, գլոբալ կլասեր — .--overflow-x-<value> / .--overflow-y-<value> — օգտագործելի խիստ կամ շղթայական ցանկացած կոմպոնենտի վրա։
position.--position-relativeposition որպես կոմպոզիտային, գլոբալ կլաս — .--position-<value> — օգտագործելի խիստ կամ շղթայական ցանկացած կոմպոնենտի վրա (.instui-button.--position-relative).
responsive[class*="-hidden-"],[class*="-show-"]Տեսկոնի կամ կոնտեյների լայնությամբ ցուցադրելու/թաքցնելու կլասեր՝ թեմայացրված breakpoint սանդղակով։
screen-reader-content.instui-screen-reader-content視ողաբար թաքցնում է բովանդակությունը՝ այն թողնելով հասանելի օգնական տեխնոլոգիաների համար (סטանդարտ clip օրինակ).
spacing.--p-mdMargin և padding օգտակար դասեր — .--m<side>-<step> / .--margin-<side>-<step> և .--p<side>-<step> / .--padding-<side>-<step> ըստ բացվածքի մասշտաբի (կողքեր t/b/s/e/x/y կամ առանց, կարճ կամ առկա ամբողջ տառերով — օրինակ --mb-sm և --margin-bottom-small նույն կանոնն են; margin-ը նաև ընդունում է auto). Կարելի է օգտագործել մաքուր կամ ցանկացած компонентի վրա շղթայականորեն ավելացնելով (օր. class="instui-view --mb-sm").
stacking.--stack-topmostz-index մակարդակի օգտակար դասեր — .--stack-<level> (deepest, below, above, topmost) — կարող են օգտագործվել մաքուր կամ ցանկացած կոմպոնենի հետ շղթայական՝ դարձնելով շերտերի հերթապահությունը կանխատեսելի՝ ոչ թե ձեռքով կարգավորվող թվերով։
transition.instui-transition.-transition-fade-enteringTransition կոմպոնենտի անիմացիայի վիճակային դասեր — .instui-transition և վիճակային դասեր (-transition-fade-entering, -transition-scale-exited, և այլն) — հնարավոր է օգտագործել մաքուր կամ ցանկացած կոմպոնենթի վրա շղթայական։
truncate.--truncateԵզրագծային կարճացում (ellipsis)՝ տողերի սահմանմամբ՝ կառավարվում է --lines-ով — կարելի է օգտագործել մաքուր կամ որևէ կոմպոնենթի հետ շղթայական (.instui-button.--truncate).
visual-debug.-with-visual-debugՑուցադրման դաշտի սխեմատիկ կմախք-որոշիչ՝ կոմպոզիտ .-with-visual-debug ավելացնելով ցանկացած էլեմենտի վրա՝ նշելու տուփն ու նրա անմիջական երեխաներին, որպեսզի макետի կառուցվածքը ակնթարթորեն տեսանելի լինի։

Որոնման կանոններ

ԱնունԴասԱմփոփում
base*Ընտրովի գլոբալ վերագործարկում (reset): box-sizing, էջի մակերեսը, հիմնական տեքստի գույնը և ֆոնը, color-scheme և հիպերհղման (link) ստանդարտները։
prose:where(body)Համատիպաֆոնտային (typographic) ստանդարտներ հում HTML-ի համար — վերնագրեր, պարբերություններ, ցանկեր, հղումներ և կոդ — ավտոմատ կիրառվում են այնտեղ, ուր ներմուծված է (դեֆոլտ :where(body)); փոխանցեք options.scope այլ բովանդակային արմատին թիրախելու համար (օր. .vp-doc).

Plugins

ԱնունԴասԱմփոփում
logos.logosInstructure ապրանքանիշի լոգոները որպես CSS նկարային տոկեններ՝ --instui-logo-<product>-<layout>-<mode> պահում է data-URI SVG, այնպես որ լոգոն նկարահանվում է, օրինակ, background-image: var(--instui-logo-canvas-horizontal-color)-ով։
primitives.instui-bg-primitive-color-whiteԸնտրովի օգտակար դասեր հում սկզբունքային (primitive) գունապնակի համար՝ .instui-bg-/fg-/border-primitive-color-<name> ներկում են գույներ սկզբունքային գույնի տոկեններից, և font-family/font-weight օգտակար ծառայություններ հիմնական ֆոնտի տոկենների համար։ Դրանք պահպանվում են semantic utility-ներից դուրս՝ որպեսզի այնտեղի վերագրումները մնան միայն սեմանտիկ։
visual-debug.-with-visual-debugՑուցադրման դաշտի սխեմատիկ կմախք-որոշիչ՝ կոմպոզիտ .-with-visual-debug ավելացնելով ցանկացած էլեմենտի վրա՝ նշելու տուփն ու նրա անմիջական երեխաներին, որպեսզի макետի կառուցվածքը ակնթարթորեն տեսանելի լինի։

layout

ԱնունԴասԱմփոփում
calloutdiv[class~="instui-callout"]Տողային ինֆորմացիոն զգուշացում՝ կարճ հիշեցման կամ նշման համար։
herodiv[class~="instui-hero"]Լայնածավալ վերնագրային բաժին՝ վերնագրով, ենթավերնագրով և ունակ ֆոնային պատկերով։
page-layoutdiv[class~="instui-page-layout"]Ստանդարտ երեք-սյունային էջի դասավորություն՝ վերնագրով, կողային մենյուով և հիմնական բովանդակությամբ։
rubric-notediv[class~="instui-rubric-note"]Strukturalized նոտա՝ ռուբրիկայի կատեգորիաներով և գնահատման նշիչներով։
testimonialdiv[class~="instui-testimonial"]Անմատաղձ կամ վկայություն ցուցադրություն՝ աղբյուրով (attribution) և ցանկության դեպքում պատկերով։
two-columndiv[class~="instui-two-column"]Երկու սյուների դասավորություն՝ ձախ և աջ բովանդակային շրջաններով։
wrapperbody[class~="instui-display-flex"]App-shell տող՝ կողմնային նավիգացիա, կոնտեյներով վերնագիր և ցանկության դեպքում պանել։