Skip to content

Conversation

@Secticide
Copy link
Collaborator

Description

When investigating a user's issue with the onIMECompositionChange event with a specific IME on Windows 10 (Korean), we noticed that there are cases where the blank event is not fired to signify the submission or resetting of the composition. The more consistent way to use this events is to use the IME Composition Change event to display the text that is currently being edited and rely on the onTextInput event for submission (resetting can be handled by listening for a new composition event and updating the displayed text accordingly).

The specific line that likely caused the user to expect (and therefore rely on) the empty string event is as follows:

Fired once for every change, sends the entire string to date, and sends a blank string whenever a composition is submitted or reset.

Changes made

  • Modified the onIMECompositionChange event documentation to better point users to intended usage

Notes

This is a work in progress PR with the intention of iterating on the documentation wording.

@Secticide Secticide self-assigned this Sep 27, 2023
@Secticide Secticide requested review from duckets and ekcoh September 27, 2023 15:05
@Secticide Secticide added work in progress Indicates that the PR is work in progress and any review efforts can be post-poned. and removed work in progress Indicates that the PR is work in progress and any review efforts can be post-poned. labels Sep 27, 2023
Copy link
Collaborator

@ekcoh ekcoh left a comment

Choose a reason for hiding this comment

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

Documentation update LGTM. @duckets any feedback from your side?

Copy link
Collaborator

@ekcoh ekcoh left a comment

Choose a reason for hiding this comment

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

Approving this one, lets merge it as soon as CI is working again. Doc checks might pick something up but looks good so likely not.

@ekcoh
Copy link
Collaborator

ekcoh commented Oct 2, 2023

@Secticide I believe you just need to resolve conflict in CHANGELOG.md now and lets CI rerun this branch. Then you may merge it to develop.

@Secticide Secticide force-pushed the ISXB-628-IME-Composition-Event-Docs branch 3 times, most recently from e09a767 to 54defba Compare October 5, 2023 12:20
@Secticide Secticide force-pushed the ISXB-628-IME-Composition-Event-Docs branch from 54defba to 73117ff Compare October 6, 2023 13:04
@Secticide Secticide merged commit 6d8ff96 into develop Oct 9, 2023
@Secticide Secticide deleted the ISXB-628-IME-Composition-Event-Docs branch October 9, 2023 09:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants