Skip to content

Commit

Permalink
Merge pull request #1796 from SUI-Components/feat/perf-doc
Browse files Browse the repository at this point in the history
docs(packages/sui-performance): small update
  • Loading branch information
andresz1 authored Jul 31, 2024
2 parents 39e2d3f + 95687cb commit 59bf7db
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion packages/sui-performance/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export default function Example() {

### Delay code execution until urgent

Use this function to delay the execution of an expensive operation while the main thread is idle, using [requestIdleCallback](https://developer.mozilla.org/en-US/docs/Web/API/Window/requestIdleCallback), and to prioritize user actions. This method ensures the execution is completed before the user leaves the page. It is especially useful for delaying tracking execution.
Use this function to delay the execution of an expensive operation until the main thread is idle using [requestIdleCallback](https://developer.mozilla.org/en-US/docs/Web/API/Window/requestIdleCallback) to prioritize user actions. This method ensures the execution is completed before the user leaves the page. It is especially useful for delaying tracking execution.

The `delayTaskUntilUrgent` function optionally receives an options object. The documentation can be found [here](https://github.com/redbus-labs/idlefy/tree/main?tab=readme-ov-file#methods) ([idlefy](https://github.com/redbus-labs/idlefy/tree/main) is used under the hood).

Expand Down

0 comments on commit 59bf7db

Please sign in to comment.