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
>
310 <li class=
"md-nav__item md-nav__item--nested">
313 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_1" type=
"checkbox" id=
"__nav_2_5_1" >
315 <label class=
"md-nav__link" for=
"__nav_2_5_1">
317 <span class=
"md-nav__icon md-icon"></span>
319 <nav class=
"md-nav" aria-label=
"Caches" data-md-level=
"3">
320 <label class=
"md-nav__title" for=
"__nav_2_5_1">
321 <span class=
"md-nav__icon md-icon"></span>
324 <ul class=
"md-nav__list" data-md-scrollfix
>
330 <li class=
"md-nav__item">
331 <a href=
"../../php/api/caches/" class=
"md-nav__link">
342 <li class=
"md-nav__item">
343 <a href=
"../../php/api/caches_persistent-caches/" class=
"md-nav__link">
354 <li class=
"md-nav__item">
355 <a href=
"../../php/api/caches_runtime-caches/" class=
"md-nav__link">
372 <li class=
"md-nav__item">
373 <a href=
"../../php/api/comments/" class=
"md-nav__link">
384 <li class=
"md-nav__item">
385 <a href=
"../../php/api/cronjobs/" class=
"md-nav__link">
396 <li class=
"md-nav__item">
397 <a href=
"../../php/api/events/" class=
"md-nav__link">
409 <li class=
"md-nav__item md-nav__item--nested">
412 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
414 <label class=
"md-nav__link" for=
"__nav_2_5_5">
416 <span class=
"md-nav__icon md-icon"></span>
418 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
419 <label class=
"md-nav__title" for=
"__nav_2_5_5">
420 <span class=
"md-nav__icon md-icon"></span>
423 <ul class=
"md-nav__list" data-md-scrollfix
>
429 <li class=
"md-nav__item">
430 <a href=
"../../php/api/form_builder/overview/" class=
"md-nav__link">
441 <li class=
"md-nav__item">
442 <a href=
"../../php/api/form_builder/structure/" class=
"md-nav__link">
453 <li class=
"md-nav__item">
454 <a href=
"../../php/api/form_builder/form_fields/" class=
"md-nav__link">
465 <li class=
"md-nav__item">
466 <a href=
"../../php/api/form_builder/validation_data/" class=
"md-nav__link">
477 <li class=
"md-nav__item">
478 <a href=
"../../php/api/form_builder/dependencies/" class=
"md-nav__link">
495 <li class=
"md-nav__item">
496 <a href=
"../../php/api/package_installation_plugins/" class=
"md-nav__link">
497 Package Installation Plugins
507 <li class=
"md-nav__item">
508 <a href=
"../../php/api/user_activity_points/" class=
"md-nav__link">
519 <li class=
"md-nav__item">
520 <a href=
"../../php/api/user_notifications/" class=
"md-nav__link">
531 <li class=
"md-nav__item">
532 <a href=
"../../php/api/sitemaps/" class=
"md-nav__link">
549 <li class=
"md-nav__item">
550 <a href=
"../../php/code-style/" class=
"md-nav__link">
561 <li class=
"md-nav__item">
562 <a href=
"../../php/apps/" class=
"md-nav__link">
573 <li class=
"md-nav__item">
574 <a href=
"../../php/gdpr/" class=
"md-nav__link">
597 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
600 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" checked
>
602 <label class=
"md-nav__link" for=
"__nav_3">
603 Languages, Templates & CSS
604 <span class=
"md-nav__icon md-icon"></span>
606 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
607 <label class=
"md-nav__title" for=
"__nav_3">
608 <span class=
"md-nav__icon md-icon"></span>
609 Languages, Templates & CSS
611 <ul class=
"md-nav__list" data-md-scrollfix
>
617 <li class=
"md-nav__item">
618 <a href=
"../languages/" class=
"md-nav__link">
629 <li class=
"md-nav__item">
630 <a href=
"../templates/" class=
"md-nav__link">
641 <li class=
"md-nav__item">
642 <a href=
"../template-plugins/" class=
"md-nav__link">
655 <li class=
"md-nav__item md-nav__item--active">
657 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
662 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
664 <span class=
"md-nav__icon md-icon"></span>
667 <a href=
"./" class=
"md-nav__link md-nav__link--active">
672 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
678 <label class=
"md-nav__title" for=
"__toc">
679 <span class=
"md-nav__icon md-icon"></span>
682 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
684 <li class=
"md-nav__item">
685 <a href=
"#scss-and-css" class=
"md-nav__link">
689 <nav class=
"md-nav" aria-label=
"SCSS and CSS">
690 <ul class=
"md-nav__list">
692 <li class=
"md-nav__item">
693 <a href=
"#file-location" class=
"md-nav__link">
699 <li class=
"md-nav__item">
700 <a href=
"#variables" class=
"md-nav__link">
704 <nav class=
"md-nav" aria-label=
"Variables">
705 <ul class=
"md-nav__list">
707 <li class=
"md-nav__item">
708 <a href=
"#linking-images" class=
"md-nav__link">
724 <li class=
"md-nav__item">
725 <a href=
"#media-breakpoints" class=
"md-nav__link">
729 <nav class=
"md-nav" aria-label=
"Media Breakpoints">
730 <ul class=
"md-nav__list">
732 <li class=
"md-nav__item">
733 <a href=
"#available-breakpoints" class=
"md-nav__link">
734 Available Breakpoints
744 <li class=
"md-nav__item">
745 <a href=
"#asset-preloading" class=
"md-nav__link">
773 <li class=
"md-nav__item md-nav__item--nested">
776 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
778 <label class=
"md-nav__link" for=
"__nav_4">
779 TypeScript and JavaScript API
780 <span class=
"md-nav__icon md-icon"></span>
782 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
783 <label class=
"md-nav__title" for=
"__nav_4">
784 <span class=
"md-nav__icon md-icon"></span>
785 TypeScript and JavaScript API
787 <ul class=
"md-nav__list" data-md-scrollfix
>
793 <li class=
"md-nav__item">
794 <a href=
"../../javascript/general-usage/" class=
"md-nav__link">
805 <li class=
"md-nav__item">
806 <a href=
"../../javascript/typescript/" class=
"md-nav__link">
818 <li class=
"md-nav__item md-nav__item--nested">
821 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
823 <label class=
"md-nav__link" for=
"__nav_4_3">
825 <span class=
"md-nav__icon md-icon"></span>
827 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
828 <label class=
"md-nav__title" for=
"__nav_4_3">
829 <span class=
"md-nav__icon md-icon"></span>
832 <ul class=
"md-nav__list" data-md-scrollfix
>
838 <li class=
"md-nav__item">
839 <a href=
"../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
850 <li class=
"md-nav__item">
851 <a href=
"../../javascript/new-api_data-structures/" class=
"md-nav__link">
862 <li class=
"md-nav__item">
863 <a href=
"../../javascript/new-api_core/" class=
"md-nav__link">
874 <li class=
"md-nav__item">
875 <a href=
"../../javascript/new-api_dom/" class=
"md-nav__link">
886 <li class=
"md-nav__item">
887 <a href=
"../../javascript/new-api_events/" class=
"md-nav__link">
898 <li class=
"md-nav__item">
899 <a href=
"../../javascript/new-api_ajax/" class=
"md-nav__link">
910 <li class=
"md-nav__item">
911 <a href=
"../../javascript/new-api_dialogs/" class=
"md-nav__link">
922 <li class=
"md-nav__item">
923 <a href=
"../../javascript/new-api_browser/" class=
"md-nav__link">
924 Browser and Screen Sizes
934 <li class=
"md-nav__item">
935 <a href=
"../../javascript/new-api_ui/" class=
"md-nav__link">
952 <li class=
"md-nav__item">
953 <a href=
"../../javascript/legacy-api/" class=
"md-nav__link">
964 <li class=
"md-nav__item">
965 <a href=
"../../javascript/helper-functions/" class=
"md-nav__link">
976 <li class=
"md-nav__item">
977 <a href=
"../../javascript/code-snippets/" class=
"md-nav__link">
998 <li class=
"md-nav__item md-nav__item--nested">
1001 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
1003 <label class=
"md-nav__link" for=
"__nav_5">
1005 <span class=
"md-nav__icon md-icon"></span>
1007 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
1008 <label class=
"md-nav__title" for=
"__nav_5">
1009 <span class=
"md-nav__icon md-icon"></span>
1012 <ul class=
"md-nav__list" data-md-scrollfix
>
1018 <li class=
"md-nav__item">
1019 <a href=
"../../package/package-xml/" class=
"md-nav__link">
1031 <li class=
"md-nav__item md-nav__item--nested">
1034 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
1036 <label class=
"md-nav__link" for=
"__nav_5_2">
1038 <span class=
"md-nav__icon md-icon"></span>
1040 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
1041 <label class=
"md-nav__title" for=
"__nav_5_2">
1042 <span class=
"md-nav__icon md-icon"></span>
1045 <ul class=
"md-nav__list" data-md-scrollfix
>
1051 <li class=
"md-nav__item">
1052 <a href=
"../../package/pip/" class=
"md-nav__link">
1063 <li class=
"md-nav__item">
1064 <a href=
"../../package/pip/acl-option/" class=
"md-nav__link">
1075 <li class=
"md-nav__item">
1076 <a href=
"../../package/pip/acp-menu/" class=
"md-nav__link">
1087 <li class=
"md-nav__item">
1088 <a href=
"../../package/pip/acp-search-provider/" class=
"md-nav__link">
1099 <li class=
"md-nav__item">
1100 <a href=
"../../package/pip/acp-template/" class=
"md-nav__link">
1111 <li class=
"md-nav__item">
1112 <a href=
"../../package/pip/bbcode/" class=
"md-nav__link">
1123 <li class=
"md-nav__item">
1124 <a href=
"../../package/pip/box/" class=
"md-nav__link">
1135 <li class=
"md-nav__item">
1136 <a href=
"../../package/pip/clipboard-action/" class=
"md-nav__link">
1147 <li class=
"md-nav__item">
1148 <a href=
"../../package/pip/core-object/" class=
"md-nav__link">
1159 <li class=
"md-nav__item">
1160 <a href=
"../../package/pip/cronjob/" class=
"md-nav__link">
1171 <li class=
"md-nav__item">
1172 <a href=
"../../package/pip/database/" class=
"md-nav__link">
1183 <li class=
"md-nav__item">
1184 <a href=
"../../package/pip/event-listener/" class=
"md-nav__link">
1195 <li class=
"md-nav__item">
1196 <a href=
"../../package/pip/file/" class=
"md-nav__link">
1207 <li class=
"md-nav__item">
1208 <a href=
"../../package/pip/language/" class=
"md-nav__link">
1219 <li class=
"md-nav__item">
1220 <a href=
"../../package/pip/media-provider/" class=
"md-nav__link">
1231 <li class=
"md-nav__item">
1232 <a href=
"../../package/pip/menu/" class=
"md-nav__link">
1243 <li class=
"md-nav__item">
1244 <a href=
"../../package/pip/menu-item/" class=
"md-nav__link">
1255 <li class=
"md-nav__item">
1256 <a href=
"../../package/pip/object-type/" class=
"md-nav__link">
1267 <li class=
"md-nav__item">
1268 <a href=
"../../package/pip/object-type-definition/" class=
"md-nav__link">
1269 objectTypeDefinition
1279 <li class=
"md-nav__item">
1280 <a href=
"../../package/pip/option/" class=
"md-nav__link">
1291 <li class=
"md-nav__item">
1292 <a href=
"../../package/pip/page/" class=
"md-nav__link">
1303 <li class=
"md-nav__item">
1304 <a href=
"../../package/pip/pip/" class=
"md-nav__link">
1315 <li class=
"md-nav__item">
1316 <a href=
"../../package/pip/script/" class=
"md-nav__link">
1327 <li class=
"md-nav__item">
1328 <a href=
"../../package/pip/smiley/" class=
"md-nav__link">
1339 <li class=
"md-nav__item">
1340 <a href=
"../../package/pip/sql/" class=
"md-nav__link">
1351 <li class=
"md-nav__item">
1352 <a href=
"../../package/pip/style/" class=
"md-nav__link">
1363 <li class=
"md-nav__item">
1364 <a href=
"../../package/pip/template/" class=
"md-nav__link">
1375 <li class=
"md-nav__item">
1376 <a href=
"../../package/pip/template-listener/" class=
"md-nav__link">
1387 <li class=
"md-nav__item">
1388 <a href=
"../../package/pip/user-group-option/" class=
"md-nav__link">
1399 <li class=
"md-nav__item">
1400 <a href=
"../../package/pip/user-menu/" class=
"md-nav__link">
1411 <li class=
"md-nav__item">
1412 <a href=
"../../package/pip/user-notification-event/" class=
"md-nav__link">
1413 userNotificationEvent
1423 <li class=
"md-nav__item">
1424 <a href=
"../../package/pip/user-option/" class=
"md-nav__link">
1435 <li class=
"md-nav__item">
1436 <a href=
"../../package/pip/user-profile-menu/" class=
"md-nav__link">
1453 <li class=
"md-nav__item">
1454 <a href=
"../../package/database-php-api/" class=
"md-nav__link">
1475 <li class=
"md-nav__item md-nav__item--nested">
1478 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1480 <label class=
"md-nav__link" for=
"__nav_6">
1482 <span class=
"md-nav__icon md-icon"></span>
1484 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1485 <label class=
"md-nav__title" for=
"__nav_6">
1486 <span class=
"md-nav__icon md-icon"></span>
1489 <ul class=
"md-nav__list" data-md-scrollfix
>
1496 <li class=
"md-nav__item md-nav__item--nested">
1499 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1501 <label class=
"md-nav__link" for=
"__nav_6_1">
1502 Migrating from WSC
5.3
1503 <span class=
"md-nav__icon md-icon"></span>
1505 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1506 <label class=
"md-nav__title" for=
"__nav_6_1">
1507 <span class=
"md-nav__icon md-icon"></span>
1508 Migrating from WSC
5.3
1510 <ul class=
"md-nav__list" data-md-scrollfix
>
1516 <li class=
"md-nav__item">
1517 <a href=
"../../migration/wsc53/php/" class=
"md-nav__link">
1528 <li class=
"md-nav__item">
1529 <a href=
"../../migration/wsc53/session/" class=
"md-nav__link">
1530 Session Handling and Authentication
1540 <li class=
"md-nav__item">
1541 <a href=
"../../migration/wsc53/javascript/" class=
"md-nav__link">
1542 TypeScript and JavaScript
1552 <li class=
"md-nav__item">
1553 <a href=
"../../migration/wsc53/templates/" class=
"md-nav__link">
1564 <li class=
"md-nav__item">
1565 <a href=
"../../migration/wsc53/libraries/" class=
"md-nav__link">
1566 Third Party Libraries
1583 <li class=
"md-nav__item md-nav__item--nested">
1586 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1588 <label class=
"md-nav__link" for=
"__nav_6_2">
1589 Migrating from WSC
5.2
1590 <span class=
"md-nav__icon md-icon"></span>
1592 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1593 <label class=
"md-nav__title" for=
"__nav_6_2">
1594 <span class=
"md-nav__icon md-icon"></span>
1595 Migrating from WSC
5.2
1597 <ul class=
"md-nav__list" data-md-scrollfix
>
1603 <li class=
"md-nav__item">
1604 <a href=
"../../migration/wsc52/php/" class=
"md-nav__link">
1615 <li class=
"md-nav__item">
1616 <a href=
"../../migration/wsc52/templates/" class=
"md-nav__link">
1617 Templates and Languages
1627 <li class=
"md-nav__item">
1628 <a href=
"../../migration/wsc52/libraries/" class=
"md-nav__link">
1629 Third Party Libraries
1646 <li class=
"md-nav__item md-nav__item--nested">
1649 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1651 <label class=
"md-nav__link" for=
"__nav_6_3">
1652 Migrating from WSC
3.1
1653 <span class=
"md-nav__icon md-icon"></span>
1655 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1656 <label class=
"md-nav__title" for=
"__nav_6_3">
1657 <span class=
"md-nav__icon md-icon"></span>
1658 Migrating from WSC
3.1
1660 <ul class=
"md-nav__list" data-md-scrollfix
>
1666 <li class=
"md-nav__item">
1667 <a href=
"../../migration/wsc31/php/" 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_4" type=
"checkbox" id=
"__nav_6_4" >
1690 <label class=
"md-nav__link" for=
"__nav_6_4">
1691 Migrating from WSC
3.0
1692 <span class=
"md-nav__icon md-icon"></span>
1694 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1695 <label class=
"md-nav__title" for=
"__nav_6_4">
1696 <span class=
"md-nav__icon md-icon"></span>
1697 Migrating from WSC
3.0
1699 <ul class=
"md-nav__list" data-md-scrollfix
>
1705 <li class=
"md-nav__item">
1706 <a href=
"../../migration/wsc30/php/" class=
"md-nav__link">
1717 <li class=
"md-nav__item">
1718 <a href=
"../../migration/wsc30/javascript/" class=
"md-nav__link">
1729 <li class=
"md-nav__item">
1730 <a href=
"../../migration/wsc30/templates/" class=
"md-nav__link">
1741 <li class=
"md-nav__item">
1742 <a href=
"../../migration/wsc30/css/" class=
"md-nav__link">
1753 <li class=
"md-nav__item">
1754 <a href=
"../../migration/wsc30/package/" class=
"md-nav__link">
1772 <li class=
"md-nav__item md-nav__item--nested">
1775 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1777 <label class=
"md-nav__link" for=
"__nav_6_5">
1778 Migrating from WCF
2.1
1779 <span class=
"md-nav__icon md-icon"></span>
1781 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1782 <label class=
"md-nav__title" for=
"__nav_6_5">
1783 <span class=
"md-nav__icon md-icon"></span>
1784 Migrating from WCF
2.1
1786 <ul class=
"md-nav__list" data-md-scrollfix
>
1792 <li class=
"md-nav__item">
1793 <a href=
"../../migration/wcf21/php/" class=
"md-nav__link">
1804 <li class=
"md-nav__item">
1805 <a href=
"../../migration/wcf21/templates/" class=
"md-nav__link">
1816 <li class=
"md-nav__item">
1817 <a href=
"../../migration/wcf21/css/" class=
"md-nav__link">
1828 <li class=
"md-nav__item">
1829 <a href=
"../../migration/wcf21/package/" class=
"md-nav__link">
1856 <li class=
"md-nav__item md-nav__item--nested">
1859 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1861 <label class=
"md-nav__link" for=
"__nav_7">
1863 <span class=
"md-nav__icon md-icon"></span>
1865 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1866 <label class=
"md-nav__title" for=
"__nav_7">
1867 <span class=
"md-nav__icon md-icon"></span>
1870 <ul class=
"md-nav__list" data-md-scrollfix
>
1877 <li class=
"md-nav__item md-nav__item--nested">
1880 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1882 <label class=
"md-nav__link" for=
"__nav_7_1">
1884 <span class=
"md-nav__icon md-icon"></span>
1886 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1887 <label class=
"md-nav__title" for=
"__nav_7_1">
1888 <span class=
"md-nav__icon md-icon"></span>
1891 <ul class=
"md-nav__list" data-md-scrollfix
>
1897 <li class=
"md-nav__item">
1898 <a href=
"../../tutorial/series/overview/" class=
"md-nav__link">
1909 <li class=
"md-nav__item">
1910 <a href=
"../../tutorial/series/part_1/" class=
"md-nav__link">
1921 <li class=
"md-nav__item">
1922 <a href=
"../../tutorial/series/part_2/" class=
"md-nav__link">
1933 <li class=
"md-nav__item">
1934 <a href=
"../../tutorial/series/part_3/" class=
"md-nav__link">
1961 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1962 <div class=
"md-sidebar__scrollwrap">
1963 <div class=
"md-sidebar__inner">
1965 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1971 <label class=
"md-nav__title" for=
"__toc">
1972 <span class=
"md-nav__icon md-icon"></span>
1975 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1977 <li class=
"md-nav__item">
1978 <a href=
"#scss-and-css" class=
"md-nav__link">
1982 <nav class=
"md-nav" aria-label=
"SCSS and CSS">
1983 <ul class=
"md-nav__list">
1985 <li class=
"md-nav__item">
1986 <a href=
"#file-location" class=
"md-nav__link">
1992 <li class=
"md-nav__item">
1993 <a href=
"#variables" class=
"md-nav__link">
1997 <nav class=
"md-nav" aria-label=
"Variables">
1998 <ul class=
"md-nav__list">
2000 <li class=
"md-nav__item">
2001 <a href=
"#linking-images" class=
"md-nav__link">
2017 <li class=
"md-nav__item">
2018 <a href=
"#media-breakpoints" class=
"md-nav__link">
2022 <nav class=
"md-nav" aria-label=
"Media Breakpoints">
2023 <ul class=
"md-nav__list">
2025 <li class=
"md-nav__item">
2026 <a href=
"#available-breakpoints" class=
"md-nav__link">
2027 Available Breakpoints
2037 <li class=
"md-nav__item">
2038 <a href=
"#asset-preloading" class=
"md-nav__link">
2052 <div class=
"md-content" data-md-component=
"content">
2053 <article class=
"md-content__inner md-typeset">
2056 <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">
2057 <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>
2061 <h1 id=
"css">CSS
<a class=
"headerlink" href=
"#css" title=
"Permanent link">#
</a></h1>
2062 <h2 id=
"scss-and-css">SCSS and CSS
<a class=
"headerlink" href=
"#scss-and-css" title=
"Permanent link">#
</a></h2>
2063 <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>
2064 <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>
2065 <h3 id=
"file-location">File Location
<a class=
"headerlink" href=
"#file-location" title=
"Permanent link">#
</a></h3>
2066 <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>
2067 <h3 id=
"variables">Variables
<a class=
"headerlink" href=
"#variables" title=
"Permanent link">#
</a></h3>
2068 <p>You can access variables with
<code>$myVariable
</code>, variable interpolation (variables inside strings) is accomplished with
<code>#{$myVariable}
</code>.
</p>
2069 <h4 id=
"linking-images">Linking images
<a class=
"headerlink" href=
"#linking-images" title=
"Permanent link">#
</a></h4>
2070 <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>
2071 <h2 id=
"media-breakpoints">Media Breakpoints
<a class=
"headerlink" href=
"#media-breakpoints" title=
"Permanent link">#
</a></h2>
2072 <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>
2073 <div class=
"highlight"><pre><span></span><code><span class=
"cm">/* red background color for desktop pc */
</span>
2074 <span class=
"k">@include
</span><span class=
"nd"> screen-lg
</span> <span class=
"p">{
</span>
2075 <span class=
"nt">body
</span> <span class=
"p">{
</span>
2076 <span class=
"nt">background-color
</span><span class=
"nd">:
</span> <span class=
"nt">red
</span><span class=
"o">;
</span>
2077 <span class=
"p">}
</span>
2078 <span class=
"p">}
</span>
2080 <span class=
"cm">/* green background color on smartphones and tablets */
</span>
2081 <span class=
"k">@include
</span><span class=
"nd"> screen-md-down
</span> <span class=
"p">{
</span>
2082 <span class=
"nt">body
</span> <span class=
"p">{
</span>
2083 <span class=
"nt">background-color
</span><span class=
"nd">:
</span> <span class=
"nt">green
</span><span class=
"o">;
</span>
2084 <span class=
"p">}
</span>
2085 <span class=
"p">}
</span>
2087 <h3 id=
"available-breakpoints">Available Breakpoints
<a class=
"headerlink" href=
"#available-breakpoints" title=
"Permanent link">#
</a></h3>
2088 <div class=
"admonition info">
2089 <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>
2096 <th><code>@media
</code> equivalent
</th>
2101 <td><code>screen-xs
</code></td>
2102 <td>Smartphones only
</td>
2103 <td><code>(max-width:
544px)
</code></td>
2106 <td><code>screen-sm
</code></td>
2107 <td>Tablets (portrait)
</td>
2108 <td><code>(min-width:
545px) and (max-width:
768px)
</code></td>
2111 <td><code>screen-sm-down
</code></td>
2112 <td>Tablets (portrait) and smartphones
</td>
2113 <td><code>(max-width:
768px)
</code></td>
2116 <td><code>screen-sm-up
</code></td>
2117 <td>Tablets and desktop PC
</td>
2118 <td><code>(min-width:
545px)
</code></td>
2121 <td><code>screen-sm-md
</code></td>
2122 <td>Tablets only
</td>
2123 <td><code>(min-width:
545px) and (max-width:
1024px)
</code></td>
2126 <td><code>screen-md
</code></td>
2127 <td>Tablets (landscape)
</td>
2128 <td><code>(min-width:
769px) and (max-width:
1024px)
</code></td>
2131 <td><code>screen-md-down
</code></td>
2132 <td>Smartphones and Tablets
</td>
2133 <td><code>(max-width:
1024px)
</code></td>
2136 <td><code>screen-md-up
</code></td>
2137 <td>Tablets (landscape) and desktop PC
</td>
2138 <td><code>(min-width:
769px)
</code></td>
2141 <td><code>screen-lg
</code></td>
2143 <td><code>(min-width:
1025px)
</code></td>
2147 <h2 id=
"asset-preloading">Asset Preloading
<a class=
"headerlink" href=
"#asset-preloading" title=
"Permanent link">#
</a></h2>
2148 <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.
2149 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>
2150 <div class=
"highlight"><pre><span></span><code><span class=
"nc">.fooBar
</span> <span class=
"p">{
</span>
2151 <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>
2152 <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>
2153 <span class=
"err">$
</span><span class=
"nt">as
</span><span class=
"nd">:
</span> <span class=
"s2">"image
"</span><span class=
"o">,
</span>
2154 <span class=
"err">$
</span><span class=
"nt">crossorigin
</span><span class=
"nd">:
</span> <span class=
"nt">false
</span><span class=
"o">,
</span>
2155 <span class=
"err">$
</span><span class=
"nt">type
</span><span class=
"nd">:
</span> <span class=
"s2">"image/png
"</span>
2156 <span class=
"o">)
</span><span class=
"p">}
</span><span class=
"o">;
</span>
2158 <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>
2159 <span class=
"p">}
</span>
2161 <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>
2162 <p>The above example will result in a
<code><link
></code> similar to the following being added to the generated HTML:
</p>
2163 <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
">
2165 <div class=
"admonition info">
2166 <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>
2173 <div class=
"md-source-date">
2176 Last update:
2021-
03-
08
2195 <footer class=
"md-footer">
2197 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2199 <a href=
"../template-plugins/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2200 <div class=
"md-footer__button md-icon">
2201 <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>
2203 <div class=
"md-footer__title">
2204 <div class=
"md-ellipsis">
2205 <span class=
"md-footer__direction">
2214 <a href=
"../../javascript/general-usage/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2215 <div class=
"md-footer__title">
2216 <div class=
"md-ellipsis">
2217 <span class=
"md-footer__direction">
2223 <div class=
"md-footer__button md-icon">
2224 <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>
2230 <div class=
"md-footer-meta md-typeset">
2231 <div class=
"md-footer-meta__inner md-grid">
2232 <div class=
"md-footer-copyright">
2234 <div class=
"md-footer-copyright__highlight">
2235 Copyright ©
2020 WoltLab GmbH
2239 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2244 <div class=
"md-footer-copyright">
2245 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2246 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2253 <div class=
"md-dialog" data-md-component=
"dialog">
2254 <div class=
"md-dialog__inner md-typeset"></div>
2256 <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>
2259 <script src=
"../../assets/javascripts/bundle.d892486b.min.js"></script>