660 document new debouncer utility by MatthewHawkins · Pull Request #683 · webforj/webforj-documentation

MatthewHawkins · 2026-01-09T19:21:34Z

No description provided.

…to remove Label component use and replace with Paragraph

github-actions · 2026-01-09T19:22:18Z

+The `Debouncer` runs on the UI thread using webforJ's [`Interval`](/docs/advanced/interval) mechanism, so you don't need to wrap UI updates in `Environment.runLater()`.
+
+:::tip
+The delay parameter uses seconds as the unit, not milliseconds. Use `0.3f` for 300ms or `1.5f` for 1.5 seconds.


🚫 [vale] _{reported by reviewdog 🐶}
[Google.Units] Put a nonbreaking space between the number and the unit in '300ms'.

github-actions · 2026-01-09T19:22:18Z

+});
+```
+
+## Debouncer vs ElementEventOptions {#debouncer-vs-elementeventoptions}


⚠️ [vale] _{reported by reviewdog 🐶}
[Google.Headings] 'Debouncer vs ElementEventOptions' should use sentence-style capitalization.

github-actions · 2026-01-09T19:22:18Z

+
+## Best practices {#best-practices}
+
+1. **Choose appropriate delays**: Use shorter delays (200-300ms) for responsive interactions like search, and longer delays (1-2s) for expensive operations like auto-save.


🚫 [vale] _{reported by reviewdog 🐶}
[Google.Units] Put a nonbreaking space between the number and the unit in '300ms'.

github-actions · 2026-01-09T19:22:18Z

+
+## Best practices {#best-practices}
+
+1. **Choose appropriate delays**: Use shorter delays (200-300ms) for responsive interactions like search, and longer delays (1-2s) for expensive operations like auto-save.


🚫 [vale] _{reported by reviewdog 🐶}
[Google.Units] Put a nonbreaking space between the number and the unit in '2s'.

github-actions · 2026-01-09T19:22:18Z

+
+2. **Reuse debouncer instances**: Create one `Debouncer` instance and reuse it rather than creating new instances on each event.
+
+3. **Flush before critical actions**: Call `flush()` before form submission or navigation to ensure pending actions complete.


⚠️ [vale] _{reported by reviewdog 🐶}
[webforJ.BeDirect] Avoid using 'ensure pending'. Focus more on explicitly giving details about the feature.

hyyan · 2026-01-14T14:10:31Z

@MatthewHawkins I see some unrelated changes in the PR and a version change in the POM. Please clean that up and mark the PR as ready for review when it's done.

hyyan · 2026-01-15T07:52:04Z

@@ -0,0 +1,196 @@
+---
+sidebar_position: 11


Move section to advanced

hyyan · 2026-01-15T07:52:38Z

+
+The `Debouncer` runs on the UI thread using webforJ's [`Interval`](/docs/advanced/interval) mechanism, so you don't need to wrap UI updates in `Environment.runLater()`.
+
+:::tip


Give this tip a title

hyyan · 2026-01-15T07:53:49Z

+The delay parameter uses seconds as the unit, not milliseconds. Use `0.3f` for 300ms or `1.5f` for 1.5 seconds.
+:::
+
+## API methods {#api-methods}


Remove the API methods section. You already cover them later.

hyyan · 2026-01-15T07:55:03Z

+
+The following methods can be used to more precisely handle the execution and use of the `Debouncer`:
+
+### Cancelling a pending action {#cancelling-a-pending-action}


Explain that, like intervals. It's good practice to cancel the interval when the component is destroyed.

hyyan · 2026-01-15T07:55:48Z

+}
+```
+
+## Use cases {#use-cases}


remove section

hyyan · 2026-01-15T07:58:16Z

+```
+
+## Debouncer vs ElementEventOptions {#debouncer-vs-elementeventoptions}
+


Rename section to Choosing between Debouncer and event debounce options

hyyan · 2026-01-15T08:00:30Z

+}, options);
+```
+
+## Best practices {#best-practices}


remove section

hyyan · 2026-01-15T08:01:17Z

+  private final TextField input = new TextField();
+  private final Paragraph output = new Paragraph();
+  private final Paragraph counter = new Paragraph();
+  private final Debouncer debounce = new Debouncer(0.5f);


Cancel the debouncer when component is destroyed

hyyan · 2026-01-15T08:04:06Z

+      count++;
+      counter.setText("Key events: " + count);
+
+      debounce.run(() -> {


rest count when debounce is done

MatthewHawkins added 2 commits January 9, 2026 14:20

feat: initial draft of debouncer docs and demo

3931893

chore: rolling POM version and updating the VerifyDebouncingSnippets …

7d83290

…to remove Label component use and replace with Paragraph

MatthewHawkins requested review from EHandtkeBasis, bbrennanbasis, gosteenBASIS, hyyan and laurenic0l as code owners January 9, 2026 19:21

MatthewHawkins linked an issue Jan 9, 2026 that may be closed by this pull request

Document new Debouncer utility #660

Closed

github-actions Bot reviewed Jan 9, 2026

View reviewed changes

hyyan added the status: needs-snapshot Update to the latest snapshot before this PR can be merged. label Jan 14, 2026

chore: removing redundant file and reverting POM changes

1f02c36

MatthewHawkins added the status: waiting-for-review The PR is ready. Waiting for team members to review. label Jan 14, 2026

hyyan requested changes Jan 15, 2026

View reviewed changes

hyyan added status: waiting-for-author Review is done. Waiting for the PR author to apply changes or respond. and removed status: waiting-for-review The PR is ready. Waiting for team members to review. labels Jan 15, 2026

MatthewHawkins requested a review from bryanhighhill January 15, 2026 15:48

docs: updating based on feedback

b4eb726

MatthewHawkins self-assigned this Jan 20, 2026

hyyan self-requested a review January 22, 2026 10:59

hyyan requested changes Jan 22, 2026

View reviewed changes

chore: resetting count after debouncer runs

073fa17

MatthewHawkins added status: waiting-for-review The PR is ready. Waiting for team members to review. and removed status: waiting-for-author Review is done. Waiting for the PR author to apply changes or respond. labels Jan 22, 2026

EHandtkeBasis approved these changes Jan 23, 2026

View reviewed changes

refactor: improve demo [no ci]

f9dacda

hyyan approved these changes Jan 26, 2026

View reviewed changes

hyyan merged commit 9773a7e into main Jan 26, 2026

hyyan deleted the 660-document-new-debouncer-utility branch January 26, 2026 09:04


		## Best practices {#best-practices}

		1. Choose appropriate delays: Use shorter delays (200-300ms) for responsive interactions like search, and longer delays (1-2s) for expensive operations like auto-save.


		2. Reuse debouncer instances: Create one `Debouncer` instance and reuse it rather than creating new instances on each event.

		3. Flush before critical actions: Call `flush()` before form submission or navigation to ensure pending actions complete.


		The `Debouncer` runs on the UI thread using webforJ's [`Interval`](/docs/advanced/interval) mechanism, so you don't need to wrap UI updates in `Environment.runLater()`.

		:::tip


		The following methods can be used to more precisely handle the execution and use of the `Debouncer`:

		### Cancelling a pending action {#cancelling-a-pending-action}

		```

		## Debouncer vs ElementEventOptions {#debouncer-vs-elementeventoptions}

		@@ -0,0 +1,196 @@
		---
		sidebar_position: 11

Conversation

MatthewHawkins commented Jan 9, 2026

Uh oh!

github-actions Bot Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

hyyan commented Jan 14, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants