Skip to content
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.

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

docs(cyclebutton): setup for deprecation #2536

Merged
merged 2 commits into from
Feb 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .storybook/guides/deprecation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Before removing the component from the codebase, we need to flag the component a
```yaml
name: Quick actions
status: Deprecated
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.
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.
```
4. Commit these changes and open a pull request to the main branch. i.e., `git commit -m "chore(quickaction): prepare for deprecation"`.
5. Once the pull request is approved, merge the changes into the main branch and publish the update to the package registry.
Expand Down
7 changes: 2 additions & 5 deletions components/cyclebutton/metadata/cyclebutton.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
name: Cycle button
sections:
- name: Migration Guide
description: |
### Change workflow icon size to medium
Replace `.spectrum-Icon--sizeS` with `.spectrum-Icon--sizeM`.
status: Deprecated
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.
examples:
- id: cyclebutton
name: Standard
Expand Down
11 changes: 5 additions & 6 deletions components/cyclebutton/stories/cyclebutton.stories.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
// Import the component markup template
import { Template } from "./template";
import { Template } from "@spectrum-css/cyclebutton/stories/template";

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

export default {
title: "Components/Cycle button",
title: "Deprecated/Cycle button",
description:
"The Cycle button component is an action button that cycles through two different icons, a play that then changes to a pause, for example.",
component: "CycleButton",
Expand Down Expand Up @@ -35,10 +35,9 @@ export default {
actions: {
handles: [...(ActionButtonStories?.parameters?.actions?.handles ?? [])],
},
chromatic: { disable: true },
status: {
type: process.env.MIGRATED_PACKAGES.includes("cyclebutton")
? "migrated"
: undefined,
type: "deprecated"
},
},
};
Expand Down
Loading