3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"icon" href=
"../../assets/default.favicon.ico">
13 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.1.0">
17 <title>CSS - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../assets/stylesheets/main.33e2939f.min.css">
24 <link rel=
"stylesheet" href=
"../../assets/stylesheets/palette.ef6f36e2.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=
"">
55 <script>function __prefix(e){return new URL(
"../..",location).pathname+
"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}
</script>
57 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
58 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
59 <label class=
"md-overlay" for=
"__drawer"></label>
60 <div data-md-component=
"skip">
63 <a href=
"#css" class=
"md-skip">
68 <div data-md-component=
"announce">
70 <aside class=
"md-announce">
71 <div class=
"md-announce__inner md-grid md-typeset">
73 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
80 <header class=
"md-header" data-md-component=
"header">
81 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
82 <a href=
"../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
84 <img src=
"../../assets/logo.png" alt=
"logo">
87 <label class=
"md-header__button md-icon" for=
"__drawer">
88 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
90 <div class=
"md-header__title" data-md-component=
"header-title">
91 <div class=
"md-header__ellipsis">
92 <div class=
"md-header__topic">
93 <span class=
"md-ellipsis">
94 WoltLab Suite Documentation
97 <div class=
"md-header__topic" data-md-component=
"header-topic">
98 <span class=
"md-ellipsis">
109 <label class=
"md-header__button md-icon" for=
"__search">
110 <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>
113 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
114 <label class=
"md-search__overlay" for=
"__search"></label>
115 <div class=
"md-search__inner" role=
"search">
116 <form class=
"md-search__form" name=
"search">
117 <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
>
118 <label class=
"md-search__icon md-icon" for=
"__search">
119 <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>
120 <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>
122 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
123 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M19 6.41 17.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>
126 <div class=
"md-search__output">
127 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
128 <div class=
"md-search-result" data-md-component=
"search-result">
129 <div class=
"md-search-result__meta">
132 <ol class=
"md-search-result__list"></ol>
140 <div class=
"md-header__source">
142 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
143 <div class=
"md-source__icon md-icon">
145 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05 244 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>
147 <div class=
"md-source__repository">
156 <div class=
"md-container" data-md-component=
"container">
161 <main class=
"md-main" data-md-component=
"main">
162 <div class=
"md-main__inner md-grid">
166 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
167 <div class=
"md-sidebar__scrollwrap">
168 <div class=
"md-sidebar__inner">
172 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
173 <label class=
"md-nav__title" for=
"__drawer">
174 <a href=
"../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
176 <img src=
"../../assets/logo.png" alt=
"logo">
179 WoltLab Suite Documentation
182 <div class=
"md-nav__source">
184 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
185 <div class=
"md-source__icon md-icon">
187 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05 244 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>
189 <div class=
"md-source__repository">
195 <ul class=
"md-nav__list" data-md-scrollfix
>
204 <li class=
"md-nav__item">
205 <a href=
"../../getting-started/" class=
"md-nav__link">
220 <li class=
"md-nav__item md-nav__item--nested">
223 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
225 <label class=
"md-nav__link" for=
"__nav_2">
227 <span class=
"md-nav__icon md-icon"></span>
229 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
230 <label class=
"md-nav__title" for=
"__nav_2">
231 <span class=
"md-nav__icon md-icon"></span>
234 <ul class=
"md-nav__list" data-md-scrollfix
>
240 <li class=
"md-nav__item">
241 <a href=
"../../php/pages/" class=
"md-nav__link">
252 <li class=
"md-nav__item">
253 <a href=
"../../php/database-objects/" class=
"md-nav__link">
264 <li class=
"md-nav__item">
265 <a href=
"../../php/database-access/" class=
"md-nav__link">
276 <li class=
"md-nav__item">
277 <a href=
"../../php/exceptions/" class=
"md-nav__link">
289 <li class=
"md-nav__item md-nav__item--nested">
292 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
294 <label class=
"md-nav__link" for=
"__nav_2_5">
296 <span class=
"md-nav__icon md-icon"></span>
298 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
299 <label class=
"md-nav__title" for=
"__nav_2_5">
300 <span class=
"md-nav__icon md-icon"></span>
303 <ul class=
"md-nav__list" data-md-scrollfix
>
309 <li class=
"md-nav__item">
310 <a href=
"../../php/api/caches/" class=
"md-nav__link">
321 <li class=
"md-nav__item">
322 <a href=
"../../php/api/comments/" class=
"md-nav__link">
333 <li class=
"md-nav__item">
334 <a href=
"../../php/api/cronjobs/" class=
"md-nav__link">
345 <li class=
"md-nav__item">
346 <a href=
"../../php/api/events/" class=
"md-nav__link">
358 <li class=
"md-nav__item md-nav__item--nested">
361 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
363 <label class=
"md-nav__link" for=
"__nav_2_5_5">
365 <span class=
"md-nav__icon md-icon"></span>
367 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
368 <label class=
"md-nav__title" for=
"__nav_2_5_5">
369 <span class=
"md-nav__icon md-icon"></span>
372 <ul class=
"md-nav__list" data-md-scrollfix
>
378 <li class=
"md-nav__item">
379 <a href=
"../../php/api/form_builder/overview/" class=
"md-nav__link">
390 <li class=
"md-nav__item">
391 <a href=
"../../php/api/form_builder/structure/" class=
"md-nav__link">
402 <li class=
"md-nav__item">
403 <a href=
"../../php/api/form_builder/form_fields/" class=
"md-nav__link">
414 <li class=
"md-nav__item">
415 <a href=
"../../php/api/form_builder/validation_data/" class=
"md-nav__link">
426 <li class=
"md-nav__item">
427 <a href=
"../../php/api/form_builder/dependencies/" class=
"md-nav__link">
444 <li class=
"md-nav__item">
445 <a href=
"../../php/api/package_installation_plugins/" class=
"md-nav__link">
446 Package Installation Plugins
456 <li class=
"md-nav__item">
457 <a href=
"../../php/api/user_activity_points/" class=
"md-nav__link">
468 <li class=
"md-nav__item">
469 <a href=
"../../php/api/user_notifications/" class=
"md-nav__link">
480 <li class=
"md-nav__item">
481 <a href=
"../../php/api/sitemaps/" class=
"md-nav__link">
498 <li class=
"md-nav__item">
499 <a href=
"../../php/code-style/" class=
"md-nav__link">
510 <li class=
"md-nav__item">
511 <a href=
"../../php/apps/" class=
"md-nav__link">
522 <li class=
"md-nav__item">
523 <a href=
"../../php/gdpr/" class=
"md-nav__link">
546 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
549 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" checked
>
551 <label class=
"md-nav__link" for=
"__nav_3">
552 Languages, Templates & CSS
553 <span class=
"md-nav__icon md-icon"></span>
555 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
556 <label class=
"md-nav__title" for=
"__nav_3">
557 <span class=
"md-nav__icon md-icon"></span>
558 Languages, Templates & CSS
560 <ul class=
"md-nav__list" data-md-scrollfix
>
566 <li class=
"md-nav__item">
567 <a href=
"../languages/" class=
"md-nav__link">
578 <li class=
"md-nav__item">
579 <a href=
"../templates/" class=
"md-nav__link">
592 <li class=
"md-nav__item md-nav__item--active">
594 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
599 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
601 <span class=
"md-nav__icon md-icon"></span>
604 <a href=
"./" class=
"md-nav__link md-nav__link--active">
609 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
615 <label class=
"md-nav__title" for=
"__toc">
616 <span class=
"md-nav__icon md-icon"></span>
619 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
621 <li class=
"md-nav__item">
622 <a href=
"#scss-and-css" class=
"md-nav__link">
626 <nav class=
"md-nav" aria-label=
"SCSS and CSS">
627 <ul class=
"md-nav__list">
629 <li class=
"md-nav__item">
630 <a href=
"#file-location" class=
"md-nav__link">
636 <li class=
"md-nav__item">
637 <a href=
"#variables" class=
"md-nav__link">
641 <nav class=
"md-nav" aria-label=
"Variables">
642 <ul class=
"md-nav__list">
644 <li class=
"md-nav__item">
645 <a href=
"#linking-images" class=
"md-nav__link">
661 <li class=
"md-nav__item">
662 <a href=
"#media-breakpoints" class=
"md-nav__link">
666 <nav class=
"md-nav" aria-label=
"Media Breakpoints">
667 <ul class=
"md-nav__list">
669 <li class=
"md-nav__item">
670 <a href=
"#available-breakpoints" class=
"md-nav__link">
671 Available Breakpoints
681 <li class=
"md-nav__item">
682 <a href=
"#asset-preloading" class=
"md-nav__link">
710 <li class=
"md-nav__item md-nav__item--nested">
713 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
715 <label class=
"md-nav__link" for=
"__nav_4">
717 <span class=
"md-nav__icon md-icon"></span>
719 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
720 <label class=
"md-nav__title" for=
"__nav_4">
721 <span class=
"md-nav__icon md-icon"></span>
724 <ul class=
"md-nav__list" data-md-scrollfix
>
730 <li class=
"md-nav__item">
731 <a href=
"../../javascript/general-usage/" class=
"md-nav__link">
743 <li class=
"md-nav__item md-nav__item--nested">
746 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
748 <label class=
"md-nav__link" for=
"__nav_4_2">
750 <span class=
"md-nav__icon md-icon"></span>
752 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
753 <label class=
"md-nav__title" for=
"__nav_4_2">
754 <span class=
"md-nav__icon md-icon"></span>
757 <ul class=
"md-nav__list" data-md-scrollfix
>
763 <li class=
"md-nav__item">
764 <a href=
"../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
775 <li class=
"md-nav__item">
776 <a href=
"../../javascript/new-api_data-structures/" class=
"md-nav__link">
787 <li class=
"md-nav__item">
788 <a href=
"../../javascript/new-api_core/" class=
"md-nav__link">
799 <li class=
"md-nav__item">
800 <a href=
"../../javascript/new-api_dom/" class=
"md-nav__link">
811 <li class=
"md-nav__item">
812 <a href=
"../../javascript/new-api_events/" class=
"md-nav__link">
823 <li class=
"md-nav__item">
824 <a href=
"../../javascript/new-api_ajax/" class=
"md-nav__link">
835 <li class=
"md-nav__item">
836 <a href=
"../../javascript/new-api_dialogs/" class=
"md-nav__link">
847 <li class=
"md-nav__item">
848 <a href=
"../../javascript/new-api_browser/" class=
"md-nav__link">
849 Browser and Screen Sizes
859 <li class=
"md-nav__item">
860 <a href=
"../../javascript/new-api_ui/" class=
"md-nav__link">
877 <li class=
"md-nav__item">
878 <a href=
"../../javascript/legacy-api/" class=
"md-nav__link">
889 <li class=
"md-nav__item">
890 <a href=
"../../javascript/helper-functions/" class=
"md-nav__link">
901 <li class=
"md-nav__item">
902 <a href=
"../../javascript/code-snippets/" class=
"md-nav__link">
923 <li class=
"md-nav__item md-nav__item--nested">
926 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
928 <label class=
"md-nav__link" for=
"__nav_5">
930 <span class=
"md-nav__icon md-icon"></span>
932 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
933 <label class=
"md-nav__title" for=
"__nav_5">
934 <span class=
"md-nav__icon md-icon"></span>
937 <ul class=
"md-nav__list" data-md-scrollfix
>
943 <li class=
"md-nav__item">
944 <a href=
"../../package/package-xml/" class=
"md-nav__link">
956 <li class=
"md-nav__item md-nav__item--nested">
959 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
961 <label class=
"md-nav__link" for=
"__nav_5_2">
963 <span class=
"md-nav__icon md-icon"></span>
965 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
966 <label class=
"md-nav__title" for=
"__nav_5_2">
967 <span class=
"md-nav__icon md-icon"></span>
970 <ul class=
"md-nav__list" data-md-scrollfix
>
976 <li class=
"md-nav__item">
977 <a href=
"../../package/pip/" class=
"md-nav__link">
988 <li class=
"md-nav__item">
989 <a href=
"../../package/pip/acl-option/" class=
"md-nav__link">
1000 <li class=
"md-nav__item">
1001 <a href=
"../../package/pip/acp-menu/" class=
"md-nav__link">
1012 <li class=
"md-nav__item">
1013 <a href=
"../../package/pip/acp-search-provider/" class=
"md-nav__link">
1024 <li class=
"md-nav__item">
1025 <a href=
"../../package/pip/acp-template/" class=
"md-nav__link">
1036 <li class=
"md-nav__item">
1037 <a href=
"../../package/pip/bbcode/" class=
"md-nav__link">
1048 <li class=
"md-nav__item">
1049 <a href=
"../../package/pip/box/" class=
"md-nav__link">
1060 <li class=
"md-nav__item">
1061 <a href=
"../../package/pip/clipboard-action/" class=
"md-nav__link">
1072 <li class=
"md-nav__item">
1073 <a href=
"../../package/pip/core-object/" class=
"md-nav__link">
1084 <li class=
"md-nav__item">
1085 <a href=
"../../package/pip/cronjob/" class=
"md-nav__link">
1096 <li class=
"md-nav__item">
1097 <a href=
"../../package/pip/event-listener/" class=
"md-nav__link">
1108 <li class=
"md-nav__item">
1109 <a href=
"../../package/pip/file/" class=
"md-nav__link">
1120 <li class=
"md-nav__item">
1121 <a href=
"../../package/pip/language/" class=
"md-nav__link">
1132 <li class=
"md-nav__item">
1133 <a href=
"../../package/pip/media-provider/" class=
"md-nav__link">
1144 <li class=
"md-nav__item">
1145 <a href=
"../../package/pip/menu/" class=
"md-nav__link">
1156 <li class=
"md-nav__item">
1157 <a href=
"../../package/pip/menu-item/" class=
"md-nav__link">
1168 <li class=
"md-nav__item">
1169 <a href=
"../../package/pip/object-type/" class=
"md-nav__link">
1180 <li class=
"md-nav__item">
1181 <a href=
"../../package/pip/object-type-definition/" class=
"md-nav__link">
1182 objectTypeDefinition
1192 <li class=
"md-nav__item">
1193 <a href=
"../../package/pip/option/" class=
"md-nav__link">
1204 <li class=
"md-nav__item">
1205 <a href=
"../../package/pip/page/" class=
"md-nav__link">
1216 <li class=
"md-nav__item">
1217 <a href=
"../../package/pip/pip/" class=
"md-nav__link">
1228 <li class=
"md-nav__item">
1229 <a href=
"../../package/pip/script/" class=
"md-nav__link">
1240 <li class=
"md-nav__item">
1241 <a href=
"../../package/pip/smiley/" class=
"md-nav__link">
1252 <li class=
"md-nav__item">
1253 <a href=
"../../package/pip/sql/" class=
"md-nav__link">
1264 <li class=
"md-nav__item">
1265 <a href=
"../../package/pip/style/" class=
"md-nav__link">
1276 <li class=
"md-nav__item">
1277 <a href=
"../../package/pip/template/" class=
"md-nav__link">
1288 <li class=
"md-nav__item">
1289 <a href=
"../../package/pip/template-listener/" class=
"md-nav__link">
1300 <li class=
"md-nav__item">
1301 <a href=
"../../package/pip/user-group-option/" class=
"md-nav__link">
1312 <li class=
"md-nav__item">
1313 <a href=
"../../package/pip/user-menu/" class=
"md-nav__link">
1324 <li class=
"md-nav__item">
1325 <a href=
"../../package/pip/user-notification-event/" class=
"md-nav__link">
1326 userNotificationEvent
1336 <li class=
"md-nav__item">
1337 <a href=
"../../package/pip/user-option/" class=
"md-nav__link">
1348 <li class=
"md-nav__item">
1349 <a href=
"../../package/pip/user-profile-menu/" class=
"md-nav__link">
1366 <li class=
"md-nav__item">
1367 <a href=
"../../package/database-php-api/" class=
"md-nav__link">
1388 <li class=
"md-nav__item md-nav__item--nested">
1391 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1393 <label class=
"md-nav__link" for=
"__nav_6">
1395 <span class=
"md-nav__icon md-icon"></span>
1397 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1398 <label class=
"md-nav__title" for=
"__nav_6">
1399 <span class=
"md-nav__icon md-icon"></span>
1402 <ul class=
"md-nav__list" data-md-scrollfix
>
1409 <li class=
"md-nav__item md-nav__item--nested">
1412 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1414 <label class=
"md-nav__link" for=
"__nav_6_1">
1415 Migrating from WSC
5.3
1416 <span class=
"md-nav__icon md-icon"></span>
1418 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1419 <label class=
"md-nav__title" for=
"__nav_6_1">
1420 <span class=
"md-nav__icon md-icon"></span>
1421 Migrating from WSC
5.3
1423 <ul class=
"md-nav__list" data-md-scrollfix
>
1429 <li class=
"md-nav__item">
1430 <a href=
"../../migration/wsc53/php/" class=
"md-nav__link">
1441 <li class=
"md-nav__item">
1442 <a href=
"../../migration/wsc53/session/" class=
"md-nav__link">
1443 Session Handling and Authentication
1453 <li class=
"md-nav__item">
1454 <a href=
"../../migration/wsc53/javascript/" class=
"md-nav__link">
1465 <li class=
"md-nav__item">
1466 <a href=
"../../migration/wsc53/templates/" class=
"md-nav__link">
1477 <li class=
"md-nav__item">
1478 <a href=
"../../migration/wsc53/libraries/" class=
"md-nav__link">
1479 Third Party Libraries
1496 <li class=
"md-nav__item md-nav__item--nested">
1499 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1501 <label class=
"md-nav__link" for=
"__nav_6_2">
1502 Migrating from WSC
5.2
1503 <span class=
"md-nav__icon md-icon"></span>
1505 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1506 <label class=
"md-nav__title" for=
"__nav_6_2">
1507 <span class=
"md-nav__icon md-icon"></span>
1508 Migrating from WSC
5.2
1510 <ul class=
"md-nav__list" data-md-scrollfix
>
1516 <li class=
"md-nav__item">
1517 <a href=
"../../migration/wsc52/php/" class=
"md-nav__link">
1528 <li class=
"md-nav__item">
1529 <a href=
"../../migration/wsc52/templates/" class=
"md-nav__link">
1530 Templates and Languages
1540 <li class=
"md-nav__item">
1541 <a href=
"../../migration/wsc52/libraries/" class=
"md-nav__link">
1542 Third Party Libraries
1559 <li class=
"md-nav__item md-nav__item--nested">
1562 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1564 <label class=
"md-nav__link" for=
"__nav_6_3">
1565 Migrating from WSC
3.1
1566 <span class=
"md-nav__icon md-icon"></span>
1568 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1569 <label class=
"md-nav__title" for=
"__nav_6_3">
1570 <span class=
"md-nav__icon md-icon"></span>
1571 Migrating from WSC
3.1
1573 <ul class=
"md-nav__list" data-md-scrollfix
>
1579 <li class=
"md-nav__item">
1580 <a href=
"../../migration/wsc31/php/" class=
"md-nav__link">
1598 <li class=
"md-nav__item md-nav__item--nested">
1601 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1603 <label class=
"md-nav__link" for=
"__nav_6_4">
1604 Migrating from WSC
3.0
1605 <span class=
"md-nav__icon md-icon"></span>
1607 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1608 <label class=
"md-nav__title" for=
"__nav_6_4">
1609 <span class=
"md-nav__icon md-icon"></span>
1610 Migrating from WSC
3.0
1612 <ul class=
"md-nav__list" data-md-scrollfix
>
1618 <li class=
"md-nav__item">
1619 <a href=
"../../migration/wsc30/php/" class=
"md-nav__link">
1630 <li class=
"md-nav__item">
1631 <a href=
"../../migration/wsc30/javascript/" class=
"md-nav__link">
1642 <li class=
"md-nav__item">
1643 <a href=
"../../migration/wsc30/templates/" class=
"md-nav__link">
1654 <li class=
"md-nav__item">
1655 <a href=
"../../migration/wsc30/css/" class=
"md-nav__link">
1666 <li class=
"md-nav__item">
1667 <a href=
"../../migration/wsc30/package/" class=
"md-nav__link">
1685 <li class=
"md-nav__item md-nav__item--nested">
1688 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1690 <label class=
"md-nav__link" for=
"__nav_6_5">
1691 Migrating from WCF
2.1
1692 <span class=
"md-nav__icon md-icon"></span>
1694 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1695 <label class=
"md-nav__title" for=
"__nav_6_5">
1696 <span class=
"md-nav__icon md-icon"></span>
1697 Migrating from WCF
2.1
1699 <ul class=
"md-nav__list" data-md-scrollfix
>
1705 <li class=
"md-nav__item">
1706 <a href=
"../../migration/wcf21/php/" class=
"md-nav__link">
1717 <li class=
"md-nav__item">
1718 <a href=
"../../migration/wcf21/templates/" class=
"md-nav__link">
1729 <li class=
"md-nav__item">
1730 <a href=
"../../migration/wcf21/css/" class=
"md-nav__link">
1741 <li class=
"md-nav__item">
1742 <a href=
"../../migration/wcf21/package/" class=
"md-nav__link">
1769 <li class=
"md-nav__item md-nav__item--nested">
1772 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1774 <label class=
"md-nav__link" for=
"__nav_7">
1776 <span class=
"md-nav__icon md-icon"></span>
1778 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1779 <label class=
"md-nav__title" for=
"__nav_7">
1780 <span class=
"md-nav__icon md-icon"></span>
1783 <ul class=
"md-nav__list" data-md-scrollfix
>
1790 <li class=
"md-nav__item md-nav__item--nested">
1793 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1795 <label class=
"md-nav__link" for=
"__nav_7_1">
1797 <span class=
"md-nav__icon md-icon"></span>
1799 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1800 <label class=
"md-nav__title" for=
"__nav_7_1">
1801 <span class=
"md-nav__icon md-icon"></span>
1804 <ul class=
"md-nav__list" data-md-scrollfix
>
1810 <li class=
"md-nav__item">
1811 <a href=
"../../tutorial/series/overview/" class=
"md-nav__link">
1822 <li class=
"md-nav__item">
1823 <a href=
"../../tutorial/series/part_1/" class=
"md-nav__link">
1834 <li class=
"md-nav__item">
1835 <a href=
"../../tutorial/series/part_2/" class=
"md-nav__link">
1846 <li class=
"md-nav__item">
1847 <a href=
"../../tutorial/series/part_3/" class=
"md-nav__link">
1874 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1875 <div class=
"md-sidebar__scrollwrap">
1876 <div class=
"md-sidebar__inner">
1878 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1884 <label class=
"md-nav__title" for=
"__toc">
1885 <span class=
"md-nav__icon md-icon"></span>
1888 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1890 <li class=
"md-nav__item">
1891 <a href=
"#scss-and-css" class=
"md-nav__link">
1895 <nav class=
"md-nav" aria-label=
"SCSS and CSS">
1896 <ul class=
"md-nav__list">
1898 <li class=
"md-nav__item">
1899 <a href=
"#file-location" class=
"md-nav__link">
1905 <li class=
"md-nav__item">
1906 <a href=
"#variables" class=
"md-nav__link">
1910 <nav class=
"md-nav" aria-label=
"Variables">
1911 <ul class=
"md-nav__list">
1913 <li class=
"md-nav__item">
1914 <a href=
"#linking-images" class=
"md-nav__link">
1930 <li class=
"md-nav__item">
1931 <a href=
"#media-breakpoints" class=
"md-nav__link">
1935 <nav class=
"md-nav" aria-label=
"Media Breakpoints">
1936 <ul class=
"md-nav__list">
1938 <li class=
"md-nav__item">
1939 <a href=
"#available-breakpoints" class=
"md-nav__link">
1940 Available Breakpoints
1950 <li class=
"md-nav__item">
1951 <a href=
"#asset-preloading" class=
"md-nav__link">
1965 <div class=
"md-content" data-md-component=
"content">
1966 <article class=
"md-content__inner md-typeset">
1969 <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">
1970 <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>
1974 <h1 id=
"css">CSS
<a class=
"headerlink" href=
"#css" title=
"Permanent link">#
</a></h1>
1975 <h2 id=
"scss-and-css">SCSS and CSS
<a class=
"headerlink" href=
"#scss-and-css" title=
"Permanent link">#
</a></h2>
1976 <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>
1977 <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>
1978 <h3 id=
"file-location">File Location
<a class=
"headerlink" href=
"#file-location" title=
"Permanent link">#
</a></h3>
1979 <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>
1980 <h3 id=
"variables">Variables
<a class=
"headerlink" href=
"#variables" title=
"Permanent link">#
</a></h3>
1981 <p>You can access variables with
<code>$myVariable
</code>, variable interpolation (variables inside strings) is accomplished with
<code>#{$myVariable}
</code>.
</p>
1982 <h4 id=
"linking-images">Linking images
<a class=
"headerlink" href=
"#linking-images" title=
"Permanent link">#
</a></h4>
1983 <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>
1984 <h2 id=
"media-breakpoints">Media Breakpoints
<a class=
"headerlink" href=
"#media-breakpoints" title=
"Permanent link">#
</a></h2>
1985 <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>
1986 <div class=
"highlight"><pre><span></span><code><span class=
"cm">/* red background color for desktop pc */
</span>
1987 <span class=
"k">@include
</span><span class=
"nd"> screen-lg
</span> <span class=
"p">{
</span>
1988 <span class=
"nt">body
</span> <span class=
"p">{
</span>
1989 <span class=
"nt">background-color
</span><span class=
"nd">:
</span> <span class=
"nt">red
</span><span class=
"o">;
</span>
1990 <span class=
"p">}
</span>
1991 <span class=
"p">}
</span>
1993 <span class=
"cm">/* green background color on smartphones and tablets */
</span>
1994 <span class=
"k">@include
</span><span class=
"nd"> screen-md-down
</span> <span class=
"p">{
</span>
1995 <span class=
"nt">body
</span> <span class=
"p">{
</span>
1996 <span class=
"nt">background-color
</span><span class=
"nd">:
</span> <span class=
"nt">green
</span><span class=
"o">;
</span>
1997 <span class=
"p">}
</span>
1998 <span class=
"p">}
</span>
2000 <h3 id=
"available-breakpoints">Available Breakpoints
<a class=
"headerlink" href=
"#available-breakpoints" title=
"Permanent link">#
</a></h3>
2001 <div class=
"admonition info">
2002 <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>
2009 <th><code>@media
</code> equivalent
</th>
2014 <td><code>screen-xs
</code></td>
2015 <td>Smartphones only
</td>
2016 <td><code>(max-width:
544px)
</code></td>
2019 <td><code>screen-sm
</code></td>
2020 <td>Tablets (portrait)
</td>
2021 <td><code>(min-width:
545px) and (max-width:
768px)
</code></td>
2024 <td><code>screen-sm-down
</code></td>
2025 <td>Tablets (portrait) and smartphones
</td>
2026 <td><code>(max-width:
768px)
</code></td>
2029 <td><code>screen-sm-up
</code></td>
2030 <td>Tablets and desktop PC
</td>
2031 <td><code>(min-width:
545px)
</code></td>
2034 <td><code>screen-sm-md
</code></td>
2035 <td>Tablets only
</td>
2036 <td><code>(min-width:
545px) and (max-width:
1024px)
</code></td>
2039 <td><code>screen-md
</code></td>
2040 <td>Tablets (landscape)
</td>
2041 <td><code>(min-width:
769px) and (max-width:
1024px)
</code></td>
2044 <td><code>screen-md-down
</code></td>
2045 <td>Smartphones and Tablets
</td>
2046 <td><code>(max-width:
1024px)
</code></td>
2049 <td><code>screen-md-up
</code></td>
2050 <td>Tablets (landscape) and desktop PC
</td>
2051 <td><code>(min-width:
769px)
</code></td>
2054 <td><code>screen-lg
</code></td>
2056 <td><code>(min-width:
1025px)
</code></td>
2060 <h2 id=
"asset-preloading">Asset Preloading
<a class=
"headerlink" href=
"#asset-preloading" title=
"Permanent link">#
</a></h2>
2061 <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.
2062 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>
2063 <div class=
"highlight"><pre><span></span><code><span class=
"nc">.fooBar
</span> <span class=
"p">{
</span>
2064 <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>
2065 <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>
2066 <span class=
"err">$
</span><span class=
"nt">as
</span><span class=
"nd">:
</span> <span class=
"s2">"image
"</span><span class=
"o">,
</span>
2067 <span class=
"err">$
</span><span class=
"nt">crossorigin
</span><span class=
"nd">:
</span> <span class=
"nt">false
</span><span class=
"o">,
</span>
2068 <span class=
"err">$
</span><span class=
"nt">type
</span><span class=
"nd">:
</span> <span class=
"s2">"image/png
"</span>
2069 <span class=
"o">)
</span><span class=
"p">}
</span><span class=
"o">;
</span>
2071 <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>
2072 <span class=
"p">}
</span>
2074 <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>
2075 <p>The above example will result in a
<code><link
></code> similar to the following being added to the generated HTML:
</p>
2076 <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
">
2078 <div class=
"admonition info">
2079 <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>
2086 <div class=
"md-source-date">
2089 Last update:
2021-
03-
08
2108 <footer class=
"md-footer">
2110 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2112 <a href=
"../templates/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2113 <div class=
"md-footer__button md-icon">
2114 <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>
2116 <div class=
"md-footer__title">
2117 <div class=
"md-ellipsis">
2118 <span class=
"md-footer__direction">
2127 <a href=
"../../javascript/general-usage/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2128 <div class=
"md-footer__title">
2129 <div class=
"md-ellipsis">
2130 <span class=
"md-footer__direction">
2136 <div class=
"md-footer__button md-icon">
2137 <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>
2143 <div class=
"md-footer-meta md-typeset">
2144 <div class=
"md-footer-meta__inner md-grid">
2145 <div class=
"md-footer-copyright">
2147 <div class=
"md-footer-copyright__highlight">
2148 Copyright ©
2020 WoltLab GmbH
2152 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2157 <div class=
"md-footer-copyright">
2158 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2159 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2166 <div class=
"md-dialog" data-md-component=
"dialog">
2167 <div class=
"md-dialog__inner md-typeset"></div>
2169 <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.fe42c31b.min.js",
"version": {
"provider":
"mike"}}
</script>
2172 <script src=
"../../assets/javascripts/bundle.d892486b.min.js"></script>