Skip to content

docs: add storybook migrated badge #3690

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

Merged
castastrophe merged 2 commits into from
May 5, 2025
Merged

docs: add storybook migrated badge #3690

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2debdfd
chore: adds migrated status to preview.js
marissahuysentruyt May 2, 2025
b033f69
docs: add migrated status to components
marissahuysentruyt May 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .storybook/preview.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,11 @@ export const parameters = {
color: "#fff",
description: "Should not be used and will not receive updates.",
},
migrated: {
background: "rgb(84, 36, 219)",
Copy link
Copy Markdown
Collaborator Author

@marissahuysentruyt marissahuysentruyt May 2, 2025

Choose a reason for hiding this comment

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

I have the rgb for indigo-1100 in light mode. We could forseeably use tokens for the background & font color, but I saw we didn't do that with the deprecated status, so I elected not to do that for migrated.

Copy link
Copy Markdown
Contributor

@castastrophe castastrophe May 5, 2025

Choose a reason for hiding this comment

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

Yeah I think I tried once and there was a type-check in place for the tool so it throws an error.

color: "#fff",
description: "Migrated to Spectrum 2.",
},
},
},
// Set an empty object to avoid the "undefined" value in the ComponentDetails doc block
Expand Down
5 changes: 4 additions & 1 deletion components/actionbutton/stories/actionbutton.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,10 @@ export default {
story: {
height: "auto",
},
}
},
status: {
type: "migrated",
},
},
decorators: [
withDownStateDimensionCapture,
Expand Down
3 changes: 3 additions & 0 deletions components/actiongroup/stories/actiongroup.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,9 @@ export default {
},
packageJson,
metadata,
status: {
type: "migrated",
},
},
tags: ["migrated"],
};
Expand Down
3 changes: 3 additions & 0 deletions components/alertbanner/stories/alertbanner.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,9 @@ export default {
},
packageJson,
metadata,
status: {
type: "migrated",
},
},
tags: ["migrated"],
};
Expand Down
3 changes: 3 additions & 0 deletions components/avatar/stories/avatar.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@ export default {
},
packageJson,
metadata,
status: {
type: "migrated",
},
},
tags: ["migrated"],
};
Expand Down
3 changes: 3 additions & 0 deletions components/breadcrumb/stories/breadcrumb.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,9 @@ export default {
},
packageJson,
metadata,
status: {
type: "migrated",
}
},
};

Expand Down
3 changes: 3 additions & 0 deletions components/button/stories/button.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,9 @@ export default {
},
packageJson,
metadata,
status: {
type: "migrated",
},
},
decorators: [
withDownStateDimensionCapture,
Expand Down
3 changes: 3 additions & 0 deletions components/buttongroup/stories/buttongroup.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,9 @@ export default {
},
packageJson,
metadata,
status: {
type: "migrated",
},
},
tags: ["migrated"],
};
Expand Down
3 changes: 3 additions & 0 deletions components/checkbox/stories/checkbox.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,9 @@ export default {
},
packageJson,
metadata,
status: {
type: "migrated",
},
},
};

Expand Down
3 changes: 3 additions & 0 deletions components/closebutton/stories/closebutton.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ export default {
},
packageJson,
metadata,
status: {
type: "migrated",
},
},
tags: ["migrated"],
};
Expand Down
7 changes: 5 additions & 2 deletions components/coachmark/stories/coachmark.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ import metadata from "../dist/metadata.json";
import packageJson from "../package.json";
import { CoachMarkGroup } from "./coachmark.test.js";
import {
Template,
CoachmarkMenuStatesTemplate,
CoachMarkMediaOptionsTemplate,
CoachmarkMenuStatesTemplate,
Template,
Comment on lines -8 to +10
Copy link
Copy Markdown
Collaborator Author

@marissahuysentruyt marissahuysentruyt May 2, 2025

Choose a reason for hiding this comment

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

My linter keeps correcting these.

Copy link
Copy Markdown
Contributor

@castastrophe castastrophe May 5, 2025

Choose a reason for hiding this comment

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

Ah yes, alphabetical sorting is in our linting system I think.

} from "./template.js";

/**
Expand Down Expand Up @@ -99,6 +99,9 @@ export default {
height: "525px",
},
},
status: {
type: "migrated",
},
},
};

Expand Down
3 changes: 3 additions & 0 deletions components/colorarea/stories/colorarea.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,9 @@ export default {
},
packageJson,
metadata,
status: {
type: "migrated",
},
},
tags: ["migrated"],
};
Expand Down
3 changes: 3 additions & 0 deletions components/colorhandle/stories/colorhandle.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ export default {
},
packageJson,
metadata,
status: {
type: "migrated",
},
},
};

Expand Down
3 changes: 3 additions & 0 deletions components/colorloupe/stories/colorloupe.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ export default {
},
packageJson,
metadata,
status: {
type: "migrated",
},
},
tags: ["migrated"],
};
Expand Down
3 changes: 3 additions & 0 deletions components/colorslider/stories/colorslider.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,9 @@ export default {
},
packageJson,
metadata,
status: {
type: "migrated",
},
},
};

Expand Down
3 changes: 3 additions & 0 deletions components/colorwheel/stories/colorwheel.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,9 @@ export default {
},
packageJson,
metadata,
status: {
type: "migrated",
},
},
};

Expand Down
3 changes: 3 additions & 0 deletions components/dial/stories/dial.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ export default {
parameters: {
packageJson,
metadata,
status: {
type: "migrated",
},
},
tags: ["migrated"],
};
Expand Down
5 changes: 4 additions & 1 deletion components/dialog/stories/dialog.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { withUnderlayWrapper } from "@spectrum-css/preview/decorators";
import { disableDefaultModes } from "@spectrum-css/preview/modes";
import { isOpen, size } from "@spectrum-css/preview/types";
import { Template as Table } from "@spectrum-css/table/stories/template.js";
import { Template as Steplist } from "@spectrum-css/steplist/stories/template.js";
import { Template as Table } from "@spectrum-css/table/stories/template.js";
import { Template as Typography } from "@spectrum-css/typography/stories/template.js";
import metadata from "../dist/metadata.json";
import packageJson from "../package.json";
Expand Down Expand Up @@ -163,6 +163,9 @@ export default {
packageJson,
metadata,
layout: "fullscreen",
status: {
type: "migrated",
},
},
decorators: [
withUnderlayWrapper,
Expand Down
3 changes: 3 additions & 0 deletions components/divider/stories/divider.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@ export default {
},
packageJson,
metadata,
status: {
type: "migrated",
},
},
};

Expand Down
3 changes: 3 additions & 0 deletions components/dropzone/stories/dropzone.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@ export default {
},
packageJson,
metadata,
status: {
type: "migrated",
},
},
};

Expand Down
3 changes: 3 additions & 0 deletions components/fieldgroup/stories/fieldgroup.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,9 @@ export default {
},
packageJson,
metadata,
status: {
type: "migrated",
},
},
};

Expand Down
3 changes: 3 additions & 0 deletions components/fieldlabel/stories/fieldlabel.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ export default {
},
packageJson,
metadata,
status: {
type: "migrated",
},
},
tags: ["migrated"],
};
Expand Down
3 changes: 3 additions & 0 deletions components/form/stories/form.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,9 @@ export default {
parameters: {
packageJson,
metadata,
status: {
type: "migrated",
},
},
tags: ["migrated"],
};
Expand Down
3 changes: 3 additions & 0 deletions components/helptext/stories/helptext.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,9 @@ export default {
},
packageJson,
metadata,
status: {
type: "migrated",
},
},
};

Expand Down
3 changes: 3 additions & 0 deletions components/icon/stories/icon.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,9 @@ export default {
type: "figma",
url: "https://www.figma.com/design/9qeVZSJ9t0kv6r7njzgHx7/S2-%2F-Styles-visualizer-(WIP)?node-id=295-24257&t=ZC7fyaQ0VQYQ5VYM-1",
},
status: {
type: "migrated",
},
},
};

Expand Down
3 changes: 3 additions & 0 deletions components/illustratedmessage/stories/illustratedmessage.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,9 @@ export default {
},
packageJson,
metadata,
status: {
type: "migrated",
},
layout: "centered"
},
};
Expand Down
3 changes: 3 additions & 0 deletions components/infieldbutton/stories/infieldbutton.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@ export default {
},
packageJson,
metadata,
status: {
type: "migrated",
},
},
decorators: [
withDownStateDimensionCapture,
Expand Down
5 changes: 4 additions & 1 deletion components/infieldprogresscircle/stories/infieldprogresscircle.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,10 @@ export default {
},
packageJson,
metadata,
}
status: {
type: "migrated",
},
},
};

export const Default = InfieldProgressCircleGroup.bind({});
Expand Down
3 changes: 3 additions & 0 deletions components/inlinealert/stories/inlinealert.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,9 @@ export default {
},
packageJson,
metadata,
status: {
type: "migrated",
},
},
};

Expand Down
5 changes: 4 additions & 1 deletion components/link/stories/link.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,10 @@ export default {
},
packageJson,
metadata,
}
status: {
type: "migrated",
},
},
};

export const Default = LinkGroup.bind({});
Expand Down
3 changes: 3 additions & 0 deletions components/opacitycheckerboard/stories/opacitycheckerboard.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ export default {
parameters: {
packageJson,
metadata,
status: {
type: "migrated",
},
},
tags: ["migrated"],
};
Expand Down
3 changes: 3 additions & 0 deletions components/pagination/stories/pagination.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,9 @@ export default {
},
packageJson,
metadata,
status: {
type: "migrated",
},
},
tags: ["migrated"],
};
Expand Down
3 changes: 3 additions & 0 deletions components/picker/stories/picker.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,9 @@ export default {
downState: {
selectors: [".spectrum-Picker:not(:disabled, .is-disabled, .is-loading)"],
},
status: {
type: "migrated",
},
},
decorators: [
withDownStateDimensionCapture,
Expand Down
3 changes: 3 additions & 0 deletions components/popover/stories/popover.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,9 @@ export default {
},
packageJson,
metadata,
status: {
type: "migrated",
},
},
};

Expand Down
3 changes: 3 additions & 0 deletions components/progressbar/stories/progressbar.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,9 @@ export default {
},
packageJson,
metadata,
status: {
type: "migrated",
},
},
tags: ["migrated"],
};
Expand Down
3 changes: 3 additions & 0 deletions components/progresscircle/stories/progresscircle.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ export default {
},
packageJson,
metadata,
status: {
type: "migrated",
},
},
};

Expand Down
3 changes: 3 additions & 0 deletions components/radio/stories/radio.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ export default {
},
packageJson,
metadata,
status: {
type: "migrated",
},
},
};

Expand Down
Loading
Loading