Document the trix-action-invoke event
#1189
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The [Trix Wiki][wiki] has a page documenting how to [customize the Toolbar element][toolbar]. Its a helpful, thorough document with a lot of great information, including how to invoke custom actions through the rendering elements with an `x`-prefixed `[data-trix-action]` attribute. Since this information is at the bottom of the wiki page, it isn't readily available from the `README.md`. The `trix-action-invoke` event that's dispatched is also omitted from the README's list of events. This commit promotes the contents of the wiki page into the `README`, documents the `trix-action-invoke` event, and adds missing test coverage that exercises the event. [wiki]: https://github.com/basecamp/trix/wiki/Configuration [toolbar]: https://github.com/basecamp/trix/wiki/Configuration#toolbar
|
@jorgemanrubia the wiki page includes a lot of helpful information. If this change is merged, would it make sense to remove the Configuration pages from the Wiki so that the information isn't duplicated and prone to drifting out of sync? |
jorgemanrubia
approved these changes
Oct 1, 2024
There was a problem hiding this comment.
Thanks @seanpdoyle I agree this makes more sense in the README. I deleted the wiki page.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Trix Wiki has a page documenting how to customize the Toolbar element. Its a helpful, thorough document with a lot of great information, including how to invoke custom actions through the rendering elements with an
x-prefixed[data-trix-action]attribute.Since this information is at the bottom of the wiki page, it isn't readily available from the
README.md. Thetrix-action-invokeevent that's dispatched is also omitted from the README's list of events.This commit promotes the contents of the wiki page into the
README, documents thetrix-action-invokeevent, and adds missing test coverage that exercises the event.