Skip to content

CSS מדריך API

מדריך ה־CSS API מכסה את שכבת הרכיבים המבוססת על מחלקות של pantoken: רכיבים, כלים, כללי גלובל והצהרות הבנויים על מערכת הטוקנים.

רכיבים

שםמחלקהסיכום
agent-shell.instui-agent-shellמיכל משטחי למפעילי AI.
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בקרת פעולה ניתנת לנגישות, מעוצבת מתוך פלטת הטוקנים; ראשי כברירת מחדל.
byline.instui-bylineאובייקט מדיה: דמות גיבור לצד כותרת ותיאור.
calendar.instui-calendarגריד חודשי סטטי עם ניווט, כותרות ימי השבוע ותאי יום.
calendar.day.dayתא יום (InstUI Calendar.Day); -today, -selected ו־-outside-month מסמנים את מצבו.
card.instui-cardמיכל משטח המקבל תוכן שרירותי.
checkbox.instui-checkboxתיבת סימון מקומית ותווית שלה, או מתג באמצעות -variant-toggle.
close-button.instui-close-buttonכפתור אייקון שקוף המצייר את צל ה־× שלו, בשלושה גדלים ובגרסת on-color.
context-view.instui-context-viewקריאה מוגבהת עם חרטום, ניתנת למיקום מכל צד; פועלת כ־[popover] מקומי.
drawer-layout.instui-drawer-layoutפריסה מפוצלת עם מגירת צד מתקפלת וממשק תוכן ראשי הניתן לגלילה.
drawer-layout.content.contentמשטח התוכן הראשי שממלא את השטח הנותר לצד המגירה.
drawer-layout.tray.trayלוח צדדי לצד התוכן הראשי, עם אפשרות להטלה מעל ועם מסננים הדומים למגירה.
file-drop.instui-file-dropאזור השלכת קבצים עם מצבי hover, accepted ו־rejected.
form-field.instui-form-fieldעטיפת שדה טופס: תווית, הבקרים שלה ופריסות inline, required או readonly.
form-field-group.instui-form-field-groupקבוצת <fieldset> עם אגדה, פריסת עמודה או inline וריווח ניתן לקונפיגורציה.
form-field-messages.instui-form-field-messagesעזרה לשדה והודעות ולידציה — רמז, שגיאה, הצלחה ו־screen-reader-only — עם גליף בשגיאה ובהצלחה.
heading.instui-headingטיפוגרפיית כותרות מ־-level-h1 עד -level-h6.
img.instui-img<img> מעוצב עם modifiers של תצוגה, חיתוך ואפקט שמערמים זה על זה.
in-place-edit.instui-in-place-edit‏[contenteditable] שמתנהג כטקסט עד שמקבל פוקוס, ואז מציג ממשק קלט.
input-group.instui-input-groupחזית סביב שדה טקסט עם חריצי אייקון מובילים וסופיים.
link.instui-linkקישור מעוצב עם גדלים, וריאנט הפוך לרקעים כהים, ופורמות inline או לא מעוצבות.
list.instui-listרשימה עם ריווח פריטים מונע על ידי טוקנים.
list.item.instui-listפריט רשימה (InstUI List.Item).
mask.instui-maskשכבת překryv בזרם שממלאת את ההורה הממוקם וממרכזת את תוכנה — לדוגמה ספינר מעל כרטיס. עבור מודל, העדיף <dialog> מקומי (ה־::backdrop שלו הוא המסיכה). כל אחד מהמשננים האלה זמין גם גלובלית (נקי, או שרשור על כל רכיב אחר) — ראו את תועלת הגלובלית mask.
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> מקומי); חלקי כותרת/גוף/תחתית.
modal.body.bodyאזור התוכן (InstUI Modal.Body); <img> בודד מתפרש ל־full-bleed.
modal.footer.footerשורת הפעולות (InstUI Modal.Footer).
modal.header.headerשורת הכותרת (InstUI Modal.Header).
number-input.instui-number-inputחזית קלט מספרי עם עמודת ספינר +/-.
pagination.instui-paginationניווט דפי עמוד: דפים ממוספרים, חצים לראשון, הקודם, הבא והאחרון, ואליפסה לפערים.
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סליידר טווח מעוצב עם בועת ערך הפוכה.
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> מקומי מעוצב עם סירת סימון (caret), התואם למצבי וגודלי שדה הטקסט.
spinner.instui-spinnerטבעת טעינה מונפשת; תנו לה role="status" ו-aria-label.
table.instui-tableטבלת נתונים מעוצבת עבור th ו-td בתוספת כותרת אופציונלית, עם מצבי ריחוף, פריסה קבועה ופריסת כרטיסים מוערמת.
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גילוי (disclosure) מקומי מעוצב <details> עם שרוול/חץ מסתובב (chevron).
toggle-group.instui-toggle-groupגילוי מקושט עם מסגרת המבוסס על <details>: שורת סיכום עם chevron ותוכן מתקפל.
tooltip.instui-tooltipבועת טולטיפ (tooltip) עם hover ו-focus ב-CSS, ניתנת למיקום מכל צד.
tray.instui-trayפאנל מוצמד לקצה שנכנס מחלק כלשהו; יכול להיות [popover] או <dialog> מקומי.
tree-browser.instui-tree-browserעץ גילויים (disclosure) של אוספים מקוננים ופריטים עלים, עם chevrons מסתובבים.
view.instui-viewהפרימיטיב View: תיבה ניטרלית עם מודיפיירים של מפתח-ערך עבור רקע, גבול, רדיוס, צל, תצוגה, מיקום, גלישה וסמן. כל אחד מהמודיפיירים האלה זמין גם כגלובלי (חסר או שרשרת על כל קומפוננטה) — ראו את כלי העזר background/border/shadow/display/position/overflow/cursor.

