Wiki source code of Special CSS Classes
Version 4.3 by Sergiu Dumitriu on 2012/07/09
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | = Special CSS Classes = | ||
| 2 | |||
| 3 | XWiki has some special classes that are used in certain conditions to assure consistency and enhance functionality. The following classes are defined at least starting with [[the Colibri Skin>>extensions:Extension.Colibri Skin]]: | ||
| 4 | |||
| 5 | {{toc/}} | ||
| 6 | |||
| 7 | == A. General classes == | ||
| 8 | |||
| 9 | * **##.hidden##** | ||
| 10 | use to 'display: none' elements | ||
| 11 | |||
| 12 | * **##.invisible##** | ||
| 13 | use to 'visibility: hidden' elements | ||
| 14 | |||
| 15 | * **##.clearfloats##** | ||
| 16 | use to clear floats when using floated containers, in order to keep the parent's layout correct | ||
| 17 | |||
| 18 | * **##.separator##** | ||
| 19 | use to contain separators ( {{html}}·{{/html}} , | ) | ||
| 20 | used in #document-info and blog .entry-footer | ||
| 21 | |||
| 22 | * **##.itemCount##** | ||
| 23 | use to contain numeric values that describe quantitative information about an item | ||
| 24 | used in #docExtraTabs, #document-info, .blog-category-level | ||
| 25 | example: Comments (1) | ||
| 26 | |||
| 27 | * **##.noitems##** | ||
| 28 | use to contain empty state messages | ||
| 29 | used in #docextrapanes | ||
| 30 | example: 'No comments for this document', 'No attachments for this document' | ||
| 31 | |||
| 32 | * **##.icon##** | ||
| 33 | use for icon buttons | ||
| 34 | used in .icon.rss in 'Quick Links' panel | ||
| 35 | |||
| 36 | * **##.hasIcon##** | ||
| 37 | use for elements that also have a background-icon attached | ||
| 38 | works in pair with other classes that specify the icon that will be used (ex: .iconRSS, .tmEdit, .etc) | ||
| 39 | used in menus | ||
| 40 | |||
| 41 | * **##.loading##** | ||
| 42 | sets an animated GIF as being the background image (center aligned) of the element | ||
| 43 | generally used on Ajax requests in order to express the loading status | ||
| 44 | example of usage: on loading each of the Annotations, Comments, Attachments, History and Informations tabs | ||
| 45 | |||
| 46 | * **##.column##** + (**##.full##** | **##.half##** | **##.third##**) | ||
| 47 | classes for generic (1|2|3) column layout | ||
| 48 | |||
| 49 | == B. Classes used for Form elements == | ||
| 50 | |||
| 51 | === B1. Buttons containers === | ||
| 52 | |||
| 53 | * **##.buttonwrapper##** | ||
| 54 | use as an external container for buttons (required for Toucan skin) | ||
| 55 | |||
| 56 | * **##.buttonwrapper .button##** | ||
| 57 | use ##.button## on ##input## or ##a## elements to display as buttons | ||
| 58 | |||
| 59 | * **##.secondary.button##** | ||
| 60 | use for secondary actions, like ##cancel## | ||
| 61 | |||
| 62 | * **##.icon-button##** | ||
| 63 | ** **##.icon-button.add-button##** | ||
| 64 | ** **##.icon-button.remove-button##** | ||
| 65 | use for small icon actions, like ##add## and ##remove## | ||
| 66 | |||
| 67 | * **##.button.disabled##** | ||
| 68 | use to display a button in it's disabled state | ||
| 69 | |||
| 70 | === B2. Behavior classnames === | ||
| 71 | |||
| 72 | * **##.withTip##** | ||
| 73 | introduced in [[XWIKI-4163>>http://jira.xwiki.org/jira/browse/XWIKI-4163]] | ||
| 74 | description: automatically hides and reinserts the default text for input fields, acting as a tip. | ||
| 75 | |||
| 76 | * **##.suggestDocuments##** | ||
| 77 | introduced in [[XWIKI-5301>>http://jira.xwiki.org/jira/browse/XWIKI-5301]] | ||
| 78 | description: all input fields with classname suggestDocuments will receive an autocomplete control suggesting document names. | ||
| 79 | |||
| 80 | * **##.suggestSpaces##** | ||
| 81 | introduced in [[XWIKI-5657>>http://jira.xwiki.org/jira/browse/XWIKI-5301]] (XWiki 2.6 RC2) | ||
| 82 | description: all input fields with classname suggestSpaces will receive an autocomplete control suggesting space names. | ||
| 83 | |||
| 84 | * **##.suggestUsers##** | ||
| 85 | introduced in [[XWIKI-5649>>http://jira.xwiki.org/jira/browse/XWIKI-5649]] (XWiki 2.6 RC2) | ||
| 86 | description: all input fields with classname suggestUsers will receive an autocomplete control suggesting document names of documents that contains user objects | ||
| 87 | |||
| 88 | * **##.suggestGroups##** | ||
| 89 | introduced in [[XWIKI-5649>>http://jira.xwiki.org/jira/browse/XWIKI-5649]] (XWiki 2.6 RC2) | ||
| 90 | description: all input fields with classname suggestGroups will receive an autocomplete control suggesting document names of documents that contains group objects | ||
| 91 | |||
| 92 | * **##.suggested##** | ||
| 93 | description: blocks normal browser autocomplete and initializes the suggest object early instead of waiting for the field to be focused (if the suggests is declared on focus). | ||
| 94 | |||
| 95 | * **##.maximizable##** | ||
| 96 | introduced in [[XWIKI-5660>>http://jira.xwiki.org/jira/browse/XWIKI-5660]] (XWiki 2.6 RC2) | ||
| 97 | description: offers a link for users to maximize the element on which this classname is applied, making it possible to view that element in fullscreen mode. {{warning}}needs to be used together with a skinx call to the ##uicomponents/widgets/fullScreen.js## script{{/warning}} | ||
| 98 | |||
| 99 | == Further References == | ||
| 100 | |||
| 101 | * XWiki's structure is defined in templates that generate specific layout classes (.main, #mainContentArea, etc) | ||
| 102 | ** [[XWiki CSS Layout>>AdminGuide.CSSLayout]] //(outdated)// | ||
| 103 | * XWiki provides by default a [[list of Skins>>Features.Skins]], each with it's own characteristics | ||
| 104 | ** [[XWiki Albatross CSS Files>>AdminGuide.CSS files]] //(deprecated)// | ||
| 105 | |||
| 106 | * When writing CSS code for XWiki there are some [[code style rules>>http://dev.xwiki.org/xwiki/bin/view/Community/XhtmlCssCodeStyle]] that need to be followed in order to assure consistency and quality. |
