Skip to content

Commit

Permalink
depracate
Browse files Browse the repository at this point in the history
  • Loading branch information
@scomea
scomea committed Jul 5, 2023
1 parent ded8b09 commit a14c6c7
Show file tree
Hide file tree
Showing 5 changed files with 79 additions and 53 deletions.
11 changes: 8 additions & 3 deletions packages/web-components/fast-foundation/docs/api-report.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1517,6 +1517,12 @@ export class FASTPicker extends FormAssociatedPicker {
defaultMenuOptionTemplate?: ViewTemplate;
// (undocumented)
protected defaultMenuOptionTemplateChanged(): void;
disableQueryFilter: boolean;
// (undocumented)
protected disableQueryFilterChanged(): void;
disableSelectionFilter: boolean;
// (undocumented)
protected disableSelectionFilterChanged(): void;
// (undocumented)
disconnectedCallback(): void;
// @internal
Expand All @@ -1525,6 +1531,8 @@ export class FASTPicker extends FormAssociatedPicker {
// (undocumented)
protected filterQueryChanged(): void;
filterSelected: boolean;
// (undocumented)
protected filterSelectedChanged(): void;
// @internal
flyoutOpen: boolean;
// (undocumented)
Expand Down Expand Up @@ -1579,9 +1587,6 @@ export class FASTPicker extends FormAssociatedPicker {
query: string;
// (undocumented)
protected queryChanged(): void;
queryFilterDisabled: boolean;
// (undocumented)
protected queryFilterDisabledChanged(): void;
// @internal
region: FASTAnchoredRegion;
// @internal (undocumented)
Expand Down
61 changes: 32 additions & 29 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,41 +189,44 @@ 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` | Whether the component should remove an option from the list when it is in the selection | |
| `filterQuery` | public | `boolean` | `true` | DEPRACATED -- use queryFilterDisabled. Whether the component should remove options based on the current query | |
| `queryFilterDisabled` | public | `boolean` | `false` | Whether the component should remove options based on the current query | |
| `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` | 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 |

#### Methods

| Name | Privacy | Description | Parameters | Return | Inherited From |
| ---------------------------------- | --------- | ------------------------------------------------------------- | ------------------ | --------- | -------------- |
| `selectionChanged` | protected | | | `void` | |
| `optionsChanged` | protected | | | `void` | |
| `filterSelectedChanged` | protected | | | `void` | |
| `disableSelectionFilterChanged` | protected | | | `void` | |
| `filterQueryChanged` | protected | | | `void` | |
| `queryFilterDisabledChanged` | protected | | | `void` | |
| `disableQueryFilterChanged` | protected | | | `void` | |
| `menuPlacementChanged` | protected | | | `void` | |
| `showLoadingChanged` | protected | | | `void` | |
| `listItemTemplateChanged` | protected | | | `void` | |
Expand All @@ -247,8 +250,8 @@ export class FASTTextField extends TextField {}
| ---------------------------- | ------------------------ | -------------- |
| `selection` | selection | |
| `options` | options | |
| `filter-selected` | filterSelected | |
| `query-filter-disabled` | queryFilterDisabled | |
| `disable-selection-filter` | disableSelectionFilter | |
| `disable-query-filter` | disableQueryFilter | |
| `max-selected` | maxSelected | |
| `no-suggestions-text` | noSuggestionsText | |
| `suggestions-available-text` | suggestionsAvailableText | |
Expand Down
2 changes: 1 addition & 1 deletion packages/web-components/fast-foundation/src/picker/picker.spec.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Picker is the top level container which hosts both a `picker-list` component to
- `labelledby`: The text applied to the `aria-labelledby` attribute of the internal input element.
- `placeholder`: The text used as the `placeholder` value for the internal input element.
- `filter-selected`: Whether to remove selected elements from the option list (default=false)
- `query-filter-disabled`: Whether to remove elements that don't match the query string (default=false)
- `disable-query-filter`: Whether to remove elements that don't match the query string (default=false)
- `menu-placement`: Controls the placement of the menu relative to the input element.
(default="bottom-fill")

Expand Down
Loading

0 comments on commit a14c6c7

Please sign in to comment.