-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
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
Angular: Fix template props not able to use dot notation #28588
Angular: Fix template props not able to use dot notation #28588
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PR Summary
- Added tests in
/code/frameworks/angular/src/client/angular-beta/ComputesTemplateFromComponent.test.ts
to verify correct handling of non-dot notation properties. - Introduced
formatPropInTemplate
function in/code/frameworks/angular/src/client/angular-beta/ComputesTemplateFromComponent.ts
to handle invalid dot notation property names. - Updated
/code/frameworks/angular/src/client/angular-beta/__testfixtures__/input.component.ts
with new @input and @output properties for non-dot notation cases. - Enhanced
/code/frameworks/angular/src/client/argsToTemplate.test.ts
with a test case for non-dot notation property handling. - Modified
/code/frameworks/angular/src/client/argsToTemplate.ts
to useformatPropInTemplate
for formatting property names correctly.
5 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings
☁️ Nx Cloud ReportCI is running/has finished running commands for commit d40abaa. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Thank you for also adding some tests. It is much appreciated
Closes #28577
What I did
In an Angular template, if the left side of an input is wrapped in brackets or output in parenthesis, then the right side is typescript-like. (ex.
[input]="<typescript-like>"
,[output]="<typescript-like>"
) That code segment is in a context primarily consisting of the component instance's public properties. I haven't looked at how the compiler translates that code exactly, in a while, but it should be something like the following. (Template:[input]="myValue"
, Compiled:component.input = this.myValue
)In javascript, you can have a property named 'my-value', but you can't access that value like
this.my-value
. The same is true for the code segments of an Angular template.This change checks the name to see if it is valid for accessing with dot notation. If it isn't then it is formatted the following way:
[input]="this['my-value']"
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
I can add this to a story, but it is just formatting of an uncommon scenario. I think running the unit test should be enough.
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal
,ci:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.ts
Make sure this PR contains one of the labels below:
Available labels
bug
: Internal changes that fixes incorrect behavior.maintenance
: User-facing maintenance tasks.dependencies
: Upgrading (sometimes downgrading) dependencies.build
: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup
: Minor cleanup style change. Will not show up in release changelog.documentation
: Documentation only changes. Will not show up in release changelog.feature request
: Introducing a new feature.BREAKING CHANGE
: Changes that break compatibility in some way with current major version.other
: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/core
team here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>