Skip to content

Conversation

@davidlj95
Copy link
Contributor

@davidlj95 davidlj95 commented Aug 3, 2024

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • angular.io application / infrastructure changes
  • Other... Please describe:

What is the current behavior?

Docs about enabledBlocking option for the initialNavigation router's configuration talk about being mandatory for server side rendering (SSR) to work.

However, this is no longer configured by Angular CLI in new Angular projects since introducing hydration in v17

Issue Number: N/A

What is the new behavior?

Update recommendation to just use that configuration if hydration isn't configured for users that haven't upgraded to use it yet or aren't using it because of another reason

Docs updated (that could find relate to this):

  • InitialNavigation enum in provide_router.ts
  • withEnabledBlockingInitialNavigation() feature method in provide_router.ts
  • InitialNavigation type in router_config.ts
  • ExtraOptions interface in router_config.ts

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Thought about this by wondering about a StackOverflow question

@pullapprove pullapprove bot requested a review from AndrewKushnir August 3, 2024 11:24
@angular-robot angular-robot bot added area: docs Related to the documentation area: router labels Aug 3, 2024
@ngbot ngbot bot modified the milestone: Backlog Aug 3, 2024
@AndrewKushnir AndrewKushnir added action: review The PR is still awaiting reviews from at least one requested reviewer target: patch This PR is targeted for the next patch release labels Aug 6, 2024
Copy link
Contributor

@AndrewKushnir AndrewKushnir left a comment

Choose a reason for hiding this comment

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

@davidlj95 thanks for improving Angular docs!

@AndrewKushnir AndrewKushnir added action: merge The PR is ready for merge by the caretaker and removed action: review The PR is still awaiting reviews from at least one requested reviewer labels Aug 6, 2024
@thePunderWoman thePunderWoman added the merge: caretaker note Alert the caretaker performing the merge to check the PR for an out of normal action needed or note label Aug 7, 2024
@thePunderWoman
Copy link
Contributor

Caretaker note: this is docs only and safe to merge without a presubmit.

thePunderWoman pushed a commit that referenced this pull request Aug 7, 2024
@thePunderWoman
Copy link
Contributor

This PR was merged into the repository by commit d465061.

The changes were merged into the following branches: main, 18.1.x

@davidlj95 davidlj95 deleted the update-router-enabledblocking-docs branch August 8, 2024 09:39
@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 Sep 8, 2024
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: docs Related to the documentation area: router merge: caretaker note Alert the caretaker performing the merge to check the PR for an out of normal action needed or note target: patch This PR is targeted for the next patch release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants