Skip to content

Commit fa56444

Browse files
author
Melissa Thompson
authored
docs(cyclebutton): setup for deprecation (#2536)
* docs(deprecation): update link example from html to markdown * docs(cyclebutton): setup for deprecation
1 parent ab72d5d commit fa56444

File tree

3 files changed

+8
-12
lines changed

3 files changed

+8
-12
lines changed

.storybook/guides/deprecation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Before removing the component from the codebase, we need to flag the component a
4747
```yaml
4848
name: Quick actions
4949
status: Deprecated
50-
deprecationNotice: Use an <a href="actionbar.html">action bar</a> to allow users to perform actions on either a single or multiple items at the same time, instead.
50+
deprecationNotice: Use an [action bar](actionbar.html) to allow users to perform actions on either a single or multiple items at the same time, instead.
5151
```
5252
4. Commit these changes and open a pull request to the main branch. i.e., `git commit -m "chore(quickaction): prepare for deprecation"`.
5353
5. Once the pull request is approved, merge the changes into the main branch and publish the update to the package registry.

components/cyclebutton/metadata/cyclebutton.yml

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
name: Cycle button
2-
sections:
3-
- name: Migration Guide
4-
description: |
5-
### Change workflow icon size to medium
6-
Replace `.spectrum-Icon--sizeS` with `.spectrum-Icon--sizeM`.
2+
status: Deprecated
3+
deprecationNotice: Use the [quiet variant of action button](actionbutton.html#quiet) with the appropriate icon(s) instead. Any icon swapping that happens on-click/on-key should be handled by the implementation.
74
examples:
85
- id: cyclebutton
96
name: Standard

components/cyclebutton/stories/cyclebutton.stories.js

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
// Import the component markup template
2-
import { Template } from "./template";
2+
import { Template } from "@spectrum-css/cyclebutton/stories/template";
33

4-
import { default as IconStories } from "@spectrum-css/icon/stories/icon.stories.js";
54
import { default as ActionButtonStories } from "@spectrum-css/actionbutton/stories/actionbutton.stories.js";
5+
import { default as IconStories } from "@spectrum-css/icon/stories/icon.stories.js";
66

77
export default {
8-
title: "Components/Cycle button",
8+
title: "Deprecated/Cycle button",
99
description:
1010
"The Cycle button component is an action button that cycles through two different icons, a play that then changes to a pause, for example.",
1111
component: "CycleButton",
@@ -35,10 +35,9 @@ export default {
3535
actions: {
3636
handles: [...(ActionButtonStories?.parameters?.actions?.handles ?? [])],
3737
},
38+
chromatic: { disable: true },
3839
status: {
39-
type: process.env.MIGRATED_PACKAGES.includes("cyclebutton")
40-
? "migrated"
41-
: undefined,
40+
type: "deprecated"
4241
},
4342
},
4443
};

0 commit comments

Comments
 (0)