<commit_before>[![build status](https://api.travis-ci.org/zamiang/lockit-js.png)](http://travis-ci.org/zamiang/lockit-js)

# jQuery.popLockIt

A jQuery plugin 

## Getting Started
Download the [production version][https://raw.github.com/zamiang/lockit-js/master/dist/lockit.min.js] or the [development version][https://raw.github.com/zamiang/lockit-js/master/dist/lockit.js].

In your web page:

```html
<script src="jquery.js"></script>
<script src="dist/lockit.min.js"></script>
<script>
jQuery(function($) {
  $('#feed').popLockIt({
    feedItems      : $('#feed > article'),
    columnSelector : '> .column',
    margin         : 90
  });
});
</script>
```

## Options

### feedItems

jQuery object for you feed items.

### columnSelector

selector string to get the columns for your feed items.

### margin

*todo*

## Methods

### destroy

returns feedItems and their Columns to their default positions and unbinds all events.

### recompute

Recomputes height / top / bottom etc of each feed item and its columns. Run if the size of any of your feed items has changed

### onScroll

Manually run the onScroll event. Recommend running this if you have hidden the feed and are now re-showing it.

### addFeedItems($feedItems)

Add items to the feed. Takes a jQuery object containing the new feed items.


## Examples
See [this example](http://htmlpreview.github.com/?https://github.com/zamiang/lockit-js/blob/master/example/index.html) using [Placekitten](http://placekitten.com/)

## Contributing

Please don't edit files in the `dist` subdirectory as they are generated via grunt. You'll find source code in the `src` subdirectory!

### Modifying the code
1. Fork and clone the repo.
1. If needed: `npm install -g grunt` for [Grunt](https://github.com/gruntjs/grunt)
1. If needed: `brew install phantomjs` for [PhantomJS](http://phantomjs.org/download.html)
1. Run `npm install` to install dependencies
1. Run `grunt` (compiles coffeescripts and runs tests)
1. Run `grunt watch` while editing files to auto-compile coffeescripts and run tests

### Submitting pull requests

1. Add tests for the change you want to make. Run `grunt` to see if tests fail.
1. Open `test/*.html` unit test file(s) in actual browser to ensure tests pass everywhere.
1. Run `grunt` to make sure nothing is broken
1. Push to your fork and submit a pull request.

## License

Copyright (c) 2012 <NAME>

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the<commit_msg>move the example up to the top<commit_after>[![build status](https://api.travis-ci.org/zamiang/lockit-js.png)](http://travis-ci.org/zamiang/lockit-js)

# jQuery.popLockIt

A jQuery plugin that does...

## Example

See [this example](http://htmlpreview.github.com/?https://github.com/zamiang/lockit-js/blob/master/example/index.html) using [Placekitten](http://placekitten.com/)

## Getting Started
Download the [production version][https://raw.github.com/zamiang/lockit-js/master/dist/lockit.min.js] or the [development version][https://raw.github.com/zamiang/lockit-js/master/dist/lockit.js].

In your web page:

```html
<script src="jquery.js"></script>
<script src="dist/lockit.min.js"></script>
<script>
jQuery(function($) {
  $('#feed').popLockIt({
    feedItems      : $('#feed > article'),
    columnSelector : '> .column',
    margin         : 90
  });
});
</script>
```

## Options

### feedItems

jQuery object for you feed items.

### columnSelector

selector string to get the columns for your feed items.

### margin

*todo*

## Methods

### destroy

returns feedItems and their Columns to their default positions and unbinds all events.

### recompute

Recomputes height / top / bottom etc of each feed item and its columns. Run if the size of any of your feed items has changed

### onScroll

Manually run the onScroll event. Recommend running this if you have hidden the feed and are now re-showing it.

### addFeedItems($feedItems)

Add items to the feed. Takes a jQuery object containing the new feed items.


## Contributing

Please don't edit files in the `dist` subdirectory as they are generated via grunt. You'll find source code in the `src` subdirectory!

### Modifying the code
1. Fork and clone the repo.
1. If needed: `npm install -g grunt` for [Grunt](https://github.com/gruntjs/grunt)
1. If needed: `brew install phantomjs` for [PhantomJS](http://phantomjs.org/download.html)
1. Run `npm install` to install dependencies
1. Run `grunt` (compiles coffeescripts and runs tests)
1. Run `grunt watch` while editing files to auto-compile coffeescripts and run tests

### Submitting pull requests

1. Add tests for the change you want to make. Run `grunt` to see if tests fail.
1. Open `test/*.html` unit test file(s) in actual browser to ensure tests pass everywhere.
1. Run `grunt` to make sure nothing is broken
1. Push to your fork and submit a pull request.

## License

Copyright (c) 2012 <NAME>

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
{'fraction_non_alphanumeric': 0.11295262114934246, 'fraction_numerical': 0.005764727076202486, 'mean_word_length': 4.208255159474672, 'pattern_counts': {'":': 0, '<': 17, '<?xml version=': 0, '>': 21, 'https://': 10, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '437024', 'n_tokens_mistral': 1704, 'n_tokens_neox': 1652, 'n_words': 663}