<commit_before>i-sticky
========

jquery plugin for position:sticky emulation<commit_msg>1.0.0 README<commit_after>** i-sticky

"position: sticky" jQuery plugin / polyfill. Takes use of the [BEM](http://bem.info)-notation by default.
Based on [position--sticky- polyfill](https://github.com/matthewp/position--sticky-) by <NAME>.

*** Limitations

* only vertical direction is supported
* if native position:sticky support is detected, the plugin does nothing
* you shouldn't set `left` or `right` CSS properties on sticky positioned element
* you should set `top`, `bottom` or `margin-left` properties in pixels only
* parent block of position:sticky element MUST have position different from static (f.e., relative is a good choice)


*** Usage

jQuery is required (tested with 1.8.3, should work with 1.7.0 or newer). Then write some JS:

```js
$('.i-sticky').iSticky({
    holderClass:      'i-sticky__holder',
    holderAutoHeight: false
});
```

You should write CSS rules by yourself, as you normally would. For example:

```css
/* sticky element */
.i-sticky {
    position: relative;
    position: -webkit-sticky;
    position: sticky;
    top: 0;
    height: 30px;
}
/* it's placeholder, generated by plugin */
.i-sticky + .i-sticky__holder {
    height: 30px;
}
/* don't forget to change positioning of parent element */
.some-sticky-parent {
    position: relative;
}
```

*** Configuration

* `holderClass` contains className for the placeholder element, that is created to hold original element's place. Default value is `i-sticky__holder`
* `holderAutoHeight` when set true, the plugin will recalculate placeholder's height. Otherwise, your CSS should define it. Defaults to `false`.

*** License

MIT

*** Examples

[REG.COM domain checker](https://www.reg.com/choose/domain/?domains=position+sticky)

*** Changelog

2014-10-08 1.0.0
{'fraction_non_alphanumeric': 0.12385073012439156, 'fraction_numerical': 0.01352082206598161, 'mean_word_length': 4.138888888888889, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 2, 'lorem ipsum': 0, 'www.': 1, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4165649', 'n_tokens_mistral': 585, 'n_tokens_neox': 546, 'n_words': 200}