Skip to content

Commit e98eb30

Browse files
author
Melissa Thompson
committed
chore(searchwithin): setup for deprecation
1 parent 7617146 commit e98eb30

File tree

2 files changed

+6
-23
lines changed

2 files changed

+6
-23
lines changed

components/searchwithin/metadata/searchwithin.yml

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,7 @@
11
name: Search within
2+
status: Deprecated
3+
deprecationNotice: Use a [search field](search.html) with a separate control to filter the search instead.
24
description: Override the width of the component where necessary.
3-
sections:
4-
- name: Migration Guide
5-
description: |
6-
### Component renamed
7-
Since Dropdown is now known as Picker, Replace all `.spectrum-Dropdown*` classnames with `.spectrum-Picker*` and replace all `.spectrum-SearchWithin-dropdown` with `.spectrum-SearchWithin-picker`.
8-
9-
### New Picker markup
10-
Combobox now uses `.spectrum-Picker`. See [Picker migration guide](picker.html#migrationguide) for details.
11-
12-
Since Picker's markup has changed, `.spectrum-SearchWithin-pickerTrigger` is no longer required.
13-
14-
### New ClearButton classes
15-
The `.spectrum-SearchWithin-clearButton` class is now required on the `.spectrum-ClearButton` element.
16-
17-
### New ClearButton markup
18-
See the [ClearButton migration guide](clearbutton.html#migrationguide) for more information.
19-
205
examples:
216
- id: searchwithin
227
name: Standard

components/searchwithin/stories/searchwithin.stories.js

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

44
import { default as PickerStories } from "@spectrum-css/picker/stories/picker.stories.js";
55
const ignoreProps = ["rootClass", "position", "isRounded"];
66

77
export default {
8-
title: "Components/Search within",
9-
description: "The Search within component is...",
8+
title: "Deprecated/Search within",
109
component: "SearchWithin",
1110
argTypes: {
1211
...Object.entries(PickerStories.argTypes).reduce((acc, [key, value]) => {
@@ -36,10 +35,9 @@ export default {
3635
actions: {
3736
handles: [],
3837
},
38+
chromatic: { disable: true },
3939
status: {
40-
type: process.env.MIGRATED_PACKAGES.includes("searchwithin")
41-
? "migrated"
42-
: undefined,
40+
type: "deprecated"
4341
},
4442
},
4543
};

0 commit comments

Comments
 (0)