[⏪ Reverted] fix(PageLayout): Remove `warning` for the deprecated `position` prop #3545

broccolinisoup · 2023-07-21T00:30:02Z

deprecating PageLayout.Pane PR introduces a warning then the prop is used and although this is a good practise, it is not dotcom-friendly. Because it fails dotcom tests since warnings are not expected.

For the time being, we are settling for removing the warnings and only going with the TS deprecated notice. This PR removes the warning and adds the TS deprecated notice.

For more context, please see the slack thread here (GitHub stuff only)

Screenshots

No visual change

Merge checklist

Take a look at the What we look for in reviews section of the contributing guidelines for more information on how we review PRs.

changeset-bot · 2023-07-21T00:30:06Z

⚠️ No Changeset found

Latest commit: d20aa6e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes changesets to release 1 package

Name	Type
@primer/react	Patch

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

github-actions · 2023-07-21T00:33:56Z

size-limit report 📦

Path	Size
dist/browser.esm.js	102.4 KB (-0.09% 🔽)
dist/browser.umd.js	102.99 KB (-0.09% 🔽)

This reverts commit bdbcfd1.

src/PageLayout/PageLayout.tsx

src/SplitPageLayout/SplitPageLayout.test.tsx

This reverts commit 5f94786.

This reverts commit 843e304.

joshblack

+1 for TS @deprecated, I'd vote for just removing the warning in console personally and only use @deprecated till we find a better pattern for warnings here.

