@patternfly/react-core 5.0.0-alpha.61 → 5.0.0-alpha.63

package/dist/js/deprecated/components/Select/Select.d.ts

@@ -0,0 +1,199 @@
+import * as React from 'react';
+import { SelectOptionObject } from './SelectOption';
+import { SelectPosition } from './selectConstants';
+import { ChipGroupProps } from '../../../components/ChipGroup';
+import { OUIAProps, PickOptional } from '../../../helpers';
+export interface SelectViewMoreObject {
+    /** View more text */
+    text: string;
+    /** Callback for when the view more button is clicked */
+    onClick: (event: React.MouseEvent | React.ChangeEvent) => void;
+}
+export interface SelectProps extends Omit<React.HTMLProps<HTMLDivElement>, 'onSelect' | 'ref' | 'checked' | 'selected'>, OUIAProps {
+    /** Content rendered inside the Select. Must be React.ReactElement<SelectGroupProps>[] */
+    children?: React.ReactElement[];
+    /** Classes applied to the root of the Select */
+    className?: string;
+    /** Indicates where menu will be aligned horizontally */
+    position?: SelectPosition | 'right' | 'left';
+    /** Flag specifying which direction the Select menu expands */
+    direction?: 'up' | 'down';
+    /** Flag to indicate if select is open */
+    isOpen?: boolean;
+    /** Flag to indicate if select options are grouped */
+    isGrouped?: boolean;
+    /** Display the toggle with no border or background */
+    isPlain?: boolean;
+    /** Flag to indicate if select is disabled */
+    isDisabled?: boolean;
+    /** Flag to indicate if the typeahead select allows new items */
+    isCreatable?: boolean;
+    /** Flag to indicate if create option should be at top of typeahead */
+    isCreateOptionOnTop?: boolean;
+    /** Flag indicating if placeholder styles should be applied */
+    hasPlaceholderStyle?: boolean;
+    /** Flag indicating if the creatable option should set its value as a SelectOptionObject */
+    isCreateSelectOptionObject?: boolean;
+    /** Value to indicate if the select is modified to show that validation state.
+     * If set to success, select will be modified to indicate valid state.
+     * If set to error, select will be modified to indicate error state.
+     * If set to warning, select will be modified to indicate warning state.
+     */
+    validated?: 'success' | 'warning' | 'error' | 'default';
+    /** Loading variant to display either the spinner or the view more text button */
+    loadingVariant?: 'spinner' | SelectViewMoreObject;
+    /** Text displayed in typeahead select to prompt the user to create an item */
+    createText?: string;
+    /** Title text of Select */
+    placeholderText?: string | React.ReactNode;
+    /** Text to display in typeahead select when no results are found */
+    noResultsFoundText?: string;
+    /** Array of selected items for multi select variants. */
+    selections?: string | SelectOptionObject | (string | SelectOptionObject)[];
+    /** Flag indicating if selection badge should be hidden for checkbox variant,default false */
+    isCheckboxSelectionBadgeHidden?: boolean;
+    /** Id for select toggle element */
+    toggleId?: string;
+    /** Ref for the select toggle element */
+    toggleRef?: React.Ref<HTMLButtonElement> | React.Ref<HTMLDivElement>;
+    /** Adds accessible text to Select */
+    'aria-label'?: string;
+    /** Id of label for the Select aria-labelledby */
+    'aria-labelledby'?: string;
+    /** Id of div for the select aria-labelledby */
+    'aria-describedby'?: string;
+    /** Flag indicating if the select is an invalid state */
+    'aria-invalid'?: boolean;
+    /** Label for input field of type ahead select variants */
+    typeAheadAriaLabel?: string;
+    /** Id of div for input field of type ahead select variants */
+    typeAheadAriaDescribedby?: string;
+    /** Label for clear selection button of type ahead select variants */
+    clearSelectionsAriaLabel?: string;
+    /** Label for toggle of type ahead select variants */
+    toggleAriaLabel?: string;
+    /** Label for remove chip button of multiple type ahead select variant */
+    removeSelectionAriaLabel?: string;
+    /** ID list of favorited select items */
+    favorites?: string[];
+    /** Label for the favorites group */
+    favoritesLabel?: string;
+    /** Enables favorites. Callback called when a select options's favorite button is clicked */
+    onFavorite?: (itemId: string, isFavorite: boolean) => void;
+    /** Callback for selection behavior */
+    onSelect?: (event: React.MouseEvent | React.ChangeEvent, value: string | SelectOptionObject, isPlaceholder?: boolean) => void;
+    /** Callback for toggle button behavior */
+    onToggle: (event: React.MouseEvent | React.ChangeEvent | React.KeyboardEvent | Event, isExpanded: boolean) => void;
+    /** Callback for toggle blur */
+    onBlur?: (event?: any) => void;
+    /** Callback for typeahead clear button */
+    onClear?: (event: React.MouseEvent) => void;
+    /** Optional callback for custom filtering */
+    onFilter?: (e: React.ChangeEvent<HTMLInputElement> | null, value: string) => React.ReactElement[] | undefined;
+    /** Optional callback for newly created options */
+    onCreateOption?: (newOptionValue: string) => void;
+    /** Optional event handler called each time the value in the typeahead input changes. */
+    onTypeaheadInputChanged?: (value: string) => void;
+    /** Variant of rendered Select */
+    variant?: 'single' | 'checkbox' | 'typeahead' | 'typeaheadmulti';
+    /** Width of the select container as a number of px or string percentage */
+    width?: string | number;
+    /** Max height of the select container as a number of px or string percentage */
+    maxHeight?: string | number;
+    /** Icon element to render inside the select toggle */
+    toggleIcon?: React.ReactElement;
+    /** Custom icon for the dropdown replacing the CaretDownIcon */
+    toggleIndicator?: React.ReactElement;
+    /** Custom content to render in the select menu.  If this prop is defined, the variant prop will be ignored and the select will render with a single select toggle */
+    customContent?: React.ReactNode;
+    /** Flag indicating if select should have an inline text input for filtering */
+    hasInlineFilter?: boolean;
+    /** Placeholder text for inline filter */
+    inlineFilterPlaceholderText?: string;
+    /** Custom text for select badge */
+    customBadgeText?: string | number;
+    /** Prefix for the id of the input in the checkbox select variant*/
+    inputIdPrefix?: string;
+    /** Value for the typeahead and inline filtering input autocomplete attribute. When targeting Chrome this property should be a random string. */
+    inputAutoComplete?: string;
+    /** Optional props to pass to the chip group in the typeaheadmulti variant */
+    chipGroupProps?: Omit<ChipGroupProps, 'children' | 'ref'>;
+    /** Optional props to render custom chip group in the typeaheadmulti variant */
+    chipGroupComponent?: React.ReactNode;
+    /** Flag for retaining keyboard-entered value in typeahead text field when focus leaves input away */
+    isInputValuePersisted?: boolean;
+    /** Flag for retaining filter results on blur from keyboard-entered typeahead text */
+    isInputFilterPersisted?: boolean;
+    /** Flag indicating the typeahead input value should reset upon selection */
+    shouldResetOnSelect?: boolean;
+    /** Content rendered in the footer of the select menu */
+    footer?: React.ReactNode;
+    /** The container to append the menu to. Defaults to 'inline'.
+     * If your menu is being cut off you can append it to an element higher up the DOM tree.
+     * Some examples:
+     * menuAppendTo="parent"
+     * menuAppendTo={() => document.body}
+     * menuAppendTo={document.getElementById('target')}
+     */
+    menuAppendTo?: HTMLElement | (() => HTMLElement) | 'inline' | 'parent';
+    /** Flag for indicating that the select menu should automatically flip vertically when
+     * it reaches the boundary. This prop can only be used when the select component is not
+     * appended inline, e.g. `menuAppendTo="parent"`
+     */
+    isFlipEnabled?: boolean;
+    /** z-index of the select menu when menuAppendTo is not inline. */
+    zIndex?: number;
+    /** Value to overwrite the randomly generated data-ouia-component-id.*/
+    ouiaId?: number | string;
+    /** Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false. */
+    ouiaSafe?: boolean;
+}
+export interface SelectState {
+    focusFirstOption: boolean;
+    typeaheadInputValue: string | null;
+    typeaheadFilteredChildren: React.ReactNode[];
+    favoritesGroup: React.ReactNode[];
+    typeaheadCurrIndex: number;
+    creatableValue: string;
+    tabbedIntoFavoritesMenu: boolean;
+    typeaheadStoredIndex: number;
+    ouiaStateId: string;
+    viewMoreNextIndex: number;
+}
+export declare class Select extends React.Component<SelectProps & OUIAProps, SelectState> {
+    static displayName: string;
+    private parentRef;
+    private menuComponentRef;
+    private filterRef;
+    private clearRef;
+    private inputRef;
+    private refCollection;
+    private optionContainerRefCollection;
+    private footerRef;
+    static defaultProps: PickOptional<SelectProps>;
+    state: SelectState;
+    getTypeaheadActiveChild: (typeaheadCurrIndex: number) => HTMLElement;
+    componentDidUpdate: (prevProps: SelectProps, prevState: SelectState) => void;
+    onEnter: () => void;
+    onToggle: (e: React.MouseEvent | React.ChangeEvent | React.KeyboardEvent | Event, isExpanded: boolean) => void;
+    onClose: () => void;
+    onChange: (e: React.ChangeEvent<HTMLInputElement>) => void;
+    updateTypeAheadFilteredChildren: (typeaheadInputValue: string, e: React.ChangeEvent<HTMLInputElement> | null) => void;
+    onClick: (e: React.MouseEvent) => void;
+    clearSelection: (_e: React.MouseEvent) => void;
+    extendTypeaheadChildren(typeaheadCurrIndex: number, favoritesGroup?: React.ReactNode[]): React.ReactNode[];
+    sendRef: (optionRef: React.ReactNode, favoriteRef: React.ReactNode, optionContainerRef: React.ReactNode, index: number) => void;
+    handleMenuKeys: (index: number, innerIndex: number, position: string) => void;
+    moveFocus: (nextIndex: number, updateCurrentIndex?: boolean) => void;
+    switchFocusToFavoriteMenu: () => void;
+    moveFocusToLastMenuItem: () => void;
+    handleTypeaheadKeys: (position: string, shiftKey?: boolean) => void;
+    onClickTypeaheadToggleButton: () => void;
+    getDisplay: (value: string | SelectOptionObject, type?: 'node' | 'text') => any;
+    findText: (item: React.ReactNode) => string;
+    generateSelectedBadge: () => string | number;
+    setVieMoreNextIndex: () => void;
+    isLastOptionBeforeFooter: (index: any) => boolean;
+    render(): JSX.Element;
+}
+//# sourceMappingURL=Select.d.ts.map

