Skip to content
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

fix(common): rename rawSrc -> ngSrc in NgOptimizedImage directive #47362

Closed
wants to merge 2 commits into from

Conversation

AndrewKushnir
Copy link
Contributor

As an ongoing effort to stabilize the NgOptimizedImage API before existing the Developer Preview, this commit renames the rawSrc attribute used for the NgOptimizedImage selector matching to ngSrc. The rawSrcset is also renamed to ngSrcset for consistency.

The motivation for this change is to align the attribute name better with other built-in directives, such as ngFor, ngIf, ngClass, ngStyle, etc.

Note: this is technically a breaking change, but since the NgOptimizedImage directive is in the Developer Preview mode, we land the change in a patch branch.

Does this PR introduce a breaking change?

  • Yes
  • No, since the NgOptimizedImage directive is in the Developer Preview mode.

As an ongoing effort to stabilize the NgOptimizedImage API before existing the Developer Preview, this commit renames the `rawSrc` attribute used for the NgOptimizedImage selector matching to `ngSrc`. The `rawSrcset` is also renamed to `ngSrcset` for consistency.

The motivation for this change is to align the attribute name better with other built-in directives, such as `ngFor`, `ngIf`, `ngClass`, `ngStyle`, etc.

Note: this is technically a breaking change, but since the NgOptimizedImage directive is in the Developer Preview mode, we land the change in a patch branch.
@AndrewKushnir AndrewKushnir added state: WIP area: common Issues related to APIs in the @angular/common package target: patch This PR is targeted for the next patch release common: image directive labels Sep 6, 2022
@ngbot ngbot bot modified the milestone: Backlog Sep 6, 2022
@AndrewKushnir AndrewKushnir requested review from kara, pkozlowski-opensource and jelbourn and removed request for kara September 6, 2022 21:15
@AndrewKushnir AndrewKushnir added action: review The PR is still awaiting reviews from at least one requested reviewer and removed state: WIP labels Sep 6, 2022
@AndrewKushnir AndrewKushnir marked this pull request as ready for review September 6, 2022 21:15
Copy link
Contributor

@kara kara left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Member

@jelbourn jelbourn left a comment

Choose a reason for hiding this comment

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

LGTM

Reviewed-for: public-api, global-docs-approvers

@pullapprove pullapprove bot requested a review from alxhub September 7, 2022 18:55
@AndrewKushnir
Copy link
Contributor Author

@kara @jelbourn FYI I've pushed a fixup commit to detect when the rawSrc is used and throw an error in this case: 0ab17f6. Could you please take a look and let me know what you think? Thank you.

@jelbourn
Copy link
Member

jelbourn commented Sep 7, 2022

@AndrewKushnir looked at the commit, LGTM

Copy link
Member

@jelbourn jelbourn left a comment

Choose a reason for hiding this comment

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

LGTM

Reviewed-for: global-docs-approvers

Copy link
Contributor

@kara kara left a comment

Choose a reason for hiding this comment

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

LGTM

@AndrewKushnir AndrewKushnir added action: presubmit The PR is in need of a google3 presubmit and removed action: review The PR is still awaiting reviews from at least one requested reviewer labels Sep 7, 2022
@AndrewKushnir
Copy link
Contributor Author

Presubmit.

Copy link
Member

@pkozlowski-opensource pkozlowski-opensource left a comment

Choose a reason for hiding this comment

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

LGTM!

Reviewed-for: public-api
Reviewed-for: fw-core
Reviewed-for: fw-common

@AndrewKushnir AndrewKushnir added action: merge The PR is ready for merge by the caretaker and removed action: presubmit The PR is in need of a google3 presubmit labels Sep 8, 2022
@dylhunn dylhunn added target: minor This PR is targeted for the next minor release and removed target: patch This PR is targeted for the next patch release labels Sep 9, 2022
@dylhunn
Copy link
Contributor

dylhunn commented Sep 9, 2022

This PR was merged into the repository by commit ca7bf65.

@dylhunn dylhunn closed this in ca7bf65 Sep 9, 2022
@dylhunn
Copy link
Contributor

dylhunn commented Sep 9, 2022

@AndrewKushnir This has been merged into minor, but needs a rebase to merge into patch.

AndrewKushnir added a commit to AndrewKushnir/angular that referenced this pull request Sep 9, 2022
…angular#47362)

As an ongoing effort to stabilize the NgOptimizedImage API before existing the Developer Preview, this commit renames the `rawSrc` attribute used for the NgOptimizedImage selector matching to `ngSrc`. The `rawSrcset` is also renamed to `ngSrcset` for consistency.

The motivation for this change is to align the attribute name better with other built-in directives, such as `ngFor`, `ngIf`, `ngClass`, `ngStyle`, etc.

Note: this is technically a breaking change, but since the NgOptimizedImage directive is in the Developer Preview mode, we land the change in a patch branch.

PR Close angular#47362
@AndrewKushnir
Copy link
Contributor Author

@dylhunn thanks for the note, I've created a new patch-only PR: #47396. It should be ready for merge once CI is "green".

dylhunn pushed a commit that referenced this pull request Sep 12, 2022
…#47362) (#47396)

