-
Notifications
You must be signed in to change notification settings - Fork 263
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
feat: enhance @event
decorator
#9944
Open
ilhan007
wants to merge
20
commits into
main
Choose a base branch
from
docs-new-tag-bubbles
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
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
vladitasev
previously approved these changes
Sep 27, 2024
ilhan007
changed the title
docs: describe non-bubbling events in api ref
[draft] feat: enhance @event decorator
Sep 27, 2024
ilhan007
changed the title
[draft] feat: enhance @event decorator
feat: enhance @event decorator
Sep 30, 2024
ilhan007
requested review from
dobrinyonkov,
TeodorTaushanov,
MapTo0 and
tsanislavgatev
October 1, 2024 12:24
dobrinyonkov
previously approved these changes
Oct 2, 2024
ilhan007
changed the title
feat: enhance @event decorator
feat: enhance Oct 3, 2024
@event
decorator
1 task
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.
Background
The initial goal used to be to better describe our events - which bubble and which can be prevented as part of the API reference docs. While this is the benefit for the end-users, there is another enhancement for component developers, explained below.
Change
The
@event
decorator is enhanced to provide two new fields describing components' events -cancelable
andbubbles
, previously configurable via theUI5Element.fireEvent
only, allowing more declarative way to configure these event settings:cancelable
- if set totrue
the event can be prevented with preventDefualt() (by default isfalse
)bubbles
- if set tofalse
the event will NOT bubble up the DOM tree (by default istrue
)Usage
The
fireDecoratorEvent
MethodThe fireDecoratorEvent method considers the the event decorator.
Unlike
fireEvent
, thefireDecoratorEvent
method has only two parameters - the event name and the event detail as the rest of the settings are configurable via the event decorator.The
fireEvent
MethodThe
fireEvent
Method does not consider the event decorator and works as before.API Reference
As mentioned we start showing this information in our website as follows. This comes out of the box, nothing for component developers to take care.
Fixes: #9909