כלים עזר (Utilities)

שםמחלקהסיכום
color.--text-dangerכלי עזר לצבעים סמנטיים: .--bg-<name>, .--text-<name> (מכונה גם .--color-<name>), ו-.--border-<name> לפלטת הצבעים הסמנטית הממוינת. לכל אחד מהם יש גם מודיפייר מקושר לקומפוננטה (למשל -bg-danger על כל .instui-<component>).
cursor.--cursor-pointercursor כ-class גלובלי קומפוזבילי — .--cursor-<value> — שניתן להשתמש בו בקלות או כשרשרת על כל קומפוננטה (.instui-button.--cursor-pointer).
gap.--gap-mdכלי עזר של Flex/Grid gap על סקלת הריווח, באיות קצר (--gap-sm) או ארוך (--gap-small). שניתנים לשימוש לבדם או כשרשרת על כל קומפוננטה (.instui-view.--gap-sm) — קומפוננטות שכבר קובעות את ה-gap שלהן מאסימון קומפוננטה ספציפי עלולות לראות זאת מוחלף.
icon.instui-iconמערכת האייקונים: גודל .instui-icon בתוספת הצובע המשותף -icon-<name> שמסכה גליף (ב-currentColor) לפני כל אלמנט.
layout.--display-flexכלי עזר לתצוגה וליישור טקסט — .--display-<value> ו-.--text-align-<value> — כקלאסים גלובליים קומפוזביליים, לשימוש בודד או כשרשרת על כל קומפוננטה.
maskglobal.--mask-overlayעותק גלובלי כפול של מודיפיירי-overlay של קומפוננטת mask--mask-overlay, --mask-fullscreen, --mask-blur — שניתנים לשימוש בודד או כשרשרת על כל קומפוננטה, ללא עטיפה ב-element .instui-mask.
overflow.--overflow-x-hiddenoverflow-x/overflow-y כקלאסים גלובליים קומפוזביליים — .--overflow-x-<value> / .--overflow-y-<value> — לשימוש בודד או כשרשרת על כל קומפוננטה.
position.--position-relativeposition כ-class גלובלי קומפוזבילי — .--position-<value> — לשימוש בודד או כשרשרת על כל קומפוננטה (.instui-button.--position-relative).
responsive[class*="-hidden-"],[class*="-show-"]מחלקות הצגה/הסתרה לפי רוחב תצוגה או מיכל על פני סקלת נקודות שבירה בנושא.
screen-reader-content.instui-screen-reader-contentמסתיר תוכן ויזואלית תוך שמירה על נגישותו לטכנולוגיות סיוע (תבנית ה-clipping הסטנדרטית).
spacing.--p-mdתועלות מרווחים ו-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-topmostתועלות עומק z-index — .--stack-<level> (deepest, below, above, topmost) — שניתנות לשימוש כשלעצמן או כשרשור לכל קומפוננטה, כדי ששכבות יערמו בצורה ניתנת לחיזוי במקום מספרים מכוילים ידנית.
transition.instui-transition.-transition-fade-enteringמחלקות מצב אנימציה עבור קומפוננטת Transition.instui-transition ומחלקות מצב (-transition-fade-entering, -transition-scale-exited, וכו') — שניתנות לשימוש כשלעצמן או כשרשור לכל קומפוננטה.
truncate.--truncateקיצור טקסט עם אליפסיס ונעילת שורות הנשלטת על ידי --lines — שניתן להשתמש בה כשלעצמה או כשרשור לכל קומפוננטה (.instui-button.--truncate).
visual-debug.-with-visual-debugקווי מתאר לאיתור בעיות פריסה: שרשרו .-with-visual-debug לכל אלמנט כדי למסגר את התיבה ואת ילדיו המידיים, כך שמבנה הפריסה יהיה ניראה במבט חטוף.

חוקים

שםמחלקהסיכום
base*איפוס גלובלי בבחירה: box-sizing, משטח הדף, צבע וטיפוגרפיית בסיס, color-scheme והגדרות קישור ברירת מחדל.
prose:where(body)הגדרות טיפוגרפיה ברירת מחדל ל-HTML גולמי — כותרות, פסקאות, רשימות, קישורים וקוד — מוחלות אוטומטית בכל מקום שמייבא אותן (ברירת מחדל :where(body)); העבר options.scope כדי לכוון לשורש תוכן אחר (למשל .vp-doc).

Plugins

שםמחלקהסיכום
logos.logosלוגואים של מוצרי Instructure כטוקנים של תמונת CSS: --instui-logo-<product>-<layout>-<mode> מכיל data-URI של SVG, כך שלוגו מצויר לדוגמה באמצעות background-image: var(--instui-logo-canvas-horizontal-color).
primitives.instui-bg-primitive-color-whiteמחלקות שירות אופציונליות לפלטת הפרימיטיבים הגולמית: .instui-bg-/fg-/border-primitive-color-<name> צובעות צבע מתוך טוקני הצבע הפרימיטיביים, בנוסף ל-font-family/font-weight עבור טוקני הגופן הפרימיטיביים. נשמרות מחוץ לתועלות הסמנטיות כך שההחלפות שם יישארו סמנטיות בלבד.
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"]הערה מובנית עם קטגוריות שיפוט ומדדי ניקוד.
testimonialdiv[class~="instui-testimonial"]תצוגת ציטוט או עדות עם ייחוס ותמונות אופציונליות.
two-columndiv[class~="instui-two-column"]פריסת שתי עמודות עם אזורי תוכן שמאל וימין.
wrapperbody[class~="instui-display-flex"]שורת app-shell: ניווט צדדי, מכולה עם כותרת ולוח אופציונלי.