As an ongoing effort to stabilize the NgOptimizedImage API before existing the Developer Preview, this commit renames the `rawSrc` attribute used for the NgOptimizedImage selector matching to `ngSrc`. The `rawSrcset` is also renamed to `ngSrcset` for consistency.

The motivation for this change is to align the attribute name better with other built-in directives, such as `ngFor`, `ngIf`, `ngClass`, `ngStyle`, etc.

Note: this is technically a breaking change, but since the NgOptimizedImage directive is in the Developer Preview mode, we land the change in a patch branch.

PR Close #47362

PR Close #47396
vyom1611 pushed a commit to vyom1611/angular that referenced this pull request Sep 18, 2022
…angular#47362)

As an ongoing effort to stabilize the NgOptimizedImage API before existing the Developer Preview, this commit renames the `rawSrc` attribute used for the NgOptimizedImage selector matching to `ngSrc`. The `rawSrcset` is also renamed to `ngSrcset` for consistency.

The motivation for this change is to align the attribute name better with other built-in directives, such as `ngFor`, `ngIf`, `ngClass`, `ngStyle`, etc.

Note: this is technically a breaking change, but since the NgOptimizedImage directive is in the Developer Preview mode, we land the change in a patch branch.

PR Close angular#47362
crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this pull request Sep 22, 2022
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [@angular/animations](https://github.com/angular/angular) | dependencies | patch | [`14.2.1` -> `14.2.2`](https://renovatebot.com/diffs/npm/@angular%2fanimations/14.2.1/14.2.2) |
| [@angular/common](https://github.com/angular/angular) | dependencies | patch | [`14.2.1` -> `14.2.2`](https://renovatebot.com/diffs/npm/@angular%2fcommon/14.2.1/14.2.2) |
| [@angular/compiler](https://github.com/angular/angular) | dependencies | patch | [`14.2.1` -> `14.2.2`](https://renovatebot.com/diffs/npm/@angular%2fcompiler/14.2.1/14.2.2) |
| [@angular/compiler-cli](https://github.com/angular/angular/tree/main/packages/compiler-cli) ([source](https://github.com/angular/angular)) | devDependencies | patch | [`14.2.1` -> `14.2.2`](https://renovatebot.com/diffs/npm/@angular%2fcompiler-cli/14.2.1/14.2.2) |
| [@angular/core](https://github.com/angular/angular) | dependencies | patch | [`14.2.1` -> `14.2.2`](https://renovatebot.com/diffs/npm/@angular%2fcore/14.2.1/14.2.2) |
| [@angular/forms](https://github.com/angular/angular) | dependencies | patch | [`14.2.1` -> `14.2.2`](https://renovatebot.com/diffs/npm/@angular%2fforms/14.2.1/14.2.2) |
| [@angular/platform-browser](https://github.com/angular/angular) | dependencies | patch | [`14.2.1` -> `14.2.2`](https://renovatebot.com/diffs/npm/@angular%2fplatform-browser/14.2.1/14.2.2) |
| [@angular/platform-browser-dynamic](https://github.com/angular/angular) | dependencies | patch | [`14.2.1` -> `14.2.2`](https://renovatebot.com/diffs/npm/@angular%2fplatform-browser-dynamic/14.2.1/14.2.2) |

---

### Release Notes

<details>
<summary>angular/angular</summary>

### [`v14.2.2`](https://github.com/angular/angular/blob/HEAD/CHANGELOG.md#&#8203;1422-2022-09-14)

[Compare Source](angular/angular@14.2.1...14.2.2)

##### animations

| Commit | Type | Description |
| -- | -- | -- |
| [937e6c5b3d](angular/angular@937e6c5) | fix | make sure that the animation function delay is applied ([#&#8203;47285](angular/angular#47285)) |

##### common

| Commit | Type | Description |
| -- | -- | -- |
| [c9bdf9bab1](angular/angular@c9bdf9b) | fix | rename `rawSrc` -> `ngSrc` in NgOptimizedImage directive ([#&#8203;47362](angular/angular#47362)) ([#&#8203;47396](angular/angular#47396)) |

##### core

| Commit | Type | Description |
| -- | -- | -- |
| [a3e1303f04](angular/angular@a3e1303) | fix | imply [@&#8203;Optional](https://github.com/Optional) flag when a default value is provided ([#&#8203;47242](angular/angular#47242)) |

##### forms

| Commit | Type | Description |
| -- | -- | -- |
| [80c66a1e57](angular/angular@80c66a1) | fix | don't prevent default behavior for forms with method="dialog" ([#&#8203;47308](angular/angular#47308)) |

#### Special Thanks

Abhishek Rawat, Andrew Kushnir, Benjamin Chanudet, Bob Watson, George Kalpakas, Ikko Ashimine, Kristiyan Kostadinov, Marc Wrobel, Mariia Subkov, Pawel Kozlowski, Sebastian, abergquist, dario-piotrowicz, onrails and vyom1611

<!-- CHANGELOG SPLIT MARKER -->

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about these updates again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox.

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzMi4xOTUuNSIsInVwZGF0ZWRJblZlciI6IjMyLjE5NS41In0=-->

Co-authored-by: cabr2-bot <cabr2.help@gmail.com>
Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1548
Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org>
Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Oct 10, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker area: common Issues related to APIs in the @angular/common package common: image directive target: minor This PR is targeted for the next minor release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants