Skip to content

Update the README #364

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 1, 2019
Merged

Update the README #364

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 11 additions & 45 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,25 +45,24 @@ A priority queue that will efficiently batch, order, reorder and process work; d
The following code will only cause a single DOM manipulation:

```html
<!doctype html>
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta charset="utf-8" />
<title>Backburner demo</title>
</head>
<body>

<div id="name"></div>
<body>
<div id="name"></div>

<script src="//code.jquery.com/jquery-2.1.1.min.js"></script>
<script src="backburner.js"></script>
<script type="module">
import Backburner from './dist/es6/backburner.js'

<script>
var backburner = new Backburner(['render']),
person = {name: "Erik"};
person = {name: 'Erik'};

function updateName() {
$('#name').text(person.name);
document.querySelector('#name').innerHTML = person.name;
}

function setName(name) {
Expand All @@ -72,44 +71,11 @@ The following code will only cause a single DOM manipulation:
}

backburner.run(function() {
setName("Kris");
setName("Tom");
setName("Yehuda");
setName('Kris');
setName('Tom');
setName('Yehuda');
});
</script>
</body>
</html>
```

## Simple Backbone Example

```javascript
app.TodoView = Backbone.View.extend({
// ...

initialize: function () {
this.listenTo(this.model, 'change', this.render);
},

render: function() {
// put the rerender on the backburner!
backburner.deferOnce('render', this, this.actuallyRender);
},

actuallyRender: function() {
// do our DOM manipulations here. will only be called once.
}

// ...
});


// ... somewhere in our app code ...
backburner.run(function() {
model.set('firstName', 'Erik');
model.set('lastName', 'Bryn');
});

// our view has been rerendered only once, thanks to backburner!

```