Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dotnetCarpenter/white-space

white-space: none polyfill
https://github.com/dotnetCarpenter/white-space

Last synced: about 2 months ago
JSON representation

white-space: none polyfill

Awesome Lists containing this project

README 

        
``white-space: none;`` polyfill

===============================



## Polyfill for the proposed white-space:none; CSS property



`white-space: none;` is a highly requested feature of the CSS Text Module but is, as time of writing, only recognized as [an issue in CSS Text Module Level 3 (Issue 3)](http://www.w3.org/TR/2012/WD-css3-text-20121113/#pre-line). *UPDATE* Issue 3 has since then been removed from the specs.



Original written as a proof-of-concept, I've found `white-space: none;` really useful and it's now ready for development usage. You're probably better off using HTML comments, HTML minification or similar in production but for development, it's pretty *tight*.



You can find a list of sites and people discussing issues with not having `white-space: none;` on the [wiki](https://github.com/dotnetCarpenter/white-space/wiki).



### UPDATE 2013-10-05 ###

Since version 1.1.0 a `white-space-fast.js` is supplied. It comes with another caveat (see [Issues below](./#issues)), but should be fast enough to be used in production. Which means you don't don't have to fix your white space issues.

`white-space-fast.min.js` should be placed inside your body tag to prevent it from running too soon on IE, on initial load with empty cache.

I encourage you to experiement with the exact placement of `white-space-fast.min.js`, as slowly loading js files (jQuery ect.) will impact the perceived performance of this ``white-space: none;`` implementation. Feedback is welcome in the [issue tracker](https://github.com/dotnetCarpenter/white-space/issues). 



*`white-space-fast.js` doesn't support IE8.*



## Usage

**CSS**

```css

  .foo {

    display: inline-block;

    white-space: none; /* this is the API which removes white space based on your CSS selector */

  }

```



**bower**

```shell

bower install css-white-space-none

```



```html



```

OR

```html



```



### Listen for WhiteSpaceDone not IE8

When the `white-space: none;` rule has been enforced, the parent element dispatch a `WhiteSpaceDone` event. You can listen on the document and use the target property to determine which elements children has `white-space: none;` applied.



```javascript

// always attach event listeners before they can be triggered to avoid race conditions,

// e.g. this snippet should be before you include white-space-fast.js

document.addEventListener("WhiteSpaceDone", function(e) {

  console.dir(e.target);

}, true); // set useCapture to true if you're not listening on the element dispatching WhiteSpaceDone

```



## Size

+ `white-space.min.js` 2050 bytes (minified)

+ `white-space.min.js.gz` 1044 bytes (gzipped)

+ `white-space-fast.min.js` 1991 bytes (minified)

+ `white-space-fast.min.js.gz` 1043 bytes (gzipped)



## Issues

`white-space: none;` comes with a few known limitations, you need to cater for.



1. Don't use `white-space: none;` inside @media queries - unless you want to apply `white-space: none;` to the selector regardless of your media query.

2. Only use `white-space: none;` in external style sheets - the script won't look anywhere else.

3. If your external style sheet is on a different domain, make sure you use [CORS](http://www.w3.org/TR/cors/).



Let me know, in the [issue tracker](https://github.com/dotnetCarpenter/white-space/issues), if you stumble upon anything weird.



## Implementation

The implementation works by removing empty nodes in the DOM, that are siblings to a node with ``white-space: none;``. The child nodes doesn't inherit ``white-space: none;``.

Furthermore, this polyfill only parse external CSS. So it won't even look at CSS in the header or inline.

`white-space-fast.js` calls the removal of empty DOM nodes on `document.readyState == 'interactive'` as oppose to `white-space.js`, which remove empty DOM nodes on `document.readyState == 'complete'`.

Version 1.1.1 also test for `document.readyState == 'loaded'`.



## Tests



I decided to include a realistic use-case, which really isn't a test-case but included as such, because

it's useful to test `white-space: none;` in a realistic environment.

So far there is one use case, three test cases and one test case that include all three:



+ [unordered-list.html](http://dotnetcarpenter.github.io/white-space/test-cases/unordered-list.html)*

+ [images-as-list.html](http://dotnetcarpenter.github.io/white-space/test-cases/images-as-list.html)*

+ [trebuchet-overflow.html](http://dotnetcarpenter.github.io/white-space/test-cases/trebuchet-overflow.html)

+ [all.html](http://dotnetcarpenter.github.io/white-space/test-cases/all.html)

+ [real.html](http://dotnetcarpenter.github.io/white-space/test-cases/real.html)



**white-space-fast.js**

+ [unordered-list.html](http://dotnetcarpenter.github.io/white-space/test-cases/white-space-fast/unordered-list.html)*

+ [images-as-list.html](http://dotnetcarpenter.github.io/white-space/test-cases/white-space-fast/images-as-list.html)*

+ [trebuchet-overflow.html](http://dotnetcarpenter.github.io/white-space/test-cases/white-space-fast/trebuchet-overflow.html)

+ [all.html](http://dotnetcarpenter.github.io/white-space/test-cases/white-space-fast/all.html)

+ [real.html](http://dotnetcarpenter.github.io/white-space/test-cases/white-space-fast/real.html)



\* Click the "Run white-space:none; script" button at the top



## Tested in

+ FF25, FF24, Chr30, IE10, IE9, IE8 on Win7 (`white-space-fast.js` doesn't support IE8)

+ IE10, IE9, IE8 on Win8 (`white-space-fast.js` doesn't support for IE8)

+ FF24, FF21, Saf7, Saf6, Chr30, Chr27, Op17, Op12 on OSX10.7 (Lion)

+ Internet (android stock browser) 4.0.4, Dolfin 10.1, FF24, Chr30, Op12.1.4 on Android 4.0.4

+ Internet (android stock browser) 2.3 on Android 2.3.7

+ Saf6 on iOS 6.1.3



**NOTE:** IE7 support requires that `querySelectorAll` is replaced with something similar.



## Discussion

+ http://lists.w3.org/Archives/Public/www-style/2013Mar/subject.html#msg756

+ http://lists.w3.org/Archives/Public/www-style/2013Apr/subject.html#msg497



### Changelog

+ 1.2.2 - A debug statement slipped into `white-space-fast.js` - it's now removed

+ 1.2.1 - Fixed removal of white-space prematuraly in IE9 for `white-space-fast.js` (see [#5](https://github.com/dotnetCarpenter/white-space/issues/5))

+ 1.2.0 - Fires *WhiteSpaceDone* on parent element when white space is removed, fix bug where ajax call was made to *none* when the document contain \ element(s), added gzipped versions

+ 1.1.1 - fix DOM ready detection for Android 2.3

+ 1.1.0 - New white-space-fast.js implementation

+ 1.0.1 - handle css without selectors

+ 1.0.0 - first public release

+ 0.4.0 - build system and bower support - faulty release, as bower support didn't work

+ 0.3.1 - fix event listeners overwriting each other

+ 0.3.0 - DOMready feature, improved CSS tokenizer, better IE8 handling and a new use-case (real.html)

+ 0.2.2 - exclude @charset declaration kind of rules and fixed broken selector when `;` was missing at the end of the `white-space:none;` declaration (e.i. when minified).

+ 0.2.1 - excluding comments when looking for `white-space: none;`

+ 0.2.0 - added support for IE8

+ 0.1.2 - fix bug when no `white-space:none` was found in CSS

+ 0.1.1 - switch to monadish implementation

+ 0.1.0 - proof of concept



Copyright © 2013 Jon Ege Ronnenberg

This work is free. You can redistribute it and/or modify it under the

terms of the Do What The Fuck You Want To Public License, Version 2,

as published by Sam Hocevar. See <LICENSE> for more details.



[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/dotnetCarpenter/white-space/trend.png)](https://bitdeli.com/free "Bitdeli Badge")