Skip to content

Conversation

@ellatrix
Copy link
Member

@ellatrix ellatrix commented Oct 8, 2020

Description

This PR introduces useSpeak and useDebouncedSpeak as a replacement for withSpokenMessages (introduced in #2107).

  • I created separate hooks because it doesn't make sense to unnecessarily debounce a function if it won't be used.
  • useDebounce could be useful to export, but I left it internal for now until we see use cases.
  • useSpeak seems sort of useless, but it might be valuable for future compatibility and I like that both function have a hook instead of just one.

One alternative I've considered is to only export useDebounce as a hook and components debounce speak themselves, but I think there's value in having a consistent wait time.

Motivation: I need this to rewrite the Autocomplete component as a hook, to be used for an experimental useRichText hook.

How has this been tested?

Screenshots

Types of changes

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • My code has proper inline documentation.
  • I've included developer documentation if appropriate.
  • I've updated all React Native files affected by any refactorings/renamings in this PR.

@github-actions
Copy link

github-actions bot commented Oct 8, 2020

Size Change: -19 B (0%)

Total Size: 1.19 MB

Filename Size Change
build/annotations/index.js 3.52 kB -1 B
build/autop/index.js 2.72 kB +1 B
build/blob/index.js 667 B -1 B
build/block-directory/index.js 8.56 kB +12 B (0%)
build/block-editor/index.js 130 kB +18 B (0%)
build/block-library/index.js 145 kB -3 B (0%)
build/components/index.js 169 kB -257 B (0%)
build/compose/index.js 9.63 kB +206 B (2%)
build/data/index.js 8.63 kB +31 B (0%)
build/date/index.js 31.9 kB +3 B (0%)
build/edit-navigation/index.js 10.6 kB +2 B (0%)
build/edit-post/index.js 306 kB -31 B (0%)
build/edit-site/index.js 21.3 kB +1 B
build/edit-widgets/index.js 21.2 kB +3 B (0%)
build/editor/index.js 45.5 kB -1 B
build/format-library/index.js 7.49 kB +1 B
build/html-entities/index.js 622 B +1 B
build/i18n/index.js 3.54 kB -1 B
build/keyboard-shortcuts/index.js 2.39 kB -1 B
build/list-reusable-blocks/index.js 3.02 kB -1 B
build/media-utils/index.js 5.12 kB -1 B
build/notices/index.js 1.69 kB -1 B
build/nux/index.js 3.27 kB +1 B
build/server-side-render/index.js 2.6 kB +1 B
build/shortcode/index.js 1.69 kB -2 B (0%)
build/viewport/index.js 1.75 kB +2 B (0%)
build/warning/index.js 1.13 kB -1 B
ℹ️ View Unchanged
Filename Size Change
build/a11y/index.js 1.14 kB 0 B
build/api-fetch/index.js 3.35 kB 0 B
build/block-directory/style-rtl.css 943 B 0 B
build/block-directory/style.css 942 B 0 B
build/block-editor/style-rtl.css 10.9 kB 0 B
build/block-editor/style.css 10.9 kB 0 B
build/block-library/editor-rtl.css 8.65 kB 0 B
build/block-library/editor.css 8.65 kB 0 B
build/block-library/style-rtl.css 7.67 kB 0 B
build/block-library/style.css 7.66 kB 0 B
build/block-library/theme-rtl.css 741 B 0 B
build/block-library/theme.css 741 B 0 B
build/block-serialization-default-parser/index.js 1.78 kB 0 B
build/block-serialization-spec-parser/index.js 3.1 kB 0 B
build/blocks/index.js 47.6 kB 0 B
build/components/style-rtl.css 15.5 kB 0 B
build/components/style.css 15.5 kB 0 B
build/core-data/index.js 12 kB 0 B
build/data-controls/index.js 685 B 0 B
build/deprecated/index.js 772 B 0 B
build/dom-ready/index.js 568 B 0 B
build/dom/index.js 4.42 kB 0 B
build/edit-navigation/style-rtl.css 868 B 0 B
build/edit-navigation/style.css 871 B 0 B
build/edit-post/style-rtl.css 6.29 kB 0 B
build/edit-post/style.css 6.28 kB 0 B
build/edit-site/style-rtl.css 3.8 kB 0 B
build/edit-site/style.css 3.81 kB 0 B
build/edit-widgets/style-rtl.css 3.03 kB 0 B
build/edit-widgets/style.css 3.03 kB 0 B
build/editor/editor-styles-rtl.css 480 B 0 B
build/editor/editor-styles.css 482 B 0 B
build/editor/style-rtl.css 3.85 kB 0 B
build/editor/style.css 3.84 kB 0 B
build/element/index.js 4.45 kB 0 B
build/escape-html/index.js 734 B 0 B
build/format-library/style-rtl.css 547 B 0 B
build/format-library/style.css 548 B 0 B
build/hooks/index.js 1.74 kB 0 B
build/is-shallow-equal/index.js 710 B 0 B
build/keycodes/index.js 1.85 kB 0 B
build/list-reusable-blocks/style-rtl.css 476 B 0 B
build/list-reusable-blocks/style.css 476 B 0 B
build/nux/style-rtl.css 671 B 0 B
build/nux/style.css 668 B 0 B
build/plugins/index.js 2.44 kB 0 B
build/primitives/index.js 1.34 kB 0 B
build/priority-queue/index.js 790 B 0 B
build/redux-routine/index.js 2.85 kB 0 B
build/rich-text/index.js 13 kB 0 B
build/token-list/index.js 1.24 kB 0 B
build/url/index.js 4.06 kB 0 B
build/wordcount/index.js 1.17 kB 0 B

compressed-size-action

@ellatrix ellatrix added the [Package] Compose /packages/compose label Oct 8, 2020
@ellatrix ellatrix added the [Type] New API New API to be used by plugin developers or package users. label Oct 8, 2020
@youknowriad
Copy link
Contributor

One alternative I've considered is to only export useDebounce as a hook and components debounce speak themselves, but I think there's value in having a consistent wait time.

I actually wonder if this is better. In general you don't want to debounce just the announcement, sometimes you want to also debounce the search at the same time...

Regardless, I don't have blockers here but I think useSpeak is useless? Why not just import speak from a11y directly? It also introduces a potential new dependency to a11y in the compose package.

@ellatrix
Copy link
Member Author

@youknowriad I agree that it's useless atm, just like it was useless in the HoC. Do you think it could provide future compatibility if speak were to use React instead of direct DOM manipulation? In any case it seems too late for that because speak is already exposed in the a11y package.

@ellatrix
Copy link
Member Author

I will change it to simply having useDebounce

@ellatrix ellatrix changed the title New hooks: useSpeak and useDebouncedSpeak New hook: useDebounce for speak function Oct 12, 2020
@ellatrix
Copy link
Member Author

@youknowriad Is this better?

* @param {...any} args Arguments passed to Lodash's `debounce`.
*/
export default function useDebounce( ...args ) {
const debounced = useMemoOne( () => debounce( ...args ), args );
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure I understand why useMemo is not enough?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, it could have a debounced call randomly cancelled. useMemoOne guarantees that will never happen. We're using it in useSelect too.

Copy link
Contributor

@youknowriad youknowriad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, I'm not sure about the extra use-memo-one dependency. By reading their README, it seems useMemo should be sufficient for us?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Package] Compose /packages/compose [Type] New API New API to be used by plugin developers or package users.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants