Skip to content

Commit

Permalink
deprecated
Browse files Browse the repository at this point in the history
  • Loading branch information
@scomea
scomea committed Jul 5, 2023
1 parent a14c6c7 commit 3f538e1
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 29 deletions.
2 changes: 2 additions & 0 deletions packages/web-components/fast-foundation/docs/api-report.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1527,9 +1527,11 @@ export class FASTPicker extends FormAssociatedPicker {
disconnectedCallback(): void;
// @internal
filteredOptionsList: string[];
// @deprecated (undocumented)
filterQuery: boolean;
// (undocumented)
protected filterQueryChanged(): void;
// @deprecated (undocumented)
filterSelected: boolean;
// (undocumented)
protected filterSelectedChanged(): void;
Expand Down
54 changes: 27 additions & 27 deletions packages/web-components/fast-foundation/src/picker/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -189,33 +189,33 @@ export class FASTTextField extends TextField {}

#### Fields

| Name | Privacy | Type | Default | Description | Inherited From |
| ---------------------------- | ------- | --------------------------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -------------------- |
| `selection` | public | `string` | `""` | Currently selected items. Comma delineated string ie. "apples,oranges". | |
| `options` | public | `string` | | Currently available options. Comma delineated string ie. "apples,oranges". | |
| `filterSelected` | public | `boolean` | `false` | DEPRACATED -- use disableSelectionFilter. Whether the component should remove an option from the list when it is in the selection | |
| `disableSelectionFilter` | public | `boolean` | `false` | Whether the component should remove an option from the list when it is in the selection. Default is false. | |
| `filterQuery` | public | `boolean` | `true` | DEPRACATED -- use disableQueryFilter. Whether the component should remove options based on the current query | |
| `disableQueryFilter` | public | `boolean` | `false` | Whether the component should remove options based on the current query. Default is false. | |
| `maxSelected` | public | `number or undefined` | | The maximum number of items that can be selected. | |
| `noSuggestionsText` | public | `string` | `"No suggestions available"` | The text to present to assistive technolgies when no suggestions are available. | |
| `suggestionsAvailableText` | public | `string` | `"Suggestions available"` | The text to present to assistive technolgies when suggestions are available. | |
| `loadingText` | public | `string` | `"Loading suggestions"` | The text to present to assistive technologies when suggestions are loading. | |
| `label` | public | `string` | | Applied to the aria-label attribute of the input element | |
| `labelledBy` | public | `string` | | Applied to the aria-labelledby attribute of the input element | |
| `placeholder` | public | `string` | | Applied to the placeholder attribute of the input element | |
| `menuPlacement` | public | `MenuPlacement` | | Controls menu placement | |
| `showLoading` | public | `boolean` | `false` | Whether to display a loading state if the menu is opened. | |
| `listItemTemplate` | public | `ViewTemplate` | | Template used to generate selected items. This is used in a repeat directive. | |
| `defaultListItemTemplate` | public | `ViewTemplate or undefined` | | Default template to use for selected items (usually specified in the component template). This is used in a repeat directive. | |
| `menuOptionTemplate` | public | `ViewTemplate` | | Template to use for available options. This is used in a repeat directive. | |
| `defaultMenuOptionTemplate` | public | `ViewTemplate or undefined` | | Default template to use for available options (usually specified in the template). This is used in a repeat directive. | |
| `listItemContentsTemplate` | public | `ViewTemplate` | | Template to use for the contents of a selected list item | |
| `menuOptionContentsTemplate` | public | `ViewTemplate` | | Template to use for the contents of menu options | |
| `optionsList` | public | `string[]` | `[]` | Current list of options in array form | |
| `query` | public | `string` | | The text value currently in the input field | |
| `itemsPlaceholderElement` | public | `Node` | | Reference to the placeholder element for the repeat directive | |
| `proxy` | | | | | FormAssociatedPicker |
| Name | Privacy | Type | Default | Description | Inherited From |
| ---------------------------- | ------- | --------------------------- | ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -------------------- |
| `selection` | public | `string` | `""` | Currently selected items. Comma delineated string ie. "apples,oranges". | |
| `options` | public | `string` | | Currently available options. Comma delineated string ie. "apples,oranges". | |
| `filterSelected` | public | `boolean` | `false` | | |
| `disableSelectionFilter` | public | `boolean` | `false` | Whether the component should remove an option from the list when it is in the selection. Default is false. | |
| `filterQuery` | public | `boolean` | `true` | | |
| `disableQueryFilter` | public | `boolean` | `false` | Whether the component should remove options based on the current query. Default is false. | |
| `maxSelected` | public | `number or undefined` | | The maximum number of items that can be selected. | |
| `noSuggestionsText` | public | `string` | `"No suggestions available"` | The text to present to assistive technolgies when no suggestions are available. | |
| `suggestionsAvailableText` | public | `string` | `"Suggestions available"` | The text to present to assistive technolgies when suggestions are available. | |
| `loadingText` | public | `string` | `"Loading suggestions"` | The text to present to assistive technologies when suggestions are loading. | |
| `label` | public | `string` | | Applied to the aria-label attribute of the input element | |
| `labelledBy` | public | `string` | | Applied to the aria-labelledby attribute of the input element | |
| `placeholder` | public | `string` | | Applied to the placeholder attribute of the input element | |
| `menuPlacement` | public | `MenuPlacement` | | Controls menu placement | |
| `showLoading` | public | `boolean` | `false` | Whether to display a loading state if the menu is opened. | |
| `listItemTemplate` | public | `ViewTemplate` | | Template used to generate selected items. This is used in a repeat directive. | |
| `defaultListItemTemplate` | public | `ViewTemplate or undefined` | | Default template to use for selected items (usually specified in the component template). This is used in a repeat directive. | |
| `menuOptionTemplate` | public | `ViewTemplate` | | Template to use for available options. This is used in a repeat directive. | |
| `defaultMenuOptionTemplate` | public | `ViewTemplate or undefined` | | Default template to use for available options (usually specified in the template). This is used in a repeat directive. | |
| `listItemContentsTemplate` | public | `ViewTemplate` | | Template to use for the contents of a selected list item | |
| `menuOptionContentsTemplate` | public | `ViewTemplate` | | Template to use for the contents of menu options | |
| `optionsList` | public | `string[]` | `[]` | Current list of options in array form | |
| `query` | public | `string` | | The text value currently in the input field | |
| `itemsPlaceholderElement` | public | `Node` | | Reference to the placeholder element for the repeat directive | |
| `proxy` | | | | | FormAssociatedPicker |

#### Methods

Expand Down
4 changes: 2 additions & 2 deletions packages/web-components/fast-foundation/src/picker/picker.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ export class FASTPicker extends FormAssociatedPicker {
}

/**
* DEPRACATED -- use disableSelectionFilter. Whether the component should remove an option from the list when it is in the selection
* @deprecated use `Picker.disableSelectionFilter`.
*/
@observable
public filterSelected: boolean = false;
Expand All @@ -121,7 +121,7 @@ export class FASTPicker extends FormAssociatedPicker {
}

/**
* DEPRACATED -- use disableQueryFilter. Whether the component should remove options based on the current query
* @deprecated use `Picker.disableQueryFilter`.
*/
@observable
public filterQuery: boolean = true;
Expand Down

0 comments on commit 3f538e1

Please sign in to comment.