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">
111 <label class=
"md-header__button md-icon" for=
"__search">
112 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
115 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
116 <label class=
"md-search__overlay" for=
"__search"></label>
117 <div class=
"md-search__inner" role=
"search">
118 <form class=
"md-search__form" name=
"search">
119 <input type=
"text" class=
"md-search__input" name=
"query" aria-label=
"Search" placeholder=
"Search" autocapitalize=
"off" autocorrect=
"off" autocomplete=
"off" spellcheck=
"false" data-md-component=
"search-query" data-md-state=
"active" required
>
120 <label class=
"md-search__icon md-icon" for=
"__search">
121 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
122 <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>
124 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
125 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
128 <div class=
"md-search__output">
129 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
130 <div class=
"md-search-result" data-md-component=
"search-result">
131 <div class=
"md-search-result__meta">
134 <ol class=
"md-search-result__list"></ol>
142 <div class=
"md-header__source">
144 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
145 <div class=
"md-source__icon md-icon">
147 <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>
149 <div class=
"md-source__repository">
158 <div class=
"md-container" data-md-component=
"container">
163 <main class=
"md-main" data-md-component=
"main">
164 <div class=
"md-main__inner md-grid">
168 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
169 <div class=
"md-sidebar__scrollwrap">
170 <div class=
"md-sidebar__inner">
176 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
177 <label class=
"md-nav__title" for=
"__drawer">
178 <a href=
"../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation">
180 <img src=
"../../assets/logo.png" alt=
"logo">
183 WoltLab Suite Documentation
186 <div class=
"md-nav__source">
188 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
189 <div class=
"md-source__icon md-icon">
191 <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>
193 <div class=
"md-source__repository">
199 <ul class=
"md-nav__list" data-md-scrollfix
>
208 <li class=
"md-nav__item">
209 <a href=
"../../getting-started/" class=
"md-nav__link">
224 <li class=
"md-nav__item md-nav__item--nested">
227 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
229 <label class=
"md-nav__link" for=
"__nav_2">
231 <span class=
"md-nav__icon md-icon"></span>
233 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
234 <label class=
"md-nav__title" for=
"__nav_2">
235 <span class=
"md-nav__icon md-icon"></span>
238 <ul class=
"md-nav__list" data-md-scrollfix
>
244 <li class=
"md-nav__item">
245 <a href=
"../../php/pages/" class=
"md-nav__link">
256 <li class=
"md-nav__item">
257 <a href=
"../../php/database-objects/" class=
"md-nav__link">
268 <li class=
"md-nav__item">
269 <a href=
"../../php/database-access/" class=
"md-nav__link">
280 <li class=
"md-nav__item">
281 <a href=
"../../php/exceptions/" class=
"md-nav__link">
293 <li class=
"md-nav__item md-nav__item--nested">
296 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
298 <label class=
"md-nav__link" for=
"__nav_2_5">
300 <span class=
"md-nav__icon md-icon"></span>
302 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
303 <label class=
"md-nav__title" for=
"__nav_2_5">
304 <span class=
"md-nav__icon md-icon"></span>
307 <ul class=
"md-nav__list" data-md-scrollfix
>
313 <li class=
"md-nav__item">
314 <a href=
"../../php/api/caches/" class=
"md-nav__link">
325 <li class=
"md-nav__item">
326 <a href=
"../../php/api/comments/" class=
"md-nav__link">
337 <li class=
"md-nav__item">
338 <a href=
"../../php/api/cronjobs/" class=
"md-nav__link">
349 <li class=
"md-nav__item">
350 <a href=
"../../php/api/events/" class=
"md-nav__link">
362 <li class=
"md-nav__item md-nav__item--nested">
365 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
367 <label class=
"md-nav__link" for=
"__nav_2_5_5">
369 <span class=
"md-nav__icon md-icon"></span>
371 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
372 <label class=
"md-nav__title" for=
"__nav_2_5_5">
373 <span class=
"md-nav__icon md-icon"></span>
376 <ul class=
"md-nav__list" data-md-scrollfix
>
382 <li class=
"md-nav__item">
383 <a href=
"../../php/api/form_builder/overview/" class=
"md-nav__link">
394 <li class=
"md-nav__item">
395 <a href=
"../../php/api/form_builder/structure/" class=
"md-nav__link">
406 <li class=
"md-nav__item">
407 <a href=
"../../php/api/form_builder/form_fields/" class=
"md-nav__link">
418 <li class=
"md-nav__item">
419 <a href=
"../../php/api/form_builder/validation_data/" class=
"md-nav__link">
430 <li class=
"md-nav__item">
431 <a href=
"../../php/api/form_builder/dependencies/" class=
"md-nav__link">
448 <li class=
"md-nav__item">
449 <a href=
"../../php/api/package_installation_plugins/" class=
"md-nav__link">
450 Package Installation Plugins
460 <li class=
"md-nav__item">
461 <a href=
"../../php/api/user_activity_points/" class=
"md-nav__link">
472 <li class=
"md-nav__item">
473 <a href=
"../../php/api/user_notifications/" class=
"md-nav__link">
484 <li class=
"md-nav__item">
485 <a href=
"../../php/api/sitemaps/" class=
"md-nav__link">
502 <li class=
"md-nav__item">
503 <a href=
"../../php/code-style/" class=
"md-nav__link">
514 <li class=
"md-nav__item">
515 <a href=
"../../php/apps/" class=
"md-nav__link">
526 <li class=
"md-nav__item">
527 <a href=
"../../php/gdpr/" class=
"md-nav__link">
550 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
553 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" checked
>
555 <label class=
"md-nav__link" for=
"__nav_3">
556 Languages, Templates & CSS
557 <span class=
"md-nav__icon md-icon"></span>
559 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
560 <label class=
"md-nav__title" for=
"__nav_3">
561 <span class=
"md-nav__icon md-icon"></span>
562 Languages, Templates & CSS
564 <ul class=
"md-nav__list" data-md-scrollfix
>
570 <li class=
"md-nav__item">
571 <a href=
"../languages/" class=
"md-nav__link">
582 <li class=
"md-nav__item">
583 <a href=
"../templates/" class=
"md-nav__link">
596 <li class=
"md-nav__item md-nav__item--active">
598 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
603 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
605 <span class=
"md-nav__icon md-icon"></span>
608 <a href=
"./" class=
"md-nav__link md-nav__link--active">
613 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
619 <label class=
"md-nav__title" for=
"__toc">
620 <span class=
"md-nav__icon md-icon"></span>
623 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
625 <li class=
"md-nav__item">
626 <a href=
"#scss-and-css" class=
"md-nav__link">
630 <nav class=
"md-nav" aria-label=
"SCSS and CSS">
631 <ul class=
"md-nav__list">
633 <li class=
"md-nav__item">
634 <a href=
"#file-location" class=
"md-nav__link">
640 <li class=
"md-nav__item">
641 <a href=
"#variables" class=
"md-nav__link">
645 <nav class=
"md-nav" aria-label=
"Variables">
646 <ul class=
"md-nav__list">
648 <li class=
"md-nav__item">
649 <a href=
"#linking-images" class=
"md-nav__link">
665 <li class=
"md-nav__item">
666 <a href=
"#media-breakpoints" class=
"md-nav__link">
670 <nav class=
"md-nav" aria-label=
"Media Breakpoints">
671 <ul class=
"md-nav__list">
673 <li class=
"md-nav__item">
674 <a href=
"#available-breakpoints" class=
"md-nav__link">
675 Available Breakpoints
685 <li class=
"md-nav__item">
686 <a href=
"#asset-preloading" class=
"md-nav__link">
714 <li class=
"md-nav__item md-nav__item--nested">
717 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
719 <label class=
"md-nav__link" for=
"__nav_4">
721 <span class=
"md-nav__icon md-icon"></span>
723 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
724 <label class=
"md-nav__title" for=
"__nav_4">
725 <span class=
"md-nav__icon md-icon"></span>
728 <ul class=
"md-nav__list" data-md-scrollfix
>
734 <li class=
"md-nav__item">
735 <a href=
"../../javascript/general-usage/" class=
"md-nav__link">
747 <li class=
"md-nav__item md-nav__item--nested">
750 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
752 <label class=
"md-nav__link" for=
"__nav_4_2">
754 <span class=
"md-nav__icon md-icon"></span>
756 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
757 <label class=
"md-nav__title" for=
"__nav_4_2">
758 <span class=
"md-nav__icon md-icon"></span>
761 <ul class=
"md-nav__list" data-md-scrollfix
>
767 <li class=
"md-nav__item">
768 <a href=
"../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
779 <li class=
"md-nav__item">
780 <a href=
"../../javascript/new-api_data-structures/" class=
"md-nav__link">
791 <li class=
"md-nav__item">
792 <a href=
"../../javascript/new-api_core/" class=
"md-nav__link">
803 <li class=
"md-nav__item">
804 <a href=
"../../javascript/new-api_dom/" class=
"md-nav__link">
815 <li class=
"md-nav__item">
816 <a href=
"../../javascript/new-api_events/" class=
"md-nav__link">
827 <li class=
"md-nav__item">
828 <a href=
"../../javascript/new-api_ajax/" class=
"md-nav__link">
839 <li class=
"md-nav__item">
840 <a href=
"../../javascript/new-api_dialogs/" class=
"md-nav__link">
851 <li class=
"md-nav__item">
852 <a href=
"../../javascript/new-api_browser/" class=
"md-nav__link">
853 Browser and Screen Sizes
863 <li class=
"md-nav__item">
864 <a href=
"../../javascript/new-api_ui/" class=
"md-nav__link">
881 <li class=
"md-nav__item">
882 <a href=
"../../javascript/legacy-api/" class=
"md-nav__link">
893 <li class=
"md-nav__item">
894 <a href=
"../../javascript/helper-functions/" class=
"md-nav__link">
905 <li class=
"md-nav__item">
906 <a href=
"../../javascript/code-snippets/" class=
"md-nav__link">
927 <li class=
"md-nav__item md-nav__item--nested">
930 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
932 <label class=
"md-nav__link" for=
"__nav_5">
934 <span class=
"md-nav__icon md-icon"></span>
936 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
937 <label class=
"md-nav__title" for=
"__nav_5">
938 <span class=
"md-nav__icon md-icon"></span>
941 <ul class=
"md-nav__list" data-md-scrollfix
>
947 <li class=
"md-nav__item">
948 <a href=
"../../package/package-xml/" class=
"md-nav__link">
960 <li class=
"md-nav__item md-nav__item--nested">
963 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
965 <label class=
"md-nav__link" for=
"__nav_5_2">
967 <span class=
"md-nav__icon md-icon"></span>
969 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
970 <label class=
"md-nav__title" for=
"__nav_5_2">
971 <span class=
"md-nav__icon md-icon"></span>
974 <ul class=
"md-nav__list" data-md-scrollfix
>
980 <li class=
"md-nav__item">
981 <a href=
"../../package/pip/" class=
"md-nav__link">
992 <li class=
"md-nav__item">
993 <a href=
"../../package/pip/acl-option/" class=
"md-nav__link">
1004 <li class=
"md-nav__item">
1005 <a href=
"../../package/pip/acp-menu/" class=
"md-nav__link">
1016 <li class=
"md-nav__item">
1017 <a href=
"../../package/pip/acp-search-provider/" class=
"md-nav__link">
1028 <li class=
"md-nav__item">
1029 <a href=
"../../package/pip/acp-template/" class=
"md-nav__link">
1040 <li class=
"md-nav__item">
1041 <a href=
"../../package/pip/bbcode/" class=
"md-nav__link">
1052 <li class=
"md-nav__item">
1053 <a href=
"../../package/pip/box/" class=
"md-nav__link">
1064 <li class=
"md-nav__item">
1065 <a href=
"../../package/pip/clipboard-action/" class=
"md-nav__link">
1076 <li class=
"md-nav__item">
1077 <a href=
"../../package/pip/core-object/" class=
"md-nav__link">
1088 <li class=
"md-nav__item">
1089 <a href=
"../../package/pip/cronjob/" class=
"md-nav__link">
1100 <li class=
"md-nav__item">
1101 <a href=
"../../package/pip/event-listener/" class=
"md-nav__link">
1112 <li class=
"md-nav__item">
1113 <a href=
"../../package/pip/file/" class=
"md-nav__link">
1124 <li class=
"md-nav__item">
1125 <a href=
"../../package/pip/language/" class=
"md-nav__link">
1136 <li class=
"md-nav__item">
1137 <a href=
"../../package/pip/media-provider/" class=
"md-nav__link">
1148 <li class=
"md-nav__item">
1149 <a href=
"../../package/pip/menu/" class=
"md-nav__link">
1160 <li class=
"md-nav__item">
1161 <a href=
"../../package/pip/menu-item/" class=
"md-nav__link">
1172 <li class=
"md-nav__item">
1173 <a href=
"../../package/pip/object-type/" class=
"md-nav__link">
1184 <li class=
"md-nav__item">
1185 <a href=
"../../package/pip/object-type-definition/" class=
"md-nav__link">
1186 objectTypeDefinition
1196 <li class=
"md-nav__item">
1197 <a href=
"../../package/pip/option/" class=
"md-nav__link">
1208 <li class=
"md-nav__item">
1209 <a href=
"../../package/pip/page/" class=
"md-nav__link">
1220 <li class=
"md-nav__item">
1221 <a href=
"../../package/pip/pip/" class=
"md-nav__link">
1232 <li class=
"md-nav__item">
1233 <a href=
"../../package/pip/script/" class=
"md-nav__link">
1244 <li class=
"md-nav__item">
1245 <a href=
"../../package/pip/smiley/" class=
"md-nav__link">
1256 <li class=
"md-nav__item">
1257 <a href=
"../../package/pip/sql/" class=
"md-nav__link">
1268 <li class=
"md-nav__item">
1269 <a href=
"../../package/pip/style/" class=
"md-nav__link">
1280 <li class=
"md-nav__item">
1281 <a href=
"../../package/pip/template/" class=
"md-nav__link">
1292 <li class=
"md-nav__item">
1293 <a href=
"../../package/pip/template-listener/" class=
"md-nav__link">
1304 <li class=
"md-nav__item">
1305 <a href=
"../../package/pip/user-group-option/" class=
"md-nav__link">
1316 <li class=
"md-nav__item">
1317 <a href=
"../../package/pip/user-menu/" class=
"md-nav__link">
1328 <li class=
"md-nav__item">
1329 <a href=
"../../package/pip/user-notification-event/" class=
"md-nav__link">
1330 userNotificationEvent
1340 <li class=
"md-nav__item">
1341 <a href=
"../../package/pip/user-option/" class=
"md-nav__link">
1352 <li class=
"md-nav__item">
1353 <a href=
"../../package/pip/user-profile-menu/" class=
"md-nav__link">
1370 <li class=
"md-nav__item">
1371 <a href=
"../../package/database-php-api/" class=
"md-nav__link">
1392 <li class=
"md-nav__item md-nav__item--nested">
1395 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1397 <label class=
"md-nav__link" for=
"__nav_6">
1399 <span class=
"md-nav__icon md-icon"></span>
1401 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1402 <label class=
"md-nav__title" for=
"__nav_6">
1403 <span class=
"md-nav__icon md-icon"></span>
1406 <ul class=
"md-nav__list" data-md-scrollfix
>
1413 <li class=
"md-nav__item md-nav__item--nested">
1416 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1418 <label class=
"md-nav__link" for=
"__nav_6_1">
1419 Migrating from WSC
5.3
1420 <span class=
"md-nav__icon md-icon"></span>
1422 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1423 <label class=
"md-nav__title" for=
"__nav_6_1">
1424 <span class=
"md-nav__icon md-icon"></span>
1425 Migrating from WSC
5.3
1427 <ul class=
"md-nav__list" data-md-scrollfix
>
1433 <li class=
"md-nav__item">
1434 <a href=
"../../migration/wsc53/php/" class=
"md-nav__link">
1445 <li class=
"md-nav__item">
1446 <a href=
"../../migration/wsc53/session/" class=
"md-nav__link">
1447 Session Handling and Authentication
1457 <li class=
"md-nav__item">
1458 <a href=
"../../migration/wsc53/javascript/" class=
"md-nav__link">
1469 <li class=
"md-nav__item">
1470 <a href=
"../../migration/wsc53/templates/" class=
"md-nav__link">
1481 <li class=
"md-nav__item">
1482 <a href=
"../../migration/wsc53/libraries/" class=
"md-nav__link">
1483 Third Party Libraries
1500 <li class=
"md-nav__item md-nav__item--nested">
1503 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1505 <label class=
"md-nav__link" for=
"__nav_6_2">
1506 Migrating from WSC
5.2
1507 <span class=
"md-nav__icon md-icon"></span>
1509 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1510 <label class=
"md-nav__title" for=
"__nav_6_2">
1511 <span class=
"md-nav__icon md-icon"></span>
1512 Migrating from WSC
5.2
1514 <ul class=
"md-nav__list" data-md-scrollfix
>
1520 <li class=
"md-nav__item">
1521 <a href=
"../../migration/wsc52/php/" class=
"md-nav__link">
1532 <li class=
"md-nav__item">
1533 <a href=
"../../migration/wsc52/templates/" class=
"md-nav__link">
1534 Templates and Languages
1544 <li class=
"md-nav__item">
1545 <a href=
"../../migration/wsc52/libraries/" class=
"md-nav__link">
1546 Third Party Libraries
1563 <li class=
"md-nav__item md-nav__item--nested">
1566 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1568 <label class=
"md-nav__link" for=
"__nav_6_3">
1569 Migrating from WSC
3.1
1570 <span class=
"md-nav__icon md-icon"></span>
1572 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1573 <label class=
"md-nav__title" for=
"__nav_6_3">
1574 <span class=
"md-nav__icon md-icon"></span>
1575 Migrating from WSC
3.1
1577 <ul class=
"md-nav__list" data-md-scrollfix
>
1583 <li class=
"md-nav__item">
1584 <a href=
"../../migration/wsc31/php/" class=
"md-nav__link">
1602 <li class=
"md-nav__item md-nav__item--nested">
1605 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1607 <label class=
"md-nav__link" for=
"__nav_6_4">
1608 Migrating from WSC
3.0
1609 <span class=
"md-nav__icon md-icon"></span>
1611 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1612 <label class=
"md-nav__title" for=
"__nav_6_4">
1613 <span class=
"md-nav__icon md-icon"></span>
1614 Migrating from WSC
3.0
1616 <ul class=
"md-nav__list" data-md-scrollfix
>
1622 <li class=
"md-nav__item">
1623 <a href=
"../../migration/wsc30/php/" class=
"md-nav__link">
1634 <li class=
"md-nav__item">
1635 <a href=
"../../migration/wsc30/javascript/" class=
"md-nav__link">
1646 <li class=
"md-nav__item">
1647 <a href=
"../../migration/wsc30/templates/" class=
"md-nav__link">
1658 <li class=
"md-nav__item">
1659 <a href=
"../../migration/wsc30/css/" class=
"md-nav__link">
1670 <li class=
"md-nav__item">
1671 <a href=
"../../migration/wsc30/package/" class=
"md-nav__link">
1689 <li class=
"md-nav__item md-nav__item--nested">
1692 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1694 <label class=
"md-nav__link" for=
"__nav_6_5">
1695 Migrating from WCF
2.1
1696 <span class=
"md-nav__icon md-icon"></span>
1698 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1699 <label class=
"md-nav__title" for=
"__nav_6_5">
1700 <span class=
"md-nav__icon md-icon"></span>
1701 Migrating from WCF
2.1
1703 <ul class=
"md-nav__list" data-md-scrollfix
>
1709 <li class=
"md-nav__item">
1710 <a href=
"../../migration/wcf21/php/" class=
"md-nav__link">
1721 <li class=
"md-nav__item">
1722 <a href=
"../../migration/wcf21/templates/" class=
"md-nav__link">
1733 <li class=
"md-nav__item">
1734 <a href=
"../../migration/wcf21/css/" class=
"md-nav__link">
1745 <li class=
"md-nav__item">
1746 <a href=
"../../migration/wcf21/package/" class=
"md-nav__link">
1773 <li class=
"md-nav__item md-nav__item--nested">
1776 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1778 <label class=
"md-nav__link" for=
"__nav_7">
1780 <span class=
"md-nav__icon md-icon"></span>
1782 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1783 <label class=
"md-nav__title" for=
"__nav_7">
1784 <span class=
"md-nav__icon md-icon"></span>
1787 <ul class=
"md-nav__list" data-md-scrollfix
>
1794 <li class=
"md-nav__item md-nav__item--nested">
1797 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1799 <label class=
"md-nav__link" for=
"__nav_7_1">
1801 <span class=
"md-nav__icon md-icon"></span>
1803 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1804 <label class=
"md-nav__title" for=
"__nav_7_1">
1805 <span class=
"md-nav__icon md-icon"></span>
1808 <ul class=
"md-nav__list" data-md-scrollfix
>
1814 <li class=
"md-nav__item">
1815 <a href=
"../../tutorial/series/overview/" class=
"md-nav__link">
1826 <li class=
"md-nav__item">
1827 <a href=
"../../tutorial/series/part_1/" class=
"md-nav__link">
1838 <li class=
"md-nav__item">
1839 <a href=
"../../tutorial/series/part_2/" class=
"md-nav__link">
1850 <li class=
"md-nav__item">
1851 <a href=
"../../tutorial/series/part_3/" class=
"md-nav__link">
1878 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1879 <div class=
"md-sidebar__scrollwrap">
1880 <div class=
"md-sidebar__inner">
1882 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1888 <label class=
"md-nav__title" for=
"__toc">
1889 <span class=
"md-nav__icon md-icon"></span>
1892 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1894 <li class=
"md-nav__item">
1895 <a href=
"#scss-and-css" class=
"md-nav__link">
1899 <nav class=
"md-nav" aria-label=
"SCSS and CSS">
1900 <ul class=
"md-nav__list">
1902 <li class=
"md-nav__item">
1903 <a href=
"#file-location" class=
"md-nav__link">
1909 <li class=
"md-nav__item">
1910 <a href=
"#variables" class=
"md-nav__link">
1914 <nav class=
"md-nav" aria-label=
"Variables">
1915 <ul class=
"md-nav__list">
1917 <li class=
"md-nav__item">
1918 <a href=
"#linking-images" class=
"md-nav__link">
1934 <li class=
"md-nav__item">
1935 <a href=
"#media-breakpoints" class=
"md-nav__link">
1939 <nav class=
"md-nav" aria-label=
"Media Breakpoints">
1940 <ul class=
"md-nav__list">
1942 <li class=
"md-nav__item">
1943 <a href=
"#available-breakpoints" class=
"md-nav__link">
1944 Available Breakpoints
1954 <li class=
"md-nav__item">
1955 <a href=
"#asset-preloading" class=
"md-nav__link">
1969 <div class=
"md-content" data-md-component=
"content">
1970 <article class=
"md-content__inner md-typeset">
1973 <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">
1974 <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>
1978 <h1 id=
"css">CSS
<a class=
"headerlink" href=
"#css" title=
"Permanent link">#
</a></h1>
1979 <h2 id=
"scss-and-css">SCSS and CSS
<a class=
"headerlink" href=
"#scss-and-css" title=
"Permanent link">#
</a></h2>
1980 <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>
1981 <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>
1982 <h3 id=
"file-location">File Location
<a class=
"headerlink" href=
"#file-location" title=
"Permanent link">#
</a></h3>
1983 <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>
1984 <h3 id=
"variables">Variables
<a class=
"headerlink" href=
"#variables" title=
"Permanent link">#
</a></h3>
1985 <p>You can access variables with
<code>$myVariable
</code>, variable interpolation (variables inside strings) is accomplished with
<code>#{$myVariable}
</code>.
</p>
1986 <h4 id=
"linking-images">Linking images
<a class=
"headerlink" href=
"#linking-images" title=
"Permanent link">#
</a></h4>
1987 <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>
1988 <h2 id=
"media-breakpoints">Media Breakpoints
<a class=
"headerlink" href=
"#media-breakpoints" title=
"Permanent link">#
</a></h2>
1989 <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>
1990 <div class=
"highlight"><pre><span></span><code><span class=
"cm">/* red background color for desktop pc */
</span>
1991 <span class=
"k">@include
</span><span class=
"nd"> screen-lg
</span> <span class=
"p">{
</span>
1992 <span class=
"nt">body
</span> <span class=
"p">{
</span>
1993 <span class=
"nt">background-color
</span><span class=
"nd">:
</span> <span class=
"nt">red
</span><span class=
"o">;
</span>
1994 <span class=
"p">}
</span>
1995 <span class=
"p">}
</span>
1997 <span class=
"cm">/* green background color on smartphones and tablets */
</span>
1998 <span class=
"k">@include
</span><span class=
"nd"> screen-md-down
</span> <span class=
"p">{
</span>
1999 <span class=
"nt">body
</span> <span class=
"p">{
</span>
2000 <span class=
"nt">background-color
</span><span class=
"nd">:
</span> <span class=
"nt">green
</span><span class=
"o">;
</span>
2001 <span class=
"p">}
</span>
2002 <span class=
"p">}
</span>
2004 <h3 id=
"available-breakpoints">Available Breakpoints
<a class=
"headerlink" href=
"#available-breakpoints" title=
"Permanent link">#
</a></h3>
2005 <div class=
"admonition info">
2006 <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>
2013 <th><code>@media
</code> equivalent
</th>
2018 <td><code>screen-xs
</code></td>
2019 <td>Smartphones only
</td>
2020 <td><code>(max-width:
544px)
</code></td>
2023 <td><code>screen-sm
</code></td>
2024 <td>Tablets (portrait)
</td>
2025 <td><code>(min-width:
545px) and (max-width:
768px)
</code></td>
2028 <td><code>screen-sm-down
</code></td>
2029 <td>Tablets (portrait) and smartphones
</td>
2030 <td><code>(max-width:
768px)
</code></td>
2033 <td><code>screen-sm-up
</code></td>
2034 <td>Tablets and desktop PC
</td>
2035 <td><code>(min-width:
545px)
</code></td>
2038 <td><code>screen-sm-md
</code></td>
2039 <td>Tablets only
</td>
2040 <td><code>(min-width:
545px) and (max-width:
1024px)
</code></td>
2043 <td><code>screen-md
</code></td>
2044 <td>Tablets (landscape)
</td>
2045 <td><code>(min-width:
769px) and (max-width:
1024px)
</code></td>
2048 <td><code>screen-md-down
</code></td>
2049 <td>Smartphones and Tablets
</td>
2050 <td><code>(max-width:
1024px)
</code></td>
2053 <td><code>screen-md-up
</code></td>
2054 <td>Tablets (landscape) and desktop PC
</td>
2055 <td><code>(min-width:
769px)
</code></td>
2058 <td><code>screen-lg
</code></td>
2060 <td><code>(min-width:
1025px)
</code></td>
2064 <h2 id=
"asset-preloading">Asset Preloading
<a class=
"headerlink" href=
"#asset-preloading" title=
"Permanent link">#
</a></h2>
2065 <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.
2066 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>
2067 <div class=
"highlight"><pre><span></span><code><span class=
"nc">.fooBar
</span> <span class=
"p">{
</span>
2068 <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>
2069 <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>
2070 <span class=
"err">$
</span><span class=
"nt">as
</span><span class=
"nd">:
</span> <span class=
"s2">"image
"</span><span class=
"o">,
</span>
2071 <span class=
"err">$
</span><span class=
"nt">crossorigin
</span><span class=
"nd">:
</span> <span class=
"nt">false
</span><span class=
"o">,
</span>
2072 <span class=
"err">$
</span><span class=
"nt">type
</span><span class=
"nd">:
</span> <span class=
"s2">"image/png
"</span>
2073 <span class=
"o">)
</span><span class=
"p">}
</span><span class=
"o">;
</span>
2075 <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>
2076 <span class=
"p">}
</span>
2078 <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>
2079 <p>The above example will result in a
<code><link
></code> similar to the following being added to the generated HTML:
</p>
2080 <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
">
2082 <div class=
"admonition info">
2083 <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>
2090 <div class=
"md-source-date">
2093 Last update:
2021-
03-
08
2111 <footer class=
"md-footer">
2113 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2115 <a href=
"../templates/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2116 <div class=
"md-footer__button md-icon">
2117 <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>
2119 <div class=
"md-footer__title">
2120 <div class=
"md-ellipsis">
2121 <span class=
"md-footer__direction">
2130 <a href=
"../../javascript/general-usage/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2131 <div class=
"md-footer__title">
2132 <div class=
"md-ellipsis">
2133 <span class=
"md-footer__direction">
2139 <div class=
"md-footer__button md-icon">
2140 <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>
2146 <div class=
"md-footer-meta md-typeset">
2147 <div class=
"md-footer-meta__inner md-grid">
2148 <div class=
"md-footer-copyright">
2150 <div class=
"md-footer-copyright__highlight">
2151 Copyright ©
2020 WoltLab GmbH
2155 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2160 <div class=
"md-footer-copyright">
2161 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2162 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2169 <div class=
"md-dialog" data-md-component=
"dialog">
2170 <div class=
"md-dialog__inner md-typeset"></div>
2172 <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>
2175 <script src=
"../../assets/javascripts/bundle.5cf3e710.min.js"></script>