Here's the snippets we've been using for the changelog if it helps for messaging! (Also let me know if they're incorrect 😅)

  /**
   * @deprecated Use source order instead of relying on the `position` prop
   *
   * Before:
   * ```
   * <PageLayout>
   *   <PageLayout.Content />
   *   <PageLayout.Pane position="start" />
   * </PageLayout>
   * ```
   *
   * After:
   * ```
   * <PageLayout>
   *   <PageLayout.Pane />
   *   <PageLayout.Content />
   * </PageLayout>
   * ```
   */

…n` prop (#3545)" This reverts commit 430a203.

…3589) * Revert 57c4bdf * Create nervous-dolls-dream.md * Update nervous-dolls-dream.md * Revert "fix(PageLayout): Remove `warning` for the deprecated `position` prop (#3545)" This reverts commit 430a203. * linter caught a bad merge! * Remove reverted changeset * copy old test * Update nervous-dolls-dream.md

Add deprecated notice and run console warn only in DEV

24d0270

broccolinisoup added the skip changeset This change does not need a changelog label Jul 21, 2023

broccolinisoup temporarily deployed to github-pages July 21, 2023 00:36 — with GitHub Actions Inactive

github-actions bot temporarily deployed to storybook-preview-3545 July 21, 2023 00:36 Inactive

run when the env is not test

6cb8bbe

broccolinisoup temporarily deployed to github-pages July 21, 2023 01:20 — with GitHub Actions Inactive

github-actions bot temporarily deployed to storybook-preview-3545 July 21, 2023 01:21 Inactive

Revert "Toggle switch a11y take3 (#3510)"

5f94786

This reverts commit bdbcfd1.

broccolinisoup temporarily deployed to github-pages July 21, 2023 01:39 — with GitHub Actions Inactive

github-actions bot temporarily deployed to storybook-preview-3545 July 21, 2023 01:40 Inactive

broccolinisoup temporarily deployed to github-pages July 21, 2023 02:26 — with GitHub Actions Inactive

github-actions bot temporarily deployed to storybook-preview-3545 July 21, 2023 02:26 Inactive

take the list changes back for underlinenav

843e304

broccolinisoup force-pushed the bs/pagelayout-position-deprecation branch from 30e394a to 843e304 Compare July 21, 2023 03:53

broccolinisoup temporarily deployed to github-pages July 21, 2023 04:02 — with GitHub Actions Inactive

github-actions bot temporarily deployed to storybook-preview-3545 July 21, 2023 04:02 Inactive

broccolinisoup temporarily deployed to github-pages July 21, 2023 04:10 — with GitHub Actions Inactive

github-actions bot temporarily deployed to storybook-preview-3545 July 21, 2023 04:10 Inactive

lint and test fix

fdcd281

broccolinisoup force-pushed the bs/pagelayout-position-deprecation branch from 3c5224d to fdcd281 Compare July 21, 2023 04:29

broccolinisoup temporarily deployed to github-pages July 21, 2023 04:35 — with GitHub Actions Inactive

github-actions bot temporarily deployed to storybook-preview-3545 July 21, 2023 04:35 Inactive

broccolinisoup changed the title ~~Add deprecated notice and run console warn only in DEV~~ fix(integration): do not run console warn in test PageLayout & revert ToggleSwitch & fix markup structure for UnderlineNav Jul 21, 2023

siddharthkp reviewed Jul 21, 2023

View reviewed changes

src/PageLayout/PageLayout.tsx Outdated Show resolved Hide resolved

siddharthkp reviewed Jul 21, 2023

View reviewed changes

src/SplitPageLayout/SplitPageLayout.test.tsx Outdated Show resolved Hide resolved

broccolinisoup added 3 commits July 25, 2023 15:30

Add back "Toggle switch a11y take3 (#3510)"

ec797e1

This reverts commit 5f94786.

Revert "take the list changes back for underlinenav"

ec1306c

This reverts commit 843e304.

fix after revert commit

c432281

broccolinisoup changed the title ~~fix(integration): do not run console warn in test PageLayout & revert ToggleSwitch & fix markup structure for UnderlineNav~~ fix(integration): do not run console warn in test PageLayout Jul 25, 2023

github-actions bot temporarily deployed to storybook-preview-3545 July 25, 2023 05:39 Inactive

broccolinisoup temporarily deployed to github-pages July 25, 2023 05:41 — with GitHub Actions Inactive

github-actions bot temporarily deployed to storybook-preview-3545 July 25, 2023 05:41 Inactive

joshblack approved these changes Jul 26, 2023

View reviewed changes

joshblack mentioned this pull request Jul 26, 2023

Release Tracking #3558

Closed

4 tasks

broccolinisoup marked this pull request as ready for review July 26, 2023 21:20

broccolinisoup requested review from a team and siddharthkp July 26, 2023 21:20

broccolinisoup added 2 commits July 27, 2023 10:05

Merge branch 'main' into bs/pagelayout-position-deprecation

8ac4bc4

remove console warning and update docs and changeset

817716e

broccolinisoup changed the title ~~fix(integration): do not run console warn in test PageLayout~~ fix(PageLayout): Remove warning for the deprecated position prop Jul 27, 2023

broccolinisoup temporarily deployed to github-pages July 27, 2023 00:27 — with GitHub Actions Inactive

github-actions bot temporarily deployed to storybook-preview-3545 July 27, 2023 00:28 Inactive

fix changeset and update prop docs

d20aa6e

broccolinisoup deployed to github-pages July 27, 2023 00:45 — with GitHub Actions View deployment

github-actions bot deployed to storybook-preview-3545 July 27, 2023 00:46 View deployment

broccolinisoup added this pull request to the merge queue Jul 27, 2023

Merged via the queue into main with commit 430a203 Jul 27, 2023

broccolinisoup deleted the bs/pagelayout-position-deprecation branch July 27, 2023 01:08

siddharthkp added a commit that referenced this pull request Aug 4, 2023

Revert "fix(PageLayout): Remove warning for the deprecated `positio…

5790b5d

…n` prop (#3545)" This reverts commit 430a203.

This was referenced Aug 4, 2023

Revert #3389 (PageLayout.Pane: Undo deprecation for position prop) #3589

Merged

Release Tracking #3580

Closed

siddharthkp changed the title ~~fix(PageLayout): Remove warning for the deprecated position prop~~ [⚠️ Reverted] fix(PageLayout): Remove warning for the deprecated position prop Aug 7, 2023

siddharthkp changed the title ~~[⚠️ Reverted] fix(PageLayout): Remove warning for the deprecated position prop~~ [⏪ Reverted] fix(PageLayout): Remove warning for the deprecated position prop Aug 7, 2023

siddharthkp mentioned this pull request Aug 7, 2023

PageLayout: add @deprecated notice to PageLayout.Pane position prop #3597

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[⏪ Reverted] fix(PageLayout): Remove `warning` for the deprecated `position` prop #3545

[⏪ Reverted] fix(PageLayout): Remove `warning` for the deprecated `position` prop #3545

Uh oh!

broccolinisoup commented Jul 21, 2023 •

edited

Loading

Uh oh!

changeset-bot bot commented Jul 21, 2023 •

edited

Loading

Uh oh!

github-actions bot commented Jul 21, 2023 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

joshblack left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

[⏪ Reverted] fix(PageLayout): Remove warning for the deprecated position prop #3545

[⏪ Reverted] fix(PageLayout): Remove warning for the deprecated position prop #3545

Uh oh!

Conversation

broccolinisoup commented Jul 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Screenshots

Merge checklist

Uh oh!

changeset-bot bot commented Jul 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

github-actions bot commented Jul 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

size-limit report 📦

Uh oh!

Uh oh!

Uh oh!

joshblack left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

[⏪ Reverted] fix(PageLayout): Remove `warning` for the deprecated `position` prop #3545

[⏪ Reverted] fix(PageLayout): Remove `warning` for the deprecated `position` prop #3545

broccolinisoup commented Jul 21, 2023 •

edited

Loading

changeset-bot bot commented Jul 21, 2023 •

edited

Loading

github-actions bot commented Jul 21, 2023 •

edited

Loading