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

Marks Select arrays as readonly #6999

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 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 packages/docs-theme/src/components/navigator.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ export class Navigator extends React.PureComponent<NavigatorProps> {
}

private filterMatches: ItemListPredicate<NavigationSection> = (query, items) =>
filter(items, query, {
filter(items.slice(), query, {
key: "route",
maxInners: items.length / 5,
maxResults: 10,
Expand Down
4 changes: 2 additions & 2 deletions packages/select/src/common/itemListRenderer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,13 @@ export interface ItemListRendererProps<T> {
* map each item in this array through `renderItem`, with support for
* optional `noResults` and `initialContent` states.
*/
filteredItems: T[];
filteredItems: readonly T[];

/**
* Array of all items in the list.
* See `filteredItems` for a filtered array based on `query` and predicate props.
*/
items: T[];
items: readonly T[];

/**
* The current query string.
Expand Down
4 changes: 2 additions & 2 deletions packages/select/src/common/listItemsProps.ts
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ export interface ListItemsProps<T> extends Props {
activeItem?: T | CreateNewItem | null;

/** Array of items in the list. */
items: T[];
items: readonly T[];

/**
* Specifies how to test if two items are equal. By default, simple strict
Expand Down Expand Up @@ -157,7 +157,7 @@ export interface ListItemsProps<T> extends Props {
/**
* Callback invoked when multiple items are selected at once via pasting.
*/
onItemsPaste?: (items: T[]) => void;
onItemsPaste?: (items: readonly T[]) => void;

/**
* Callback invoked when the query string changes.
Expand Down
2 changes: 1 addition & 1 deletion packages/select/src/common/predicate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
* A custom predicate for returning an entirely new `items` array based on the provided query.
* See usage sites in `ListItemsProps`.
*/
export type ItemListPredicate<T> = (query: string, items: T[]) => T[];
export type ItemListPredicate<T> = (query: string, items: readonly T[]) => readonly T[];

/**
* A custom predicate for filtering items based on the provided query.
Expand Down
4 changes: 2 additions & 2 deletions packages/select/src/components/multi-select/multiSelect.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ export interface MultiSelectProps<T> extends ListItemsProps<T>, SelectPopoverPro
* Element which triggers the multiselect popover. Providing this prop will replace the default TagInput
* target thats rendered and move the search functionality to within the Popover.
*/
customTarget?: (selectedItems: T[], isOpen: boolean) => React.ReactNode;
customTarget?: (selectedItems: readonly T[], isOpen: boolean) => React.ReactNode;

/**
* Whether the component is non-interactive.
Expand Down Expand Up @@ -104,7 +104,7 @@ export interface MultiSelectProps<T> extends ListItemsProps<T>, SelectPopoverPro
placeholder?: string;

/** Controlled selected values. */
selectedItems: T[];
selectedItems: readonly T[];

/**
* Props to pass to the [TagInput component](##core/components/tag-input).
Expand Down
4 changes: 2 additions & 2 deletions packages/select/src/components/query-list/queryList.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ export interface QueryListState<T> {
createNewItem: T | T[] | undefined;

/** The original `items` array filtered by `itemListPredicate` or `itemPredicate`. */
filteredItems: T[];
filteredItems: readonly T[];

/** The current query string. */
query: string;
Expand Down Expand Up @@ -676,7 +676,7 @@ function isItemDisabled<T>(item: T | null, index: number, itemDisabled?: ListIte
* @param startIndex which index to begin moving from
*/
export function getFirstEnabledItem<T>(
items: T[],
items: readonly T[],
itemDisabled?: keyof T | ((item: T, index: number) => boolean),
direction = 1,
startIndex = items.length - 1,
Expand Down