|
|
| (102 intermediate revisions by 11 users not shown) |
| Line 1: |
Line 1: |
| In this article, you can learn how to create customized themes and use them to change the look of you appsuite installation.
| | The content on this page has moved to https://documentation.open-xchange.com/latest/ui/theming.html |
|
| |
|
| == LESS.JS ==
| | Note: Open-Xchange is in the process of migrating all its technical documentation to a new and improved documentation system (documentation.open-xchange.com). Please note as the migration takes place more information will be available on the new system and less on this system. Thank you for your understanding during this period of transition. |
| | |
| Please read [http://lesscss.org/ LESS.JS] first
| |
| | |
| == File structure ==
| |
| | |
| A theme basically consists of two files located in <code>$APPSUITE_ROOT/apps/themes/$YOUR_UNIQUE_THEME_NAME</code>. These files are described in this and the following sections.
| |
| | |
| === definitions.less ===
| |
| | |
| This file can be used to override variables described in the "Variables" section of this article.
| |
| | |
| === style.less ===
| |
| | |
| This file can be used to define any CSS you like. Before doing this, check, if there really is no variable that can be used to achieve the same thing.
| |
| | |
| == Variables ==
| |
| | |
| === Basic ===
| |
| | |
| ==== Font ====
| |
| | |
| {|
| |
| ! Variable || Default || Description
| |
| |-
| |
| | @sansFontFamily || "Helvetica Neue", Helvetica, Arial, sans-serif
| |
| |-
| |
| | @serifFontFamily || Georgia, "Times New Roman", Times, serif
| |
| |-
| |
| | @monoFontFamily || Monaco, Menlo, Consolas, "Courier New", monospace
| |
| |-
| |
| | @baseFontSize || 14px
| |
| |-
| |
| | @baseFontFamily || @sansFontFamily
| |
| |-
| |
| | @baseLineHeight || 20px
| |
| |-
| |
| | @altFontFamily || @serifFontFamily
| |
| |-
| |
| | @touchFontSize || 15px
| |
| |-
| |
| | @headingsFontFamily || inherit
| |
| |-
| |
| | @headingsFontWeight || bold
| |
| |-
| |
| | @fontSizeLarge || @baseFontSize * 1.25
| |
| |-
| |
| | @fontSizeSmall || @baseFontSize * 0.85
| |
| |-
| |
| | @fontSizeMini || @baseFontSize * 0.75
| |
| |-
| |
| | @vgridFontSize || 13px
| |
| |}
| |
| | |
| ==== Colors ====
| |
| | |
| {|
| |
| ! Variable || Default || Description
| |
| |-
| |
| | @bodyBackground || @white
| |
| |-
| |
| | @textColor || @grayDark
| |
| |-
| |
| | @linkColor || #08c
| |
| |-
| |
| | @linkColorHover || darken(@linkColor, 15%)
| |
| |-
| |
| | @linkAccentColor || #ffad00
| |
| |-
| |
| | @linkAccentColorHover || darken(@linkAccentColor, 15%)
| |
| |-
| |
| | @headingsColor || inherit
| |
| |-
| |
| | @black || #000
| |
| |-
| |
| | @grayDarker || #222
| |
| |-
| |
| | @grayDark || #333
| |
| |-
| |
| | @gray || #555
| |
| |-
| |
| | @grayLight || #aaa
| |
| |-
| |
| | @grayLighter || #eee
| |
| |-
| |
| | @white || #fff
| |
| |-
| |
| | @blue || darken(#049cdb, 5%)
| |
| |-
| |
| | @blueDark || #0064cd
| |
| |-
| |
| | @blueLight || lighten(#049cdb, 25%)
| |
| |-
| |
| | @green || #1A8D1A
| |
| |-
| |
| | @greenLight || #92D050
| |
| |-
| |
| | @red || #cc0000
| |
| |-
| |
| | @yellow || #F8E400
| |
| |-
| |
| | @orange || #f89406
| |
| |-
| |
| | @pink || #E01CD9
| |
| |-
| |
| | @purple || #7E16CF
| |
| |-
| |
| |}
| |
| | |
| ==== Space ====
| |
| | |
| {|
| |
| ! Variable || Default || Description
| |
| |-
| |
| | @paddingLarge || 11px 19px
| |
| |-
| |
| | @paddingSmall || 2px 10px
| |
| |-
| |
| | @paddingMini || 0 6px
| |
| |-
| |
| | @baseBorderRadius || 4px
| |
| |-
| |
| | @borderRadiusLarge || 6px
| |
| |-
| |
| | @borderRadiusSmall || 3px
| |
| |}
| |
| | |
| === Pagination ===
| |
| | |
| {|
| |
| ! Variable || Default || Description
| |
| |-
| |
| | @paginationBackground || #fff
| |
| |-
| |
| | @paginationBorder || #ddd
| |
| |-
| |
| | @paginationActiveBackground || #f5f5f5
| |
| |}
| |
| | |
| === Buttons ===
| |
| | |
| {|
| |
| ! Variable || Default || Description
| |
| |-
| |
| | @btnBackground || @white
| |
| |-
| |
| | @btnBackgroundHighlight || darken(@white, 10%)
| |
| |-
| |
| | @btnBorder || #bbb
| |
| |-
| |
| | @btnPrimaryBackground || @linkColor
| |
| |-
| |
| | @btnPrimaryBackgroundHighlight || spin(@btnPrimaryBackground, 20%)
| |
| |-
| |
| | @btnInfoBackground || #5bc0de
| |
| |-
| |
| | @btnInfoBackgroundHighlight || #2f96b4
| |
| |-
| |
| | @btnSuccessBackground || #62c462
| |
| |-
| |
| | @btnSuccessBackgroundHighlight || #51a351
| |
| |-
| |
| | @btnWarningBackground || lighten(@orange, 15%)
| |
| |-
| |
| | @btnWarningBackgroundHighlight || @orange
| |
| |-
| |
| | @btnDangerBackground || #ee5f5b
| |
| |-
| |
| | @btnDangerBackgroundHighlight || #bd362f
| |
| |-
| |
| | @btnInverseBackground || #444
| |
| |-
| |
| | @btnInverseBackgroundHighlight || @grayDarker
| |
| |}
| |
| | |
| === Dropdowns ===
| |
| | |
| {|
| |
| ! Variable || Default || Description
| |
| |-
| |
| | @dropdownBackground || @white
| |
| |-
| |
| | @dropdownBorder || rgba(0,0,0,.2)
| |
| |-
| |
| | @dropdownDividerTop || #e5e5e5
| |
| |-
| |
| | @dropdownDividerBottom || @white
| |
| |-
| |
| | @dropdownLinkColor || @grayDark
| |
| |-
| |
| | @dropdownLinkColorHover || @white
| |
| |-
| |
| | @dropdownLinkColorActive || @white
| |
| |-
| |
| | @dropdownLinkBackgroundActive || @linkColor
| |
| |-
| |
| | @dropdownLinkBackgroundHover || @dropdownLinkBackgroundActive
| |
| |}
| |
| | |
| === Foldertree ===
| |
| {|
| |
| ! Variable || Default || Description
| |
| |-
| |
| | @foldertreeSidepanelBackground || ||
| |
| |-
| |
| | @foldertreeSectionTitleColor || ||
| |
| |-
| |
| | @foldertreeActiveLabelColor || ||
| |
| |-
| |
| | @foldertreePassiveLabelColor || ||
| |
| |-
| |
| | @foldertreeHoverBackground || ||
| |
| |-
| |
| | @foldertreeSelectedBackground || ||
| |
| |-
| |
| | @foldertreeCounterBadgeBackground || ||
| |
| |-
| |
| | @foldertreeCounterBadgeColor || ||
| |
| |}
| |
| | |
| === Calendar ===
| |
| ==== Appointment ====
| |
| {|
| |
| ! Variable || Default || Description
| |
| |-
| |
| | @appointmentReserved || #08c; /* blue */ ||
| |
| |-
| |
| | @appointmentTemporary || #ffbb00; /* yellow */ ||
| |
| |-
| |
| | @appointmentAbsent || #913f3f; /* red */ ||
| |
| |-
| |
| | @appointmentFree || #8eb360; /* green */ ||
| |
| |-
| |
| | @appointmentPrivate || #555 /* gray */ ||
| |
| |-
| |
| | @appointmentDeclinedFont || #888 /* dark gray */||
| |
| |-
| |
| | @appointmentUnconfirmedAlpha || 0.4 ||
| |
| |-
| |
| | @appointmentDeclinedAlpha || 0.3 ||
| |
| |-
| |
| | @appointmentHoverPct || 15% ||
| |
| |-
| |
| | @appointmentDeclinedAlpha || 0.3
| |
| |}
| |
| | |
| ==== Week View ====
| |
| {|
| |
| ! Variable || Default || Description
| |
| |-
| |
| | @weekviewAppointmentLasso || #aeaeff ||
| |
| |-
| |
| | @weekviewDayIn || #fff /* white */ ||
| |
| |-
| |
| | @weekviewDayOut || #e0e0e0 /* grey */ ||
| |
| |-
| |
| | @weekviewTimeline || #f00 /* red */ ||
| |
| |-
| |
| | @weekviewTimeWith || 58px ||
| |
| |-
| |
| | @calendarToolbarHeight || 41px ||
| |
| |}
| |
| | |
| ==== Month View ====
| |
| {|
| |
| ! Variable || Default || Description
| |
| |-
| |
| | @monthviewAppointmentOut || #aaa /* light gray */ ||
| |
| |-
| |
| | @monthviewToday || #daefff /* light blue */||
| |
| |-
| |
| | @calendarToolbarHeight || 41px ||
| |
| |}
| |
| | |
| == Mixins ==
| |
| In LESS, it is possible to include a bunch of properties from one ruleset into another ruleset. So say we have the following class
| |
| | |
| === Sample ===
| |
| <pre class="language-css">
| |
| .bordered {
| |
| border-top: dotted 1px black;
| |
| border-bottom: solid 2px black;
| |
| }
| |
| | |
| #menu a {
| |
| color: #111;
| |
| .bordered;
| |
| }
| |
| | |
| .post a {
| |
| color: red;
| |
| .bordered;
| |
| }
| |
| </pre>
| |
| | |
| === OX Mixins ===
| |
| | |
| | |
| | |
| .box-sizing(@boxmodel: content-box)
| |
| .user-select(@select: none) | |
| .border-radius(@radius: 0px) | |
| .box-shadow(@shadow: none) | |
| .vertical-gradient(@startColor: #888888, @endColor: #333333)
| |
| .radial-gradient(@color1: #000000, @color2: #555555, @color3: #ffffff)
| |
| .transition(@transition: all 1s linear)
| |
| .animation(@animation)
| |
| .animation-name(@name)
| |
| .ellipsis
| |
| .overflow(@type: auto)
| |
| .overflow-x(@type: auto)
| |
| .overflow-y(@type: auto)
| |
| .backface-visibility(@type: hidden)
| |
| | |
| == How to activate a theme during development ==
| |
| | |
| When creating a new theme, you don’t have it installed with your frontend. In this case you don’t want to go to a complete build of a theme and reinstall it for every change. The trick is to create your theme and overwrite the default theme with it. You can then use the [[AppSuite:appserver|appserver]] proxy to ship your own version of the UI.
| |
| | |
| To activate a theme on the backend, you have to add it to the <code>io.ox/core/settingsOptions//themes</code> list.
| |
| | |
| ==== Example ====
| |
| | |
| Adding <pre>io.ox/core/settingsOptions//themes/unicorn=Friendship is Magic</pre> to <code>etc/settings/appsuite.properties</code> add a theme named <code>unicorn</code> with the name <code>Friendship is Magic</code> to the list of themes, a user can choose. Find the list in the <code>Settings -> Basic</code> view behind the option <code>Theme</code>.
| |
| | |
| == Theming the login page ==
| |
| | |
| The login page is a little bit special. If you don’t use the [[form login]] (and provide your own login page), you might want to also theme the login page. Learn here, how to do this.
| |
| | |
| == Best practice ==
| |
| | |
| To be really safe, it’s best to only define your own values for the variables shown above. If this really breaks anything, we consider this a bug, please report it [https://bugs.open-xchange.com/] in our bugzilla.
| |
| | |
| Of course, using CSS in <code>style.less</code> file to define your own styles is also possible. Make sure to test your style in such cases more carefully. It is most likely safe to change minor things using this file, but if you plan to change any positions of larger elements, this might break the complete design. So please be careful when overwriting the default CSS rules.
| |
| | |
| == Caveats ==
| |
| | |
| [[Category:AppSuite]]
| |
| [[Category:UI]]
| |