fixing badges in polaris (Shopify#7769)

<!--
  ☝️How to write a good PR title:
- Prefix it with [ComponentName] (if applicable), for example: [Button]
  - Start with a verb, for example: Add, Delete, Improve, Fix…
  - Give as much context as necessary and as little as possible
  - Prefix it with [WIP] while it’s a work in progress
-->

### WHY are these changes introduced?

Fixes https://github.com/Shopify/core-workflows/issues/516
<!--
  Context about the problem that’s being addressed.
-->

### WHAT is this pull request doing?
This PR changes the spacing of some polaris components, specifcally the
badges when there is a secondary item involved. After the merging of
this pr, the Polaris Navigation.Item component will be successfully
updated to follow our new spacing parameters and the right-aligned icons
(top-level nav items, pinned item's secondary actions, pin button) will
still be correctly aligned after the Polaris update.

<!--
  Summary of the changes committed.

Before / after screenshots are appreciated for UI changes. Make sure to
include alt text that describes the screenshot.

If you include an animated gif showing your change, wrapping it in a
details tag is recommended. Gifs usually autoplay, which can cause
accessibility issues for people reviewing your PR:

    <details>
      <summary>Summary of your gif(s)</summary>
      <img src="..." alt="Description of what the gif shows">
    </details>
-->

<!-- ℹ️ Delete the following for small / trivial changes -->

### How to 🎩

🖥 [Local development
instructions](https://github.com/Shopify/polaris/blob/main/README.md#local-development)
🗒 [General tophatting
guidelines](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md)
📄 [Changelog
guidelines](https://github.com/Shopify/polaris/blob/main/.github/CONTRIBUTING.md#changelog)
- Go on the polaris landing page and you will be able to see the
different components. The spacing should look correct now.
<!--
  Give as much information as needed to experiment with the component
  in the playground.
-->

<details>
<summary>Copy-paste this code in
<code>playground/Playground.tsx</code>:</summary>

```jsx
import React from 'react';
import {Page} from '../src';

export function Playground() {
  return (
    <Page title="Playground">
      {/* Add the code you want to test in here */}
    </Page>
  );
}
```

</details>

### 🎩 checklist

- [ ] Tested on
[mobile](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md#cross-browser-testing)
- [ ] Tested on [multiple
browsers](https://help.shopify.com/en/manual/shopify-admin/supported-browsers)
- [ ] Tested for
[accessibility](https://github.com/Shopify/polaris/blob/main/documentation/Accessibility%20testing.md)
- [ ] Updated the component's `README.md` with documentation changes
- [ ] [Tophatted
documentation](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting%20documentation.md)
changes in the style guide

Author: nabihaalikhan

.changeset/tender-kings-approve.md

@@ -0,0 +1,5 @@
+---
+'@shopify/polaris': patch
+---
+
+Updated badge spacing to right align with secondary action icons

polaris-react/src/components/Navigation/Navigation.scss

@@ -159,12 +159,17 @@ $disabled-fade: 0.6;
   margin-left: var(--p-space-2);
   display: inline-flex;
   margin-top: var(--p-space-2);
+  margin-right: var(--p-space-2);
 
   @media #{$p-breakpoints-md-up} {
     margin-top: var(--p-space-1);
   }
 }
 
+.ListItem-hasAction .Badge {
+  margin-right: 0;
+}
+
 .Icon {
   @include nav-item-icon-attributes;
 }

polaris-react/src/components/Navigation/Navigation.stories.tsx

@@ -606,3 +606,95 @@ export function UsingMajorIcons() {
     </Frame>
   );
 }
+
+export function WithBadgeAndSecondaryAction() {
+  return (
+    <Frame>
+      <Navigation location="/">
+        <Navigation.Section
+          items={[
+            {
+              url: '/path/to/place',
+              label: 'Home',
+              icon: HomeMinor,
+              secondaryAction: {
+                url: '/path/to/place/view',
+                accessibilityLabel: 'View your online store',
+                icon: ViewMinor,
+                tooltip: {
+                  content: 'View your online store',
+                },
+              },
+            },
+            {
+              url: '/path/to/place',
+              label: 'Orders',
+              icon: OrdersMinor,
+              badge: '15',
+              subNavigationItems: [
+                {
+                  url: '/admin/orders/collections',
+                  disabled: false,
+                  selected: false,
+                  label: 'Collections',
+                },
+                {
+                  url: '/admin/orders/inventory',
+                  disabled: false,
+                  label: 'Inventory',
+                },
+              ],
+            },
+            {
+              url: '/path/to/place',
+              label: 'Marketing',
+              icon: MarketingMinor,
+              badge: '15',
+              secondaryAction: {
+                url: '/path/to/place/view',
+                accessibilityLabel: 'View your online store',
+                icon: ViewMinor,
+                tooltip: {
+                  content: 'View your online store',
+                },
+              },
+              subNavigationItems: [
+                {
+                  url: '/admin/analytics/collections',
+                  disabled: false,
+                  selected: false,
+                  label: 'Reports',
+                },
+                {
+                  url: '/admin/analytics/inventory',
+                  disabled: false,
+                  label: 'Live view',
+                },
+              ],
+            },
+            {
+              url: '/admin/products',
+              label: 'Products',
+              icon: ProductsMinor,
+              selected: true,
+              subNavigationItems: [
+                {
+                  url: '/?path=/story/all-components-navigation--navigation-with-multiple-secondary-navigations',
+                  disabled: false,
+                  selected: false,
+                  label: 'Collections',
+                },
+                {
+                  url: '/admin/products/inventory',
+                  disabled: false,
+                  selected: true,
+                  label: 'Inventory',
+                },
+              ],
+            },
+          ]}
+        />
+      </Navigation>
+    </Frame>
+  );
+}