Skip to content

CSS مرجع API

رفرنس API CSS لایهٔ مؤلفه‌های مبتنی بر کلاس pantoken را پوشش می‌دهد: مؤلفه‌ها، ابزارها، قوانین سراسری و اعلان‌ها که بر پایهٔ سیستم توکن ساخته شده‌اند.

مولفه‌ها

نامکلاسخلاصه
agent-shell.instui-agent-shellیک کانتینر سطحی برای عوامل هوش مصنوعی.
alert.instui-alertیک پیام درون‌خطی با نوار رنگ وضعیت و یک نماد وضعیت ماسک‌شده از مجموعهٔ آیکون‌های مشترک.
avatar.instui-avatarآواتاری از کاربر که حروف ابتدای نام یا تصویر را نشان می‌دهد، به‌طور پیش‌فرض دایره‌ای.
badge.instui-badgeنقطهٔ شمارش یا وضعیت کوچک که روی گوشهٔ هدف قرار می‌گیرد.
banner.instui-bannerسطح پیام قابل بستن با آیکون برای اعلان‌های سطح صفحه یا در‌زمینهٔ محتوا.
billboard.instui-billboardبلوک بزرگی برای حالت خالی یا فراخوان به اقدام: یک آیکون یا تصویر قهرمان، یک عنوان و یک پیام.
breadcrumb.instui-breadcrumbردیف مسیر (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دکمهٔ آیکون شفاف که نماد × را رسم می‌کند، در سه اندازه به‌علاوهٔ یک نوع روی رنگ.
context-view.instui-context-viewکال‌آوت مرتفع با caret، قابل قرارگیری در هر ضلع؛ به‌عنوان [popover] بومی کار می‌کند.
drawer-layout.instui-drawer-layoutطرح‌بندی تقسیم‌شده با یک سینی جانبی جمع‌شونده و پنل محتوای اصلی قابل اسکرول.
drawer-layout.content.contentپنل محتوای اصلی که فضای باقی‌مانده کنار سینی را پر می‌کند.
drawer-layout.tray.trayپنل کناری کنار محتوای اصلی، با اورلی اختیاری و اصلاح‌کننده‌های سطحی شبیه سینی.
file-drop.instui-file-dropمنطقهٔ کشیدن فایل با حالات hover، پذیرفته‌شده و ردشده.
form-field.instui-form-fieldپوشش فیلد فرم: یک برچسب، کنترل‌های آن و طرح‌بندی‌های درون‌خطی، الزامی یا فقط‌خواندنی.
form-field-group.instui-form-field-groupگروه <fieldset> با یک افسانه، طرح ستونی یا درون‌خطی و فاصلهٔ قابل تنظیم.
form-field-messages.instui-form-field-messagesپیام‌های راهنما و اعتبارسنجی فیلد — راهنما، خطا، موفقیت و فقط‌خوانا برای صفحه‌خوان — با یک گلیف در حالت خطا و موفقیت.
heading.instui-headingتایپوگرافی سرفصل‌ها از -level-h1 تا -level-h6.
img.instui-imgیک <img> استایل‌داده‌شده با مودیفایرهای نمایش، برش و افکت که روی هم قرار می‌گیرند.
in-place-edit.instui-in-place-editیک [contenteditable] که تا هنگام فوکوس به‌صورت متن خوانده می‌شود، سپس کروم ورودی را نشان می‌دهد.
input-group.instui-input-groupروکش دور یک ورودی متن با اسلات‌های آیکون جلویی و عقبی.
link.instui-linkلینک استایل‌داده‌شده با اندازه‌ها، نوع معکوس برای پس‌زمینه‌های تاریک، و فرم‌های درون‌خطی یا بدون‌استایل.
list.instui-listفهرستی با فاصلهٔ اقلام مبتنی بر توکن.
list.item.instui-listیک آیتم فهرست (InstUI List.Item).
mask.instui-maskپوشش درون‌جریانی که والد موقعیت‌یافتهٔ خود را پر می‌کند و محتوایش را مرکز می‌کند — مثلاً یک spinner روی یک کارت. برای مودال، <dialog> بومی ترجیح داده می‌شود ( ::backdrop آن ماسک است). هر یک از این مودیفایرها نیز به‌صورت سراسری در دسترس هستند (بدون، یا زنجیره‌شده روی هر مؤلفهٔ دیگر) — نگاه کنید به ابزار سراسری mask.
menu.instui-menuسطح دراپ‌دان از آیتم‌ها، گروه‌ها و جداکننده‌ها.
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> تنها تمام عرض را اشغال می‌کند.
modal.footer.footerردیف عملیات (InstUI Modal.Footer).
modal.header.headerردیف عنوان (InstUI Modal.Header).
number-input.instui-number-inputروکش ورودی عددی با ستون spinner برای +/-.
pagination.instui-paginationناوبری صفحه: صفحات شماره‌گذاری‌شده، پیکان‌های نخست، قبلی، بعدی و آخر، و یک سه‌نقطه برای فاصله‌ها.
pagination.page.pageلینک یا دکمهٔ صفحه (InstUI Pagination.Page); صفحهٔ جاری دارای [aria-current] است.
pill.instui-pillبرچسب وضعیت فشرده؛ یک گلیف آغازین را با فرم مشترک -icon-<name> اضافه کنید.
popover.instui-popoverسطح مرتفع برای یک [popover] بومی، قرارگیری با موقعیت‌دهی لنگر CSS.
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 به‌علاوه یک کپشن اختیاری، با حالت‌های hover، طرح ثابت و طرح کارت‌پشته‌ای.
table.bodytbodyگروه ردیف‌های دادهٔ جدول (InstUI Table.Body).
table.celltdیک سلول داده (InstUI Table.Cell).
table.col-headerthیک سلول سربرگ ستون (InstUI Table.ColHeader)؛ استایل پیش‌فرض th که برای th[scope="row"] توسط table.row-header بازنویسی می‌شود.
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یک disclosure حاشیه‌دار مبتنی بر <details>: یک ردیف خلاصه با chevron و محتوای قابل جمع‌شدن.
tooltip.instui-tooltipیک حباب تولتیپ CSS برای حالت‌های hover و focus که قابل موقعیت‌دهی در هر سمت است.
tray.instui-trayیک پنل لبه‌پین‌شده که از هر سمت کشیده می‌شود؛ یک [popover] یا <dialog> بومی.
tree-browser.instui-tree-browserیک درخت disclosure از مجموعه‌های تو در تو و آیتم‌های برگ، با chevronهای چرخان.
view.instui-viewپریمیتیو View: یک جعبهٔ خنثی با تغییرگرهای کلید-مقدار برای پس‌زمینه، حاشیه، شعاع، سایه، نمایش، موقعیت، overflow و نشانگر ماوس. هر یک از این تغییرگرها همچنین به‌صورت سراسری در دسترس است (تنها یا متصل به هر مؤلفهٔ دیگر) — رجوع کنید به ابزارهای 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-mdابزارهای gap فلکس/گرید در مقیاس فاصله، املای کوتاه (--gap-sm) یا بلند (--gap-small). قابل استفاده تنها یا متصل به هر مؤلفه (.instui-view.--gap-sm) — مؤلفه‌هایی که قبلاً gap خود را از یک توکن مخصوص مؤلفه تنظیم کرده‌اند ممکن است بازنویسی شوند.
icon.instui-iconسیستم آیکون: اندازه‌دهی .instui-icon به‌علاوه painter مشترک -icon-<name> که پیش از هر عنصر، یک گلایف (در currentColor) را ماسک می‌کند.
layout.--display-flexابزارهای نمایش و تراز متن — .--display-<value> و .--text-align-<value> — به‌عنوان کلاس‌های ترکیبی و سراسری، قابل استفاده تنها یا متصل به هر مؤلفه.
maskglobal.--mask-overlayیک نسخهٔ دوگانهٔ سراسری از تغییرگرهای 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-"]کلاس‌های نمایش/مخفی‌سازی بر اساس عرض viewport یا کانتینر در یک مقیاس نقطهٔ توقف با تم.
screen-reader-content.instui-screen-reader-contentمحتوا را از دید پنهان می‌کند در حالی که برای فناوری‌های کمکی قابل دسترسی نگه می‌دارد (الگوی استاندارد clip).
spacing.--p-mdابزارک‌های حاشیه و فاصله داخلی — .--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> یک SVG داده-URI نگه می‌دارد، بنابراین یک لوگو از طریق مثلاً 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"]ردیف شِلفِ اپلیکیشن: ناوبری جانبی، کانتینری با سربرگ، و پنل اختیاری.