chore(documentation-v7): migrate the internet header component stories #1822

alizedebray · 2023-08-17T09:59:36Z

No description provided.

…tories # Conflicts: # packages/documentation-v7/public/assets/config/test-configuration.json

…tories

changeset-bot · 2023-08-17T09:59:38Z

⚠️ No Changeset found

Latest commit: 54edf58

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 no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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

…tories

swisspost-bot · 2023-08-17T10:04:54Z

Preview environment ready: https://preview-1822--swisspost-design-system-next-v7.netlify.app
Preview environment ready: https://preview-1822--swisspost-design-system-next.netlify.app

swisspost-bot · 2023-08-17T10:05:26Z

Preview environment ready: https://preview-1822--swisspost-design-system-next-v7.netlify.app

alizedebray · 2023-08-17T10:10:30Z

packages/documentation-v7/src/stories/internet-header/components/internet-header.docs.mdx

+<Canvas of={InternetHeaderStories.Default} />
+
+<div className="hide-col-default">
+  <ArgTypes of={InternetHeaderStories.Default} />


I used ArgTypes instead of Controls here because currently controls don't work on iframe demos, but an iframe is needed for the logo animation to work properly.

packages/documentation-v7/src/stories/internet-header/migration-guide.docs.mdx

packages/documentation-v7/src/stories/internet-header/getting-started.docs.mdx

imagoiq · 2023-08-17T12:20:43Z

packages/documentation-v7/src/stories/internet-header/components/internet-header.stories.tsx

+// TODO: move to utils
+const getAttributes = (args: Args, condition?: (arg: any) => boolean): Args => {
+  const attrs: { [key: string]: any } = {};
+
+  for (const key in args) {
+    if (args.hasOwnProperty(key) && condition && condition(args[key])) {
+      const attrKey = key.replace(/([a-z])([A-Z])/g, '$1-$2').toLowerCase();
+
+      // Cast boolean false to string so it's displayed in the docs code block. False values are otherwise omitted
+      attrs[attrKey] = args[key] === false ? 'false' : args[key];
+      if (typeof args[key] === 'object') {
+        attrs[attrKey] = JSON.stringify(args[key]);
+      }
+    }
+  }
+
+  return attrs;
+};


I think the move can be part of this PR

imagoiq · 2023-08-17T12:23:22Z

packages/documentation-v7/.storybook/preview.ts

@@ -55,7 +46,6 @@ const preview: Preview = {
      },
      components: resetComponents,
      extractArgTypes,
-      extractComponentDescription,


Not sure if this line is correct or not or if you need to remove the import

…n-guide.docs.mdx Co-authored-by: Loïc Fürhoff <12294151+imagoiq@users.noreply.github.com>

sonarcloud · 2023-08-17T14:15:28Z

Please retry analysis of this Pull-Request directly on SonarCloud.

gfellerph · 2023-08-17T14:25:36Z

Created tickets for all open points

alizedebray and others added 8 commits August 3, 2023 16:51

chore(documentation-v7): add internet-header stories

c5e25e5

feat: use docs.json for generated controls

0c05776

Merge branch 'main' into 1700-migrate-the-internet-header-component-s…

e9109a1

…tories # Conflicts: # packages/documentation-v7/public/assets/config/test-configuration.json

chore(documentation-v7): remove docs-json for internet header

f0a43c8

chore(documentation-v7): add internet header stories to the docs

8b701dd

Merge branch 'main' into 1700-migrate-the-internet-header-component-s…

9008c23

…tories

fix(documentation-v7): add proper typings

50b5c9e

fix(documentation-v7): show stories in docs

04acbe3

alizedebray linked an issue Aug 17, 2023 that may be closed by this pull request

Migrate the Internet-Header component stories #1700

Closed

alizedebray requested review from gfellerph, oliverschuerch and imagoiq as code owners August 17, 2023 09:59

alizedebray and others added 3 commits August 17, 2023 11:59

Merge branch 'main' into 1700-migrate-the-internet-header-component-s…

3448b39

…tories

fix(documentation-v7): remove copyrights

20dada4

fix(documentation-v7): use ArgTypes instead of Controls

22131aa

alizedebray commented Aug 17, 2023

View reviewed changes

gfellerph added the 📦 migrations Related to the @swisspost/design-system-migrations package label Aug 17, 2023

gfellerph mentioned this pull request Aug 17, 2023

Internet Header logo animation does not work outside of an iFrame in Storybook #1825

Closed

imagoiq approved these changes Aug 17, 2023

View reviewed changes

gfellerph and others added 5 commits August 17, 2023 16:14

Update packages/documentation-v7/src/stories/internet-header/migratio…

6d9cd3f

…n-guide.docs.mdx Co-authored-by: Loïc Fürhoff <12294151+imagoiq@users.noreply.github.com>

Update packages/documentation-v7/src/stories/internet-header/migratio…

de06430

…n-guide.docs.mdx Co-authored-by: Loïc Fürhoff <12294151+imagoiq@users.noreply.github.com>

Update packages/documentation-v7/src/stories/internet-header/migratio…

d577bff

…n-guide.docs.mdx Co-authored-by: Loïc Fürhoff <12294151+imagoiq@users.noreply.github.com>

Update packages/documentation-v7/src/stories/internet-header/migratio…

545717f

…n-guide.docs.mdx Co-authored-by: Loïc Fürhoff <12294151+imagoiq@users.noreply.github.com>

Update packages/documentation-v7/src/stories/internet-header/migratio…

54edf58

…n-guide.docs.mdx Co-authored-by: Loïc Fürhoff <12294151+imagoiq@users.noreply.github.com>

This was referenced Aug 17, 2023

Fix internet header documentation badges #1828

Closed

Move getAttributes function to utils #1829

Closed

gfellerph approved these changes Aug 17, 2023

View reviewed changes

gfellerph merged commit 4422186 into main Aug 17, 2023
10 checks passed

gfellerph deleted the 1700-migrate-the-internet-header-component-stories branch August 17, 2023 14:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(documentation-v7): migrate the internet header component stories #1822

chore(documentation-v7): migrate the internet header component stories #1822

alizedebray commented Aug 17, 2023

changeset-bot bot commented Aug 17, 2023 •

edited

swisspost-bot commented Aug 17, 2023 •

edited

swisspost-bot commented Aug 17, 2023 •

edited

alizedebray Aug 17, 2023 •

edited

imagoiq Aug 17, 2023

imagoiq Aug 17, 2023

sonarcloud bot commented Aug 17, 2023

gfellerph commented Aug 17, 2023

chore(documentation-v7): migrate the internet header component stories #1822

chore(documentation-v7): migrate the internet header component stories #1822

Conversation

alizedebray commented Aug 17, 2023

changeset-bot bot commented Aug 17, 2023 • edited

⚠️ No Changeset found

swisspost-bot commented Aug 17, 2023 • edited

swisspost-bot commented Aug 17, 2023 • edited

alizedebray Aug 17, 2023 • edited

Choose a reason for hiding this comment

imagoiq Aug 17, 2023

Choose a reason for hiding this comment

imagoiq Aug 17, 2023

Choose a reason for hiding this comment

sonarcloud bot commented Aug 17, 2023

gfellerph commented Aug 17, 2023

changeset-bot bot commented Aug 17, 2023 •

edited

swisspost-bot commented Aug 17, 2023 •

edited

swisspost-bot commented Aug 17, 2023 •

edited

alizedebray Aug 17, 2023 •

edited