Skip to content
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

Clarify docs on target-framerate. Fixes #4897 #4941

Merged
merged 3 commits into from
Nov 21, 2017
Merged

Clarify docs on target-framerate. Fixes #4897 #4941

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c18a534
Clarify docs on target-framerate. Fixes #4897
kevinpschaaf Nov 17, 2017
348ed92
Also clarify `delay` units. Fixes #4707
kevinpschaaf Nov 17, 2017
80a7f1e
Comment reworded based on feedback.
Nov 21, 2017
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
18 changes: 11 additions & 7 deletions lib/elements/dom-repeat.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@

/**
* When using a `filter` or `sort` function, the `delay` property
* determines a debounce time after a change to observed item
* determines a debounce time in ms after a change to observed item
* properties that must pass before the filter or sort is re-run.
* This is useful in rate-limiting shuffling of the view when
* item changes may be frequent.
Expand Down Expand Up @@ -250,12 +250,16 @@
},

/**
* When `initialCount` is used, this property defines a frame rate to
* target by throttling the number of instances rendered each frame to
* not exceed the budget for the target frame rate. Setting this to a
* higher number will allow lower latency and higher throughput for
* things like event handlers, but will result in a longer time for the
* remaining items to complete rendering.
* When `initialCount` is used, this property defines a frame rate (in
* fps) to target by throttling the number of instances rendered each
* frame to not exceed the budget for the target frame rate. The
* framerate is effectively the number of `requestAnimationFrame`s that
* it tries to allow to actually fire in a given second. It does this
* by measuring the time between `rAF`s and continuously adjusting the
* number of items created each `rAF` to maintain the target framerate.
* Setting this to a higher number allows lower latency and higher
* throughput for event handlers and other tasks, but results in a
* longer time for the remaining items to complete rendering.
*/
targetFramerate: {
type: Number,
Expand Down