package/dist/js/deprecated/components/Select/Select.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Select.d.ts","sourceRoot":"","sources":["../../../../../src/deprecated/components/Select/Select.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAW/B,OAAO,EAAgB,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAGlE,OAAO,EAGL,cAAc,EAGf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAa,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAG1E,OAAO,EAIL,SAAS,EAET,YAAY,EAEb,MAAM,kBAAkB,CAAC;AAW1B,MAAM,WAAW,oBAAoB;IACnC,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,wDAAwD;IACxD,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,WAAW,KAAK,IAAI,CAAC;CAChE;AACD,MAAM,WAAW,WACf,SAAQ,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,UAAU,GAAG,KAAK,GAAG,SAAS,GAAG,UAAU,CAAC,EACxF,SAAS;IACX,yFAAyF;IACzF,QAAQ,CAAC,EAAE,KAAK,CAAC,YAAY,EAAE,CAAC;IAChC,gDAAgD;IAChD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wDAAwD;IACxD,QAAQ,CAAC,EAAE,cAAc,GAAG,OAAO,GAAG,MAAM,CAAC;IAC7C,8DAA8D;IAC9D,SAAS,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;IAC1B,yCAAyC;IACzC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,qDAAqD;IACrD,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,sDAAsD;IACtD,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,6CAA6C;IAC7C,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,gEAAgE;IAChE,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,sEAAsE;IACtE,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,8DAA8D;IAC9D,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,2FAA2F;IAC3F,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC;;;;OAIG;IACH,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC;IACxD,iFAAiF;IACjF,cAAc,CAAC,EAAE,SAAS,GAAG,oBAAoB,CAAC;IAClD,8EAA8E;IAC9E,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2BAA2B;IAC3B,eAAe,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC;IAC3C,oEAAoE;IACpE,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,yDAAyD;IACzD,UAAU,CAAC,EAAE,MAAM,GAAG,kBAAkB,GAAG,CAAC,MAAM,GAAG,kBAAkB,CAAC,EAAE,CAAC;IAC3E,6FAA6F;IAC7F,8BAA8B,CAAC,EAAE,OAAO,CAAC;IACzC,mCAAmC;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wCAAwC;IACxC,SAAS,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,iBAAiB,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IACrE,qCAAqC;IACrC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iDAAiD;IACjD,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,+CAA+C;IAC/C,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,wDAAwD;IACxD,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,0DAA0D;IAC1D,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,8DAA8D;IAC9D,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,qEAAqE;IACrE,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,qDAAqD;IACrD,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,yEAAyE;IACzE,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,wCAAwC;IACxC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,oCAAoC;IACpC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,4FAA4F;IAC5F,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,KAAK,IAAI,CAAC;IAC3D,sCAAsC;IACtC,QAAQ,CAAC,EAAE,CACT,KAAK,EAAE,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,WAAW,EAC3C,KAAK,EAAE,MAAM,GAAG,kBAAkB,EAClC,aAAa,CAAC,EAAE,OAAO,KACpB,IAAI,CAAC;IACV,0CAA0C;IAC1C,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,WAAW,GAAG,KAAK,CAAC,aAAa,GAAG,KAAK,EAAE,UAAU,EAAE,OAAO,KAAK,IAAI,CAAC;IACnH,+BAA+B;IAC/B,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,GAAG,KAAK,IAAI,CAAC;IAC/B,0CAA0C;IAC1C,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,KAAK,IAAI,CAAC;IAC5C,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,gBAAgB,CAAC,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,KAAK,KAAK,CAAC,YAAY,EAAE,GAAG,SAAS,CAAC;IAC9G,kDAAkD;IAClD,cAAc,CAAC,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,IAAI,CAAC;IAClD,wFAAwF;IACxF,uBAAuB,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAClD,iCAAiC;IACjC,OAAO,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,WAAW,GAAG,gBAAgB,CAAC;IACjE,2EAA2E;IAC3E,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,gFAAgF;IAChF,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC5B,sDAAsD;IACtD,UAAU,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC;IAChC,+DAA+D;IAC/D,eAAe,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC;IACrC,qKAAqK;IACrK,aAAa,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAChC,+EAA+E;IAC/E,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,yCAAyC;IACzC,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC,mCAAmC;IACnC,eAAe,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAClC,mEAAmE;IACnE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,gJAAgJ;IAChJ,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,6EAA6E;IAC7E,cAAc,CAAC,EAAE,IAAI,CAAC,cAAc,EAAE,UAAU,GAAG,KAAK,CAAC,CAAC;IAC1D,+EAA+E;IAC/E,kBAAkB,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACrC,qGAAqG;IACrG,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,qFAAqF;IACrF,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,4EAA4E;IAC5E,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,wDAAwD;IACxD,MAAM,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACzB;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,WAAW,GAAG,CAAC,MAAM,WAAW,CAAC,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACvE;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,kEAAkE;IAClE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,uEAAuE;IACvE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,iLAAiL;IACjL,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,gBAAgB,EAAE,OAAO,CAAC;IAC1B,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,yBAAyB,EAAE,KAAK,CAAC,SAAS,EAAE,CAAC;IAC7C,cAAc,EAAE,KAAK,CAAC,SAAS,EAAE,CAAC;IAClC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,cAAc,EAAE,MAAM,CAAC;IACvB,uBAAuB,EAAE,OAAO,CAAC;IACjC,oBAAoB,EAAE,MAAM,CAAC;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED,qBAAa,MAAO,SAAQ,KAAK,CAAC,SAAS,CAAC,WAAW,GAAG,SAAS,EAAE,WAAW,CAAC;IAC/E,MAAM,CAAC,WAAW,SAAY;IAC9B,OAAO,CAAC,SAAS,CAAqC;IACtD,OAAO,CAAC,gBAAgB,CAAkC;IAC1D,OAAO,CAAC,SAAS,CAAuC;IACxD,OAAO,CAAC,QAAQ,CAAwC;IACxD,OAAO,CAAC,QAAQ,CAAuC;IACvD,OAAO,CAAC,aAAa,CAAyB;IAC9C,OAAO,CAAC,4BAA4B,CAAqB;IACzD,OAAO,CAAC,SAAS,CAAqC;IAEtD,MAAM,CAAC,YAAY,EAAE,YAAY,CAAC,WAAW,CAAC,CAoD5C;IAEF,KAAK,EAAE,WAAW,CAWhB;IAEF,uBAAuB,uBAAwB,MAAM,iBACuC;IAE5F,kBAAkB,cAAe,WAAW,aAAa,WAAW,UA4FlE;IAEF,OAAO,aAEL;IAEF,QAAQ,MAAO,gBAAgB,GAAG,MAAM,WAAW,GAAG,mBAAmB,GAAG,KAAK,cAAc,OAAO,UAWpG;IAEF,OAAO,aAaL;IAEF,QAAQ,MAAO,MAAM,WAAW,CAAC,gBAAgB,CAAC,UAgBhD;IAEF,+BAA+B,wBAAyB,MAAM,KAAK,MAAM,WAAW,CAAC,gBAAgB,CAAC,GAAG,IAAI,UAyI3G;IAEF,OAAO,MAAO,gBAAgB,UAI5B;IAEF,cAAc,OAAQ,gBAAgB,UAMpC;IAEF,uBAAuB,CAAC,kBAAkB,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,KAAK,CAAC,SAAS,EAAE;IA2EtF,OAAO,cACM,MAAM,SAAS,eACb,MAAM,SAAS,sBACR,MAAM,SAAS,SAC5B,MAAM,UAIb;IAEF,cAAc,UAAW,MAAM,cAAc,MAAM,YAAY,MAAM,UAOnE;IAEF,SAAS,cAAe,MAAM,uBAAsB,OAAO,UAyBzD;IAEF,yBAAyB,aAoBvB;IAEF,uBAAuB,aASrB;IAEF,mBAAmB,aAAc,MAAM,aAAY,OAAO,UAuKxD;IAEF,4BAA4B,aAI1B;IAEF,UAAU,UAAW,MAAM,GAAG,kBAAkB,SAAQ,MAAM,GAAG,MAAM,SAuBrE;IAEF,QAAQ,SAAU,MAAM,SAAS,YAU/B;IAEF,qBAAqB,wBASnB;IAEF,mBAAmB,aAEjB;IAEF,wBAAwB,UAAW,GAAG,aACwC;IAE9E,MAAM;CA4gBP"}