Part of the CSS Cleanup: http://drupal.org/node/1089868
Overview of Goals
- Make it easy to remove unwanted design assumptions in the theme layer, while maintaining critical functionality (such as functional JavaScript widgets).
- Prevent uneeded administrative styles from loading on the front end.
- Give modules the ability to include a generic design implementation with their module, without burdening themers.
- Make CSS and related markup more efficient and less intrusive to improve the themer experience.
The CSS Clean-up Process
Use the following guidelines when writing patches for the core issues listed below.
- Put CSS is in the appropriate file: CSS should be moved to separate files, using the following guidelines extracted from CSS file organization (for Drupal 8):
CSS files for Drupal modules
All of a module's styles should be placed in a
css/
sub-directory and broken into one or more of the following files:module_name.module.css
: This file should hold the minimal styles needed to get the module's functionality working. This includes layout, component and state styles. Any needed RTL styling would go in a file namedmodule_name.module-rtl.css
.module_name.skin.css
: This file should hold extra styles to make the module's functionality aesthetically pleasing. This usually just consists of skin styles. Any needed RTL styling would go in a file namedmodule_name.skin-rtl.css
.module_name.admin.css
: This file should hold the minimal styles needed to get the module's admin screens working. This includes layout, component and state styles. On admin screens, the module may choose to load the *.module.css in addition to the *.admin.css file. Any needed RTL styling would go in a file namedmodule_name.admin-rtl.css
.module_name.admin.skin.css
: This file should hold extra styles to make the module's admin screens aesthetically pleasing. This usually just consists of skin styles. Any needed RTL styling would go in a file namedmodule_name.admin.skin-rtl.css
.Note: Modules should never have any base styles. Drupal core's modules do not have any base styles. Instead Drupal core uses the Normalize.css library augmented with a drupal.base.css library.
If a module attaches a CSS file to a template file, the CSS file should be named the same as the template file, e.g. the system-plugin-ui-form.html.twig CSS file should be named system-plugin-ui-form.css
- Remove Assumptions: Styles that make too many assumptions, introduce superflous margins, padding and add things like font settings are not necessary and don't belong in core module CSS files. In cases where core themes depend on these properties, they should be moved to the CSS stylesheet of the respective theme.
- Reduce Selector Specificity: CSS code that resides in modules should be written in a way that's easily overridable in the theme layer. To improve the Themer Experience and make core CSS more efficient, CSS selectors should be made as general and short as possible. For example:
- Use
.style {}
overdiv.style {}
where possible. - Use
.module .style {}
overdiv.module div.somenestedelement .style
where possible.
- Use
- Don't use IDs in selectors: Use of ID's in core CSS selectors requires more specificity in the theme layer, making it harder and more annoying to deal with. It makes achieveing consistency in complex design implementations much harder than it needs to be. We need to stop making life hard for theme developers.
- Don't be afraid to change markup: There's lots of overlap between using proper and semantic markup and doing CSS right. If you come across a case where CSS is being applied where using a more semantic elements would solve the problem, then change the markup in your patch to make it right. For more information, see the Drupal 8 Markup Gate rules.
- Start with Stark and cross-browser test.
- "Design" markup and CSS for the Stark theme.
- If applicable, adapt the styles to match the core themes afterward.
- Finally, test the changes in all supported browsers and ensure no regressions are introduced.
Comment | File | Size | Author |
---|---|---|---|
#15 | overlay-change-ids-to-classes-1217030-15.patch | 23.79 KB | helenasue |
#9 | 1217030-9-overlay.patch | 19.4 KB | cosmicdreams |
Comments
Comment #1
_Cedric_ CreditAttribution: _Cedric_ commentedComment #2
chrispomeroy CreditAttribution: chrispomeroy commentedi was researching this issue and noticed that in overlay-child-rtl.css, this is in the css:
I think that is the letter O?
Is that some weird css hack or is it a mistake?
Comment #3
David_Rothstein CreditAttribution: David_Rothstein commentedHa! Nice catch. Yeah, definitely looks like a bug.
Probably better to file it as a separate issue, though, because that's a simple fix (whereas this issue is about more far-ranging changes to the CSS).
Comment #4
chrispomeroy CreditAttribution: chrispomeroy commentedok cool, i filed it under #1326950: typo in overlay-child-rtl.css
Comment #5
cosmicdreams CreditAttribution: cosmicdreams commentedI'll take a shot at this. Patch forthcoming
Comment #6
cosmicdreams CreditAttribution: cosmicdreams commentedGot started, There are a lot of IDs here:
I started going through the process of reducing the number of ids. Here's what I'm considering after the refactor:
In my view, there should be only one id, "overlay" for the element that begins and encapsulates the other things that makeup the overlay.
Then I need to adjust the styles accordingly. Sound like a good plan?
Also, should we be concerned about css namespacing issues? Like I totally see another module make an overlay and what to use the css id "overlay" for it. Should we name css ids in core like this: drupal-overlay?
Comment #7
cosmicdreams CreditAttribution: cosmicdreams commentedMy focus has been elsewhere in regard to HTML5 patches. But I'm bumping this so I can work on this issue tonight. I hope to produce a patch based on the plan I out lined above.
Comment #8
cosmicdreams CreditAttribution: cosmicdreams commentedMy focus has been elsewhere in regard to HTML5 patches. But I'm bumping this so I can work on this issue tonight. I hope to produce a patch based on the plan I out lined above.
Comment #9
cosmicdreams CreditAttribution: cosmicdreams commentedOK, so.... here's a patch that may probably will get conversation started. Here's a rundown of what I did:
Comment #10
cosmicdreams CreditAttribution: cosmicdreams commentedComment #11
aspilicious CreditAttribution: aspilicious commentedYou're not rly removing any div's. So the markup is not rly changed.
And we need a way to test "function overlay_disable_message()".
I'll functional test this some more today or tomorow.
23 days to next Drupal core point release.
Comment #12
aspilicious CreditAttribution: aspilicious commentedWhoops, needs review
Comment #13
oresh CreditAttribution: oresh commented#9: 1217030-9-overlay.patch queued for re-testing.
@aspilicious ,
if you can, please write a test for function overlay_disable_message() in fat module
Comment #14.0
(not verified) CreditAttribution: commentedUpdated issue summary.
Comment #15
helenasue CreditAttribution: helenasue commentedDidn't change the css filenames to the new convention - just went through and swapped out the ids for classes.
This patch was created as a part of the code sprint at #dcATL.
Comment #17
alexdmccabe#15: overlay-change-ids-to-classes-1217030-15.patch queued for re-testing.
Comment #17.0
alexdmccabeUpdated summary to the latest CSS organization guidelines.
Comment #18
nod_Overlay is dead to D8 #2088121: Remove Overlay.
Comment #19
longwaveWe cannot change this in 7.x now.