3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"shortcut icon" href=
"../../assets/default.favicon.ico">
13 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.0.5">
17 <title>CSS - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../assets/stylesheets/main.77f3fd56.min.css">
24 <link rel=
"stylesheet" href=
"../../assets/stylesheets/palette.7fa14f5b.min.css">
28 <meta name=
"theme-color" content=
"#009485">
38 <link rel=
"stylesheet" href=
"../../stylesheets/extra.css">
52 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
56 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
57 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
58 <label class=
"md-overlay" for=
"__drawer"></label>
59 <div data-md-component=
"skip">
62 <a href=
"#css" class=
"md-skip">
67 <div data-md-component=
"announce">
69 <aside class=
"md-announce">
70 <div class=
"md-announce__inner md-grid md-typeset">
72 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
81 <header class=
"md-header" data-md-component=
"header">
82 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
83 <a href=
"../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation">
85 <img src=
"../../assets/logo.png" alt=
"logo">
88 <label class=
"md-header__button md-icon" for=
"__drawer">
89 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
91 <div class=
"md-header__title" data-md-component=
"header-title">
92 <div class=
"md-header__ellipsis">
93 <div class=
"md-header__topic">
94 <span class=
"md-ellipsis">
95 WoltLab Suite Documentation
98 <div class=
"md-header__topic" data-md-component=
"header-topic">
99 <span class=
"md-ellipsis">
107 <div class=
"md-header__options">
112 <div class=
"md-header__source">
114 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
115 <div class=
"md-source__icon md-icon">
117 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05L244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
119 <div class=
"md-source__repository">
128 <div class=
"md-container" data-md-component=
"container">
133 <main class=
"md-main" data-md-component=
"main">
134 <div class=
"md-main__inner md-grid">
138 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
139 <div class=
"md-sidebar__scrollwrap">
140 <div class=
"md-sidebar__inner">
146 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
147 <label class=
"md-nav__title" for=
"__drawer">
148 <a href=
"../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation">
150 <img src=
"../../assets/logo.png" alt=
"logo">
153 WoltLab Suite Documentation
156 <div class=
"md-nav__source">
158 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
159 <div class=
"md-source__icon md-icon">
161 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05L244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
163 <div class=
"md-source__repository">
169 <ul class=
"md-nav__list" data-md-scrollfix
>
178 <li class=
"md-nav__item">
179 <a href=
"../../getting-started/" class=
"md-nav__link">
194 <li class=
"md-nav__item md-nav__item--nested">
197 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
199 <label class=
"md-nav__link" for=
"__nav_2">
201 <span class=
"md-nav__icon md-icon"></span>
203 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
204 <label class=
"md-nav__title" for=
"__nav_2">
205 <span class=
"md-nav__icon md-icon"></span>
208 <ul class=
"md-nav__list" data-md-scrollfix
>
214 <li class=
"md-nav__item">
215 <a href=
"../../php/pages/" class=
"md-nav__link">
226 <li class=
"md-nav__item">
227 <a href=
"../../php/database-objects/" class=
"md-nav__link">
238 <li class=
"md-nav__item">
239 <a href=
"../../php/database-access/" class=
"md-nav__link">
250 <li class=
"md-nav__item">
251 <a href=
"../../php/exceptions/" class=
"md-nav__link">
263 <li class=
"md-nav__item md-nav__item--nested">
266 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
268 <label class=
"md-nav__link" for=
"__nav_2_5">
270 <span class=
"md-nav__icon md-icon"></span>
272 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
273 <label class=
"md-nav__title" for=
"__nav_2_5">
274 <span class=
"md-nav__icon md-icon"></span>
277 <ul class=
"md-nav__list" data-md-scrollfix
>
283 <li class=
"md-nav__item">
284 <a href=
"../../php/api/caches/" class=
"md-nav__link">
295 <li class=
"md-nav__item">
296 <a href=
"../../php/api/comments/" class=
"md-nav__link">
307 <li class=
"md-nav__item">
308 <a href=
"../../php/api/cronjobs/" class=
"md-nav__link">
319 <li class=
"md-nav__item">
320 <a href=
"../../php/api/events/" class=
"md-nav__link">
332 <li class=
"md-nav__item md-nav__item--nested">
335 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
337 <label class=
"md-nav__link" for=
"__nav_2_5_5">
339 <span class=
"md-nav__icon md-icon"></span>
341 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
342 <label class=
"md-nav__title" for=
"__nav_2_5_5">
343 <span class=
"md-nav__icon md-icon"></span>
346 <ul class=
"md-nav__list" data-md-scrollfix
>
352 <li class=
"md-nav__item">
353 <a href=
"../../php/api/form_builder/overview/" class=
"md-nav__link">
364 <li class=
"md-nav__item">
365 <a href=
"../../php/api/form_builder/structure/" class=
"md-nav__link">
376 <li class=
"md-nav__item">
377 <a href=
"../../php/api/form_builder/form_fields/" class=
"md-nav__link">
388 <li class=
"md-nav__item">
389 <a href=
"../../php/api/form_builder/validation_data/" class=
"md-nav__link">
400 <li class=
"md-nav__item">
401 <a href=
"../../php/api/form_builder/dependencies/" class=
"md-nav__link">
418 <li class=
"md-nav__item">
419 <a href=
"../../php/api/package_installation_plugins/" class=
"md-nav__link">
420 Package Installation Plugins
430 <li class=
"md-nav__item">
431 <a href=
"../../php/api/user_activity_points/" class=
"md-nav__link">
442 <li class=
"md-nav__item">
443 <a href=
"../../php/api/user_notifications/" class=
"md-nav__link">
454 <li class=
"md-nav__item">
455 <a href=
"../../php/api/sitemaps/" class=
"md-nav__link">
472 <li class=
"md-nav__item">
473 <a href=
"../../php/code-style/" class=
"md-nav__link">
484 <li class=
"md-nav__item">
485 <a href=
"../../php/apps/" class=
"md-nav__link">
496 <li class=
"md-nav__item">
497 <a href=
"../../php/gdpr/" class=
"md-nav__link">
520 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
523 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" checked
>
525 <label class=
"md-nav__link" for=
"__nav_3">
526 Languages, Templates & CSS
527 <span class=
"md-nav__icon md-icon"></span>
529 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
530 <label class=
"md-nav__title" for=
"__nav_3">
531 <span class=
"md-nav__icon md-icon"></span>
532 Languages, Templates & CSS
534 <ul class=
"md-nav__list" data-md-scrollfix
>
540 <li class=
"md-nav__item">
541 <a href=
"../languages/" class=
"md-nav__link">
552 <li class=
"md-nav__item">
553 <a href=
"../templates/" class=
"md-nav__link">
566 <li class=
"md-nav__item md-nav__item--active">
568 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
573 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
575 <span class=
"md-nav__icon md-icon"></span>
578 <a href=
"./" class=
"md-nav__link md-nav__link--active">
583 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
589 <label class=
"md-nav__title" for=
"__toc">
590 <span class=
"md-nav__icon md-icon"></span>
593 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
595 <li class=
"md-nav__item">
596 <a href=
"#scss-and-css" class=
"md-nav__link">
600 <nav class=
"md-nav" aria-label=
"SCSS and CSS">
601 <ul class=
"md-nav__list">
603 <li class=
"md-nav__item">
604 <a href=
"#file-location" class=
"md-nav__link">
610 <li class=
"md-nav__item">
611 <a href=
"#variables" class=
"md-nav__link">
615 <nav class=
"md-nav" aria-label=
"Variables">
616 <ul class=
"md-nav__list">
618 <li class=
"md-nav__item">
619 <a href=
"#linking-images" class=
"md-nav__link">
635 <li class=
"md-nav__item">
636 <a href=
"#media-breakpoints" class=
"md-nav__link">
640 <nav class=
"md-nav" aria-label=
"Media Breakpoints">
641 <ul class=
"md-nav__list">
643 <li class=
"md-nav__item">
644 <a href=
"#available-breakpoints" class=
"md-nav__link">
645 Available Breakpoints
655 <li class=
"md-nav__item">
656 <a href=
"#asset-preloading" class=
"md-nav__link">
684 <li class=
"md-nav__item md-nav__item--nested">
687 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
689 <label class=
"md-nav__link" for=
"__nav_4">
691 <span class=
"md-nav__icon md-icon"></span>
693 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
694 <label class=
"md-nav__title" for=
"__nav_4">
695 <span class=
"md-nav__icon md-icon"></span>
698 <ul class=
"md-nav__list" data-md-scrollfix
>
704 <li class=
"md-nav__item">
705 <a href=
"../../javascript/general-usage/" class=
"md-nav__link">
717 <li class=
"md-nav__item md-nav__item--nested">
720 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
722 <label class=
"md-nav__link" for=
"__nav_4_2">
724 <span class=
"md-nav__icon md-icon"></span>
726 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
727 <label class=
"md-nav__title" for=
"__nav_4_2">
728 <span class=
"md-nav__icon md-icon"></span>
731 <ul class=
"md-nav__list" data-md-scrollfix
>
737 <li class=
"md-nav__item">
738 <a href=
"../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
749 <li class=
"md-nav__item">
750 <a href=
"../../javascript/new-api_data-structures/" class=
"md-nav__link">
761 <li class=
"md-nav__item">
762 <a href=
"../../javascript/new-api_core/" class=
"md-nav__link">
773 <li class=
"md-nav__item">
774 <a href=
"../../javascript/new-api_dom/" class=
"md-nav__link">
785 <li class=
"md-nav__item">
786 <a href=
"../../javascript/new-api_events/" class=
"md-nav__link">
797 <li class=
"md-nav__item">
798 <a href=
"../../javascript/new-api_ajax/" class=
"md-nav__link">
809 <li class=
"md-nav__item">
810 <a href=
"../../javascript/new-api_dialogs/" class=
"md-nav__link">
821 <li class=
"md-nav__item">
822 <a href=
"../../javascript/new-api_browser/" class=
"md-nav__link">
823 Browser and Screen Sizes
833 <li class=
"md-nav__item">
834 <a href=
"../../javascript/new-api_ui/" class=
"md-nav__link">
851 <li class=
"md-nav__item">
852 <a href=
"../../javascript/legacy-api/" class=
"md-nav__link">
863 <li class=
"md-nav__item">
864 <a href=
"../../javascript/helper-functions/" class=
"md-nav__link">
875 <li class=
"md-nav__item">
876 <a href=
"../../javascript/code-snippets/" class=
"md-nav__link">
897 <li class=
"md-nav__item md-nav__item--nested">
900 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
902 <label class=
"md-nav__link" for=
"__nav_5">
904 <span class=
"md-nav__icon md-icon"></span>
906 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
907 <label class=
"md-nav__title" for=
"__nav_5">
908 <span class=
"md-nav__icon md-icon"></span>
911 <ul class=
"md-nav__list" data-md-scrollfix
>
917 <li class=
"md-nav__item">
918 <a href=
"../../package/package-xml/" class=
"md-nav__link">
930 <li class=
"md-nav__item md-nav__item--nested">
933 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
935 <label class=
"md-nav__link" for=
"__nav_5_2">
937 <span class=
"md-nav__icon md-icon"></span>
939 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
940 <label class=
"md-nav__title" for=
"__nav_5_2">
941 <span class=
"md-nav__icon md-icon"></span>
944 <ul class=
"md-nav__list" data-md-scrollfix
>
950 <li class=
"md-nav__item">
951 <a href=
"../../package/pip/" class=
"md-nav__link">
962 <li class=
"md-nav__item">
963 <a href=
"../../package/pip/acl-option/" class=
"md-nav__link">
974 <li class=
"md-nav__item">
975 <a href=
"../../package/pip/acp-menu/" class=
"md-nav__link">
986 <li class=
"md-nav__item">
987 <a href=
"../../package/pip/acp-search-provider/" class=
"md-nav__link">
998 <li class=
"md-nav__item">
999 <a href=
"../../package/pip/acp-template/" class=
"md-nav__link">
1010 <li class=
"md-nav__item">
1011 <a href=
"../../package/pip/bbcode/" class=
"md-nav__link">
1022 <li class=
"md-nav__item">
1023 <a href=
"../../package/pip/box/" class=
"md-nav__link">
1034 <li class=
"md-nav__item">
1035 <a href=
"../../package/pip/clipboard-action/" class=
"md-nav__link">
1046 <li class=
"md-nav__item">
1047 <a href=
"../../package/pip/core-object/" class=
"md-nav__link">
1058 <li class=
"md-nav__item">
1059 <a href=
"../../package/pip/cronjob/" class=
"md-nav__link">
1070 <li class=
"md-nav__item">
1071 <a href=
"../../package/pip/event-listener/" class=
"md-nav__link">
1082 <li class=
"md-nav__item">
1083 <a href=
"../../package/pip/file/" class=
"md-nav__link">
1094 <li class=
"md-nav__item">
1095 <a href=
"../../package/pip/language/" class=
"md-nav__link">
1106 <li class=
"md-nav__item">
1107 <a href=
"../../package/pip/media-provider/" class=
"md-nav__link">
1118 <li class=
"md-nav__item">
1119 <a href=
"../../package/pip/menu/" class=
"md-nav__link">
1130 <li class=
"md-nav__item">
1131 <a href=
"../../package/pip/menu-item/" class=
"md-nav__link">
1142 <li class=
"md-nav__item">
1143 <a href=
"../../package/pip/object-type/" class=
"md-nav__link">
1154 <li class=
"md-nav__item">
1155 <a href=
"../../package/pip/object-type-definition/" class=
"md-nav__link">
1156 objectTypeDefinition
1166 <li class=
"md-nav__item">
1167 <a href=
"../../package/pip/option/" class=
"md-nav__link">
1178 <li class=
"md-nav__item">
1179 <a href=
"../../package/pip/page/" class=
"md-nav__link">
1190 <li class=
"md-nav__item">
1191 <a href=
"../../package/pip/pip/" class=
"md-nav__link">
1202 <li class=
"md-nav__item">
1203 <a href=
"../../package/pip/script/" class=
"md-nav__link">
1214 <li class=
"md-nav__item">
1215 <a href=
"../../package/pip/smiley/" class=
"md-nav__link">
1226 <li class=
"md-nav__item">
1227 <a href=
"../../package/pip/sql/" class=
"md-nav__link">
1238 <li class=
"md-nav__item">
1239 <a href=
"../../package/pip/style/" class=
"md-nav__link">
1250 <li class=
"md-nav__item">
1251 <a href=
"../../package/pip/template/" class=
"md-nav__link">
1262 <li class=
"md-nav__item">
1263 <a href=
"../../package/pip/template-listener/" class=
"md-nav__link">
1274 <li class=
"md-nav__item">
1275 <a href=
"../../package/pip/user-group-option/" class=
"md-nav__link">
1286 <li class=
"md-nav__item">
1287 <a href=
"../../package/pip/user-menu/" class=
"md-nav__link">
1298 <li class=
"md-nav__item">
1299 <a href=
"../../package/pip/user-notification-event/" class=
"md-nav__link">
1300 userNotificationEvent
1310 <li class=
"md-nav__item">
1311 <a href=
"../../package/pip/user-option/" class=
"md-nav__link">
1322 <li class=
"md-nav__item">
1323 <a href=
"../../package/pip/user-profile-menu/" class=
"md-nav__link">
1340 <li class=
"md-nav__item">
1341 <a href=
"../../package/database-php-api/" class=
"md-nav__link">
1362 <li class=
"md-nav__item md-nav__item--nested">
1365 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1367 <label class=
"md-nav__link" for=
"__nav_6">
1369 <span class=
"md-nav__icon md-icon"></span>
1371 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1372 <label class=
"md-nav__title" for=
"__nav_6">
1373 <span class=
"md-nav__icon md-icon"></span>
1376 <ul class=
"md-nav__list" data-md-scrollfix
>
1383 <li class=
"md-nav__item md-nav__item--nested">
1386 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1388 <label class=
"md-nav__link" for=
"__nav_6_1">
1389 Migrating from WSC
5.3
1390 <span class=
"md-nav__icon md-icon"></span>
1392 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1393 <label class=
"md-nav__title" for=
"__nav_6_1">
1394 <span class=
"md-nav__icon md-icon"></span>
1395 Migrating from WSC
5.3
1397 <ul class=
"md-nav__list" data-md-scrollfix
>
1403 <li class=
"md-nav__item">
1404 <a href=
"../../migration/wsc53/php/" class=
"md-nav__link">
1415 <li class=
"md-nav__item">
1416 <a href=
"../../migration/wsc53/session/" class=
"md-nav__link">
1417 Session Handling and Authentication
1427 <li class=
"md-nav__item">
1428 <a href=
"../../migration/wsc53/javascript/" class=
"md-nav__link">
1439 <li class=
"md-nav__item">
1440 <a href=
"../../migration/wsc53/templates/" class=
"md-nav__link">
1451 <li class=
"md-nav__item">
1452 <a href=
"../../migration/wsc53/libraries/" class=
"md-nav__link">
1453 Third Party Libraries
1470 <li class=
"md-nav__item md-nav__item--nested">
1473 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1475 <label class=
"md-nav__link" for=
"__nav_6_2">
1476 Migrating from WSC
5.2
1477 <span class=
"md-nav__icon md-icon"></span>
1479 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1480 <label class=
"md-nav__title" for=
"__nav_6_2">
1481 <span class=
"md-nav__icon md-icon"></span>
1482 Migrating from WSC
5.2
1484 <ul class=
"md-nav__list" data-md-scrollfix
>
1490 <li class=
"md-nav__item">
1491 <a href=
"../../migration/wsc52/php/" class=
"md-nav__link">
1502 <li class=
"md-nav__item">
1503 <a href=
"../../migration/wsc52/templates/" class=
"md-nav__link">
1504 Templates and Languages
1514 <li class=
"md-nav__item">
1515 <a href=
"../../migration/wsc52/libraries/" class=
"md-nav__link">
1516 Third Party Libraries
1533 <li class=
"md-nav__item md-nav__item--nested">
1536 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1538 <label class=
"md-nav__link" for=
"__nav_6_3">
1539 Migrating from WSC
3.1
1540 <span class=
"md-nav__icon md-icon"></span>
1542 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1543 <label class=
"md-nav__title" for=
"__nav_6_3">
1544 <span class=
"md-nav__icon md-icon"></span>
1545 Migrating from WSC
3.1
1547 <ul class=
"md-nav__list" data-md-scrollfix
>
1553 <li class=
"md-nav__item">
1554 <a href=
"../../migration/wsc31/php/" class=
"md-nav__link">
1572 <li class=
"md-nav__item md-nav__item--nested">
1575 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1577 <label class=
"md-nav__link" for=
"__nav_6_4">
1578 Migrating from WSC
3.0
1579 <span class=
"md-nav__icon md-icon"></span>
1581 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1582 <label class=
"md-nav__title" for=
"__nav_6_4">
1583 <span class=
"md-nav__icon md-icon"></span>
1584 Migrating from WSC
3.0
1586 <ul class=
"md-nav__list" data-md-scrollfix
>
1592 <li class=
"md-nav__item">
1593 <a href=
"../../migration/wsc30/php/" class=
"md-nav__link">
1604 <li class=
"md-nav__item">
1605 <a href=
"../../migration/wsc30/javascript/" class=
"md-nav__link">
1616 <li class=
"md-nav__item">
1617 <a href=
"../../migration/wsc30/templates/" class=
"md-nav__link">
1628 <li class=
"md-nav__item">
1629 <a href=
"../../migration/wsc30/css/" class=
"md-nav__link">
1640 <li class=
"md-nav__item">
1641 <a href=
"../../migration/wsc30/package/" class=
"md-nav__link">
1659 <li class=
"md-nav__item md-nav__item--nested">
1662 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1664 <label class=
"md-nav__link" for=
"__nav_6_5">
1665 Migrating from WCF
2.1
1666 <span class=
"md-nav__icon md-icon"></span>
1668 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1669 <label class=
"md-nav__title" for=
"__nav_6_5">
1670 <span class=
"md-nav__icon md-icon"></span>
1671 Migrating from WCF
2.1
1673 <ul class=
"md-nav__list" data-md-scrollfix
>
1679 <li class=
"md-nav__item">
1680 <a href=
"../../migration/wcf21/php/" class=
"md-nav__link">
1691 <li class=
"md-nav__item">
1692 <a href=
"../../migration/wcf21/templates/" class=
"md-nav__link">
1703 <li class=
"md-nav__item">
1704 <a href=
"../../migration/wcf21/css/" class=
"md-nav__link">
1715 <li class=
"md-nav__item">
1716 <a href=
"../../migration/wcf21/package/" class=
"md-nav__link">
1743 <li class=
"md-nav__item md-nav__item--nested">
1746 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1748 <label class=
"md-nav__link" for=
"__nav_7">
1750 <span class=
"md-nav__icon md-icon"></span>
1752 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1753 <label class=
"md-nav__title" for=
"__nav_7">
1754 <span class=
"md-nav__icon md-icon"></span>
1757 <ul class=
"md-nav__list" data-md-scrollfix
>
1764 <li class=
"md-nav__item md-nav__item--nested">
1767 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1769 <label class=
"md-nav__link" for=
"__nav_7_1">
1771 <span class=
"md-nav__icon md-icon"></span>
1773 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1774 <label class=
"md-nav__title" for=
"__nav_7_1">
1775 <span class=
"md-nav__icon md-icon"></span>
1778 <ul class=
"md-nav__list" data-md-scrollfix
>
1784 <li class=
"md-nav__item">
1785 <a href=
"../../tutorial/series/overview/" class=
"md-nav__link">
1796 <li class=
"md-nav__item">
1797 <a href=
"../../tutorial/series/part_1/" class=
"md-nav__link">
1808 <li class=
"md-nav__item">
1809 <a href=
"../../tutorial/series/part_2/" class=
"md-nav__link">
1820 <li class=
"md-nav__item">
1821 <a href=
"../../tutorial/series/part_3/" class=
"md-nav__link">
1848 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1849 <div class=
"md-sidebar__scrollwrap">
1850 <div class=
"md-sidebar__inner">
1852 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1858 <label class=
"md-nav__title" for=
"__toc">
1859 <span class=
"md-nav__icon md-icon"></span>
1862 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1864 <li class=
"md-nav__item">
1865 <a href=
"#scss-and-css" class=
"md-nav__link">
1869 <nav class=
"md-nav" aria-label=
"SCSS and CSS">
1870 <ul class=
"md-nav__list">
1872 <li class=
"md-nav__item">
1873 <a href=
"#file-location" class=
"md-nav__link">
1879 <li class=
"md-nav__item">
1880 <a href=
"#variables" class=
"md-nav__link">
1884 <nav class=
"md-nav" aria-label=
"Variables">
1885 <ul class=
"md-nav__list">
1887 <li class=
"md-nav__item">
1888 <a href=
"#linking-images" class=
"md-nav__link">
1904 <li class=
"md-nav__item">
1905 <a href=
"#media-breakpoints" class=
"md-nav__link">
1909 <nav class=
"md-nav" aria-label=
"Media Breakpoints">
1910 <ul class=
"md-nav__list">
1912 <li class=
"md-nav__item">
1913 <a href=
"#available-breakpoints" class=
"md-nav__link">
1914 Available Breakpoints
1924 <li class=
"md-nav__item">
1925 <a href=
"#asset-preloading" class=
"md-nav__link">
1939 <div class=
"md-content" data-md-component=
"content">
1940 <article class=
"md-content__inner md-typeset">
1943 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/view/css.md" title=
"Edit this page" class=
"md-content__button md-icon">
1944 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
1948 <h1 id=
"css">CSS
<a class=
"headerlink" href=
"#css" title=
"Permanent link">#
</a></h1>
1949 <h2 id=
"scss-and-css">SCSS and CSS
<a class=
"headerlink" href=
"#scss-and-css" title=
"Permanent link">#
</a></h2>
1950 <p>SCSS is a scripting language that features a syntax similar to CSS and compiles into native CSS at runtime. It provides many great additions to CSS such as declaration nesting and variables, it is recommended to read the
<a href=
"http://sass-lang.com/guide">official guide
</a> to learn more.
</p>
1951 <p>You can create
<code>.scss
</code> files containing only pure CSS code and it will work just fine, you are at no point required to write actual SCSS code.
</p>
1952 <h3 id=
"file-location">File Location
<a class=
"headerlink" href=
"#file-location" title=
"Permanent link">#
</a></h3>
1953 <p>Please place your style files in a subdirectory of the
<code>style/
</code> directory of the target application or the Core's style directory, for example
<code>style/layout/pageHeader.scss
</code>.
</p>
1954 <h3 id=
"variables">Variables
<a class=
"headerlink" href=
"#variables" title=
"Permanent link">#
</a></h3>
1955 <p>You can access variables with
<code>$myVariable
</code>, variable interpolation (variables inside strings) is accomplished with
<code>#{$myVariable}
</code>.
</p>
1956 <h4 id=
"linking-images">Linking images
<a class=
"headerlink" href=
"#linking-images" title=
"Permanent link">#
</a></h4>
1957 <p>Images used within a style must be located in the style's image folder. To get the folder name within the CSS the SCSS variable
<code>#{$style_image_path}
</code> can be used. The value will contain a trailing slash.
</p>
1958 <h2 id=
"media-breakpoints">Media Breakpoints
<a class=
"headerlink" href=
"#media-breakpoints" title=
"Permanent link">#
</a></h2>
1959 <p>Media breakpoints instruct the browser to apply different CSS depending on the viewport dimensions, e.g. serving a desktop PC a different view than when viewed on a smartphone.
</p>
1960 <div class=
"highlight"><pre><span></span><code><span class=
"cm">/* red background color for desktop pc */
</span>
1961 <span class=
"k">@include
</span><span class=
"nd"> screen-lg
</span> <span class=
"p">{
</span>
1962 <span class=
"nt">body
</span> <span class=
"p">{
</span>
1963 <span class=
"nt">background-color
</span><span class=
"nd">:
</span> <span class=
"nt">red
</span><span class=
"o">;
</span>
1964 <span class=
"p">}
</span>
1965 <span class=
"p">}
</span>
1967 <span class=
"cm">/* green background color on smartphones and tablets */
</span>
1968 <span class=
"k">@include
</span><span class=
"nd"> screen-md-down
</span> <span class=
"p">{
</span>
1969 <span class=
"nt">body
</span> <span class=
"p">{
</span>
1970 <span class=
"nt">background-color
</span><span class=
"nd">:
</span> <span class=
"nt">green
</span><span class=
"o">;
</span>
1971 <span class=
"p">}
</span>
1972 <span class=
"p">}
</span>
1974 <h3 id=
"available-breakpoints">Available Breakpoints
<a class=
"headerlink" href=
"#available-breakpoints" title=
"Permanent link">#
</a></h3>
1975 <div class=
"admonition info">
1976 <p class=
"admonition-title">Some very large smartphones, for example the Apple iPhone
7 Plus, do match the media query for
<code>Tablets (portrait)
</code> when viewed in landscape mode.
</p>
1983 <th><code>@media
</code> equivalent
</th>
1988 <td><code>screen-xs
</code></td>
1989 <td>Smartphones only
</td>
1990 <td><code>(max-width:
544px)
</code></td>
1993 <td><code>screen-sm
</code></td>
1994 <td>Tablets (portrait)
</td>
1995 <td><code>(min-width:
545px) and (max-width:
768px)
</code></td>
1998 <td><code>screen-sm-down
</code></td>
1999 <td>Tablets (portrait) and smartphones
</td>
2000 <td><code>(max-width:
768px)
</code></td>
2003 <td><code>screen-sm-up
</code></td>
2004 <td>Tablets and desktop PC
</td>
2005 <td><code>(min-width:
545px)
</code></td>
2008 <td><code>screen-sm-md
</code></td>
2009 <td>Tablets only
</td>
2010 <td><code>(min-width:
545px) and (max-width:
1024px)
</code></td>
2013 <td><code>screen-md
</code></td>
2014 <td>Tablets (landscape)
</td>
2015 <td><code>(min-width:
769px) and (max-width:
1024px)
</code></td>
2018 <td><code>screen-md-down
</code></td>
2019 <td>Smartphones and Tablets
</td>
2020 <td><code>(max-width:
1024px)
</code></td>
2023 <td><code>screen-md-up
</code></td>
2024 <td>Tablets (landscape) and desktop PC
</td>
2025 <td><code>(min-width:
769px)
</code></td>
2028 <td><code>screen-lg
</code></td>
2030 <td><code>(min-width:
1025px)
</code></td>
2034 <h2 id=
"asset-preloading">Asset Preloading
<a class=
"headerlink" href=
"#asset-preloading" title=
"Permanent link">#
</a></h2>
2035 <p>WoltLab Suite’s SCSS compiler supports adding
<a href=
"https://developer.mozilla.org/en-US/docs/Web/HTML/Preloading_content">preloading
</a> metadata to the CSS.
2036 To communicate the preloading intent to the compiler, the
<code>--woltlab-suite-preload
</code> CSS variable is set to the result of the
<code>preload()
</code> function:
</p>
2037 <div class=
"highlight"><pre><span></span><code><span class=
"nc">.fooBar
</span> <span class=
"p">{
</span>
2038 <span class=
"nt">--woltlab-suite-preload
</span><span class=
"nd">:
</span> <span class=
"nn">#
</span><span class=
"p">{
</span><span class=
"nt">preload
</span><span class=
"o">(
</span>
2039 <span class=
"s1">'</span><span class=
"si">#{
</span><span class=
"nv">$style_image_path
</span><span class=
"si">}
</span><span class=
"s1">custom/background.png
'</span><span class=
"o">,
</span>
2040 <span class=
"err">$
</span><span class=
"nt">as
</span><span class=
"nd">:
</span> <span class=
"s2">"image
"</span><span class=
"o">,
</span>
2041 <span class=
"err">$
</span><span class=
"nt">crossorigin
</span><span class=
"nd">:
</span> <span class=
"nt">false
</span><span class=
"o">,
</span>
2042 <span class=
"err">$
</span><span class=
"nt">type
</span><span class=
"nd">:
</span> <span class=
"s2">"image/png
"</span>
2043 <span class=
"o">)
</span><span class=
"p">}
</span><span class=
"o">;
</span>
2045 <span class=
"nt">background
</span><span class=
"nd">:
</span> <span class=
"nt">url
</span><span class=
"o">(
</span><span class=
"s1">'</span><span class=
"si">#{
</span><span class=
"nv">$style_image_path
</span><span class=
"si">}
</span><span class=
"s1">custom/background.png
'</span><span class=
"o">);
</span>
2046 <span class=
"p">}
</span>
2048 <p>The parameters of the
<code>preload()
</code> function map directly to the preloading properties that are used within the
<code><link
></code> tag and the
<code>link:
</code> HTTP response header.
</p>
2049 <p>The above example will result in a
<code><link
></code> similar to the following being added to the generated HTML:
</p>
2050 <div class=
"highlight"><pre><span></span><code><link rel=
"preload
" href=
"https://example.com/images/style-
1/custom/background.png
" as=
"image
" type=
"image/png
">
2052 <div class=
"admonition info">
2053 <p class=
"admonition-title">Use preloading sparingly for the most important resources where you can be certain that the browser will need them. Unused preloaded resources will unnecessarily waste bandwidth.
</p>
2060 <div class=
"md-source-date">
2063 Last update:
2021-
03-
08
2081 <footer class=
"md-footer">
2083 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2085 <a href=
"../templates/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2086 <div class=
"md-footer__button md-icon">
2087 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
2089 <div class=
"md-footer__title">
2090 <div class=
"md-ellipsis">
2091 <span class=
"md-footer__direction">
2100 <a href=
"../../javascript/general-usage/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2101 <div class=
"md-footer__title">
2102 <div class=
"md-ellipsis">
2103 <span class=
"md-footer__direction">
2109 <div class=
"md-footer__button md-icon">
2110 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
2116 <div class=
"md-footer-meta md-typeset">
2117 <div class=
"md-footer-meta__inner md-grid">
2118 <div class=
"md-footer-copyright">
2120 <div class=
"md-footer-copyright__highlight">
2121 Copyright ©
2020 WoltLab GmbH
2125 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2130 <div class=
"md-footer-copyright">
2131 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2132 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2139 <div class=
"md-dialog" data-md-component=
"dialog">
2140 <div class=
"md-dialog__inner md-typeset"></div>
2142 <script id=
"__config" type=
"application/json">{
"base":
"../..",
"features": [],
"translations": {
"clipboard.copy":
"Copy to clipboard",
"clipboard.copied":
"Copied to clipboard",
"search.config.lang":
"en",
"search.config.pipeline":
"trimmer, stopWordFilter",
"search.config.separator":
"[\\s\\-]+",
"search.placeholder":
"Search",
"search.result.placeholder":
"Type to start searching",
"search.result.none":
"No matching documents",
"search.result.one":
"1 matching document",
"search.result.other":
"# matching documents",
"search.result.more.one":
"1 more on this page",
"search.result.more.other":
"# more on this page",
"search.result.term.missing":
"Missing"},
"search":
"../../assets/javascripts/workers/search.fb4a9340.min.js",
"version": {
"provider":
"mike"}}
</script>
2145 <script src=
"../../assets/javascripts/bundle.5cf3e710.min.js"></script>