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.

Sign up for GitHub

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

Jump to bottom

docs: standardize examples using timers for SSR compatibility #48480

Closed
wants to merge 3 commits into from
Closed

docs: standardize examples using timers for SSR compatibility #48480

wants to merge 3 commits into from

Conversation

douglasdnzcarvalho
Copy link
Contributor

@douglasdnzcarvalho douglasdnzcarvalho commented Dec 13, 2022 •
edited by alan-agius4

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?

Some examples use the window object directly or have the return type as number, which makes them non-SSR-compliance and the documentation non-standard.

Closes #48047

What is the new behavior?

Documentation becomes standardized and SSR-compliant.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Also discussed os this PRs: #48048 and #48459

@ngbot ngbot bot added this to the Backlog milestone Dec 13, 2022
@douglasdnzcarvalho douglasdnzcarvalho mentioned this pull request Dec 14, 2022
Closed
14 tasks
AndrewKushnir
AndrewKushnir reviewed Dec 14, 2022
View reviewed changes
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.

@douglasdnzcarvalho thanks for the PR! I've left a comment with a proposal to avoid anys in the code. Thank you.

aio/content/examples/component-interaction/src/app/countdown-timer.component.ts Outdated Show resolved Hide resolved
@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 Dec 14, 2022
AndrewKushnir
AndrewKushnir approved these changes Dec 15, 2022
View reviewed changes
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.

@douglasdnzcarvalho thanks for addressing the feedback 👍

@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 Dec 15, 2022
@AndrewKushnir AndrewKushnir removed the request for review from alxhub December 15, 2022 22:56
@pullapprove pullapprove bot requested a review from alxhub December 15, 2022 22:56
@alan-agius4 alan-agius4 added action: review The PR is still awaiting reviews from at least one requested reviewer and removed action: merge The PR is ready for merge by the caretaker labels Jan 10, 2023
@alan-agius4 alan-agius4 requested review from dylhunn and atscott and removed request for dylhunn January 10, 2023 20:30
@alan-agius4 alan-agius4 mentioned this pull request Jan 10, 2023
Closed
14 tasks
@jessicajaniuk jessicajaniuk 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 Apr 18, 2023
@pullapprove pullapprove bot requested a review from alxhub April 18, 2023 15:59
@jessicajaniuk jessicajaniuk requested review from dylhunn and removed request for alxhub April 18, 2023 16:51
dylhunn
dylhunn approved these changes Apr 18, 2023
View reviewed changes
Copy link
Contributor

@dylhunn dylhunn left a comment •
edited

Choose a reason for hiding this comment

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

reviewed-for: fw-core, docs-observables, public-api

AndrewKushnir
AndrewKushnir approved these changes Apr 18, 2023
View reviewed changes
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.

Reviewed-for: public-api

@jessicajaniuk
Copy link
Contributor

This PR was merged into the repository by commit fb1161f.

jessicajaniuk pushed a commit that referenced this pull request Apr 18, 2023
@douglasdnzcarvalho @thePunderWoman
docs: type clearTimer function as VoidFunction or undefined (#48480)
fb1161f 
PR Close #48480
jessicajaniuk pushed a commit that referenced this pull request Apr 18, 2023
@douglasdnzcarvalho @thePunderWoman
docs: standardize examples using timers for SSR compatibility (#48480)
3d07ec1 
PR Close #48480
jessicajaniuk pushed a commit that referenced this pull request Apr 18, 2023
@douglasdnzcarvalho @thePunderWoman
docs: type clearTimer function as VoidFunction or undefined (#48480)
7e286c5 
PR Close #48480
jessicajaniuk pushed a commit that referenced this pull request Apr 18, 2023
@douglasdnzcarvalho @thePunderWoman
docs: standardize examples using timers for SSR compatibility (#48480)
81ad3c6 
PR Close #48480
jessicajaniuk pushed a commit that referenced this pull request Apr 18, 2023
@douglasdnzcarvalho @thePunderWoman
docs: type clearTimer function as VoidFunction or undefined (#48480)
48c946f 
PR Close #48480
@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 May 19, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@dylhunn dylhunn dylhunn approved these changes

@alan-agius4 alan-agius4 alan-agius4 approved these changes

@AndrewKushnir AndrewKushnir AndrewKushnir approved these changes

Assignees
No one assigned
Labels
action: merge The PR is ready for merge by the caretaker target: patch This PR is targeted for the next patch release
Projects
None yet
Milestone
Backlog
Development

Successfully merging this pull request may close these issues.

Error in stackblitz for Dynamic component loader
5 participants
@douglasdnzcarvalho @jessicajaniuk @dylhunn @alan-agius4 @AndrewKushnir