-
Notifications
You must be signed in to change notification settings - Fork 167
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.
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
Add announce Plugin #2109
Add announce Plugin #2109
Conversation
BryanValverdeU
commented
Sep 27, 2023
•
edited
Loading
edited
- Add announce plugin
- Add a AnnounceHandler, that will be in charge of announcing the messages by using a aria-live element, this handler will require a string map with the localized strings to announce messages from built-in RoosterJS features.
- Add an additional callback property to ContentEditEventData, getAnnounceData, used in the Announce Plugin
- Add first announcing logic when indenting/outdenting list
…u/bvalverde/announceInRooster
In general, I'd like to discuss about the design. Announcing is not a core function of editor, but should only be applied when A11y is cared. So can we make it as a plugin instead? And editor/other plugins just provides as few info as possible (I think your code already did this part). For example, with ContentChangedEvent, we an add something about announcing, then the plugin see the event and see there is announcing info, then it will announce. So if there is not such plugin added, we don't announce at all. What do you thing? I'm open to disucss. |
Thanks for checking Jason, I agree with all you said. Maybe we can just add a new PluginEvent for announcing and let the new plugin handle it exclussively. Do you think this could be a good way? |
I'm ok to have a new event type. But I also feel ContentChangedEvent should be fine, think about this:
When |
Ah ok, that makes sense. I was thinking more about an scenario where a ContentChanged was triggered and each plugin could modify the announce data in the event. I will try to refactor it to this. |
packages/roosterjs-editor-plugins/lib/plugins/Announce/AnnounceHandlerImpl.ts
Outdated
Show resolved
Hide resolved
packages/roosterjs-editor-plugins/lib/plugins/Announce/AnnounceHandlerImpl.ts
Outdated
Show resolved
Hide resolved
packages/roosterjs-editor-plugins/lib/plugins/Announce/AnnounceHandlerImpl.ts
Outdated
Show resolved
Hide resolved
packages/roosterjs-editor-plugins/lib/plugins/Announce/AnnounceHandlerImpl.ts
Outdated
Show resolved
Hide resolved
packages/roosterjs-editor-plugins/lib/plugins/Announce/AnnounceHandlerImpl.ts
Outdated
Show resolved
Hide resolved
packages/roosterjs-editor-plugins/lib/plugins/ContentEdit/features/listFeatures.ts
Show resolved
Hide resolved
packages/roosterjs-editor-plugins/lib/plugins/Announce/AnnouncePlugin.ts
Outdated
Show resolved
Hide resolved
packages/roosterjs-editor-plugins/lib/plugins/ContentEdit/features/listFeatures.ts
Show resolved
Hide resolved
packages/roosterjs-editor-types/lib/enum/KnownAnnounceStrings.ts
Outdated
Show resolved
Hide resolved
* Content Model: Clear table selection fix (#2086) * Content Model: Clear table selection fix * fix build * Fix #2078 (#2092) * Fix #2078 * add test * Graduate feature InlineEntityReadOnlyDelimiters (#2098) * Graduate InlineEntityReadOnlyDelimiters * fix build * Fix 227982 (#2095) * Content Model: Advanced cache (#2083) * Content Model Customization refactor * fix build * improve * Content Model Customization refactor 2: Add default config * fix build * Content Model: Persist cache 1 * fix build * improve * Content Model: Cache 2 * Fix test * Fix build * improve * Improve * improve * Improve * fix test * Do not restore cached selection when call select * Content Model: Add model into ContentChangedEvent * fix build * add demo site page * Improve * Content Model: pass out segment nodes * cache 8 * fix build * fix test * Improve * improve * fix test * Improve * fix test * Improve "checkDependency" * Content Model: Clear table selection fix * fix build * Content Model: Improve adjustWordSelection * add test * add test * fix test * Improve * retrigger check step * retrigger check step * do not underline, if not text * remove empty line * refactor * Replace tslint with eslint (#2101) * Graduate feature ContentModelPaste (#2102) * Remove NodeType from Content Model (#2106) * Enable eslint rule to improve imports (#2105) * Enable eslint rule to force import type * Clear duplicated imports * selection * Content Model: Move default format logic into ContentModelFormatPlugin (#2099) * Content Model Customization refactor * fix build * improve * Content Model Customization refactor 2: Add default config * fix build * Content Model: Persist cache 1 * fix build * improve * Content Model: Cache 2 * Fix test * Fix build * improve * Improve * improve * Improve * fix test * Do not restore cached selection when call select * Content Model: Add model into ContentChangedEvent * fix build * add demo site page * Improve * Content Model: pass out segment nodes * cache 8 * fix build * fix test * Improve * improve * fix test * Improve * fix test * Improve "checkDependency" * Content Model: Clear table selection fix * fix build * Content Model: Improve adjustWordSelection * add test * add test * fix test * Graduate InlineEntityReadOnlyDelimiters * fix build * fix test * Refactor format plugin * fix test * Improve * fix build * Standalone editor: remove SelectionRangeEx from Content Model (#2103) * Remove SelectionRangeEx from ContentModel * fix test * improve * fix build * fix test * Content Model: Move copy entity related code to copyPastePlugin (#2111) * Fix PickPlugin will not remove nodes with other tags other than <a> tag (#2116) * Content Model: Clear cache when input in expanded selection (#2114) * Content Model: Clear cache when input in expanded selection * fix build * standalone editor: Remove dependencies (#2115) * Standalone editor: decouple entity (#2107) * Standalone editor: decouple entity * fix build * fix build * improve * fix build * add test * Add announce Plugin (#2109) Add announce plugin Add a AnnounceHandler, that will be in charge of announcing the messages by using a aria-live element, this handler will require a string map with the localized strings to announce messages from built-in RoosterJS features. Add an additional callback property to ContentEditEventData, getAnnounceData, used in the Announce Plugin Add first announcing logic when indenting/outdenting list * image selection test * Fix demo page (#2120) * remove height * WIP * Standalone editor: decouple utilities (#2123) * fix comment * Fix Excel Border issue when pasting (#2121) * init * itChromeOnly * add unit test * fix chrome test * Announce Plugin, add features to current plugin (#2119) * init * remove * Fix type issues * add tests * Fix build * Move logic from Editor to Plugin * Add type to param * DefaultAnnounceString to KnownAnnounceStrings * merge classes * Add more details in comments * Fix build * const enum * fix * init * Add callback that returns string * init2 * Fix test after merge * Refactor * refactor * Fix * Dispose editor * Move util from dom to plugin pkg & fix * remove unneeded if * remove unneeded test * image selection ctrl * refator * rename newImage * fix build * Recreate Content Model for table and image selection (#2128) * Catch error and continue when dispose editor (#2129) * Cache error and continue when dispose editor * Improve * Do not focus to editor when formatWithContentModel (#2130) * Standalone editor: Remove more dependencies (#2127) * Standalone editor: decouple utilities * Standalone editor: Remove more dependencies * fix build * remove unnecessary code * RoosterJs 8.57.0 --------- Co-authored-by: Júlia Roldi <[email protected]> Co-authored-by: Julia Roldi <[email protected]> Co-authored-by: Leah Xia <[email protected]> Co-authored-by: Bryan Valverde U <[email protected]>