@atlaskit/user-picker 9.4.1 → 9.5.0

package/report.api.md

@@ -1,12 +1,17 @@
+<!-- API Report Version: 2.2 -->
+
 ## API Report File for "@atlaskit/user-picker"
 
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
+> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+
+### Table of contents
+
+- [Main Entry Types](#main-entry-types)
 
-<!--
-	Generated API Report version: 2.0
--->
+### Main Entry Types
 
-[Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+<!--SECTION START: Main Entry Types-->
 
 ```ts
 import { Placement } from '@atlaskit/popper';
@@ -17,16 +22,16 @@ import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
 
 // @public (undocumented)
 export type ActionTypes =
-  | 'select-option'
+  | 'clear'
+  | 'create-option'
   | 'deselect-option'
-  | 'remove-value'
   | 'pop-value'
-  | 'set-value'
-  | 'clear'
-  | 'create-option';
+  | 'remove-value'
+  | 'select-option'
+  | 'set-value';
 
 // @public (undocumented)
-export type Appearance = 'normal' | 'compact';
+export type Appearance = 'compact' | 'normal';
 
 // @public (undocumented)
 export type AtlasKitSelectChange = (
@@ -39,13 +44,13 @@ export type AtlasKitSelectChange = (
 ) => void;
 
 // @public (undocumented)
-export type AtlaskitSelectValue = Option_2 | Array<Option_2> | null | undefined;
+export type AtlaskitSelectValue = Array<Option_2> | Option_2 | null | undefined;
 
 // @public (undocumented)
-type BoundariesElement = 'scrollParent' | 'window' | 'viewport' | HTMLElement;
+type BoundariesElement = 'scrollParent' | 'viewport' | 'window' | HTMLElement;
 
 // @public (undocumented)
-export type DefaultValue = Value | OptionIdentifier | OptionIdentifier[];
+export type DefaultValue = OptionIdentifier | OptionIdentifier[] | Value;
 
 // @public (undocumented)
 export interface Email extends OptionData {
@@ -101,10 +106,10 @@ export interface HighlightRange {
 
 // @public (undocumented)
 export type InputActionTypes =
-  | 'set-value'
-  | 'input-change'
   | 'input-blur'
-  | 'menu-close';
+  | 'input-change'
+  | 'menu-close'
+  | 'set-value';
 
 // @public (undocumented)
 export const isEmail: (option: OptionData) => option is Email;
@@ -125,10 +130,10 @@ export const isValidEmail: EmailValidator;
 export interface LoadOptions {
   // (undocumented)
   (searchText?: string, sessionId?: string):
-    | Promisable<OptionData | OptionData[]>
     | Iterable<
-        Promisable<OptionData[] | OptionData> | OptionData | OptionData[]
-      >;
+        OptionData | OptionData[] | Promisable<OptionData | OptionData[]>
+      >
+    | Promisable<OptionData | OptionData[]>;
 }
 
 // @public (undocumented)
@@ -140,11 +145,11 @@ interface LoadUserSource {
 // @public (undocumented)
 type LozengeColor =
   | 'default'
-  | 'success'
-  | 'removed'
   | 'inprogress'
+  | 'moved'
   | 'new'
-  | 'moved';
+  | 'removed'
+  | 'success';
 
 // @public (undocumented)
 export interface LozengeProps {
@@ -172,9 +177,10 @@ export type OnPicker = (sessionId?: string) => void;
 
 // @public (undocumented)
 type Option_2<Data = OptionData> = {
+  data: Data;
+  isDisabled?: boolean;
   label: string;
   value: string;
-  data: Data;
 };
 export { Option_2 as Option };
 
@@ -187,78 +193,80 @@ export interface OptionData {
   // (undocumented)
   id: string;
   // (undocumented)
-  lozenge?: string | LozengeProps | ReactNode;
+  isDisabled?: boolean;
+  // (undocumented)
+  lozenge?: LozengeProps | ReactNode | string;
   // (undocumented)
   name: string;
   // (undocumented)
-  type?: 'user' | 'team' | 'email' | 'group';
+  type?: 'email' | 'group' | 'team' | 'user';
 }
 
 // @public (undocumented)
-export type OptionIdentifier = Pick<OptionData, 'id' | 'type'>;
+export type OptionIdentifier = Pick<OptionData, 'id' | 'isDisabled' | 'type'>;
 
 // @public (undocumented)
 export const PopupUserPicker: React_2.ForwardRefExoticComponent<
   Pick<
     Omit<PopupUserPickerProps, keyof WithAnalyticsEventsProps>,
-    | 'target'
+    | 'addMoreMessage'
+    | 'allowEmail'
+    | 'anchor'
+    | 'appearance'
+    | 'ariaLabelledBy'
+    | 'ariaLive'
     | 'autoFocus'
     | 'captureMenuScroll'
+    | 'clearValueLabel'
     | 'closeMenuOnScroll'
+    | 'defaultValue'
+    | 'disableInput'
+    | 'emailLabel'
+    | 'fieldId'
     | 'inputId'
     | 'isClearable'
     | 'isDisabled'
     | 'isLoading'
-    | 'menuPosition'
+    | 'isValidEmail'
+    | 'loadOptions'
+    | 'loadUserSource'
+    | 'maxOptions'
+    | 'maxPickerHeight'
+    | 'menuMinWidth'
     | 'menuPortalTarget'
+    | 'menuPosition'
     | 'menuShouldBlockScroll'
+    | 'noBorder'
     | 'noOptionsMessage'
     | 'onBlur'
     | 'onChange'
+    | 'onClear'
+    | 'onClose'
     | 'onFocus'
     | 'onInputChange'
+    | 'onSelection'
+    | 'open'
     | 'options'
     | 'placeholder'
-    | 'styles'
-    | 'value'
-    | 'defaultValue'
-    | 'fieldId'
-    | 'menuMinWidth'
-    | 'maxPickerHeight'
-    | 'textFieldBackgroundColor'
-    | 'loadOptions'
-    | 'loadUserSource'
+    | 'popupTitle'
     | 'search'
-    | 'anchor'
-    | 'open'
-    | 'onSelection'
-    | 'onClear'
-    | 'onClose'
-    | 'appearance'
+    | 'styles'
     | 'subtle'
-    | 'noBorder'
-    | 'addMoreMessage'
-    | 'clearValueLabel'
-    | 'allowEmail'
     | 'suggestEmailsForDomain'
-    | 'emailLabel'
-    | 'disableInput'
-    | 'isValidEmail'
-    | 'maxOptions'
-    | 'ariaLabelledBy'
-    | 'ariaLive'
-    | 'popupTitle'
+    | 'target'
+    | 'textFieldBackgroundColor'
+    | 'value'
   > &
     Partial<
       Pick<
         Omit<PopupUserPickerProps, keyof WithAnalyticsEventsProps>,
-        | 'offset'
-        | 'isMulti'
-        | 'width'
-        | 'rootBoundary'
         | 'boundariesElement'
+        | 'isMulti'
+        | 'offset'
         | 'placement'
+        | 'rootBoundary'
         | 'shouldFlip'
+        | 'width'
       >
     > &
     Partial<
@@ -290,10 +298,10 @@ export type PopupUserPickerProps = UserPickerProps & {
 };
 
 // @public (undocumented)
-export type Promisable<T> = T | PromiseLike<T>;
+export type Promisable<T> = PromiseLike<T> | T;
 
 // @public (undocumented)
-type RootBoundary = 'viewport' | 'document';
+type RootBoundary = 'document' | 'viewport';
 
 // @public (undocumented)
 export type Target = (options: { ref: any; isOpen: boolean }) => ReactNode;
@@ -367,51 +375,51 @@ export interface UserHighlight {
 const UserPicker: React_2.ForwardRefExoticComponent<
   Pick<
     Omit<UserPickerProps, keyof WithAnalyticsEventsProps>,
+    | 'addMoreMessage'
+    | 'allowEmail'
+    | 'anchor'
+    | 'appearance'
+    | 'ariaLabelledBy'
+    | 'ariaLive'
     | 'autoFocus'
     | 'captureMenuScroll'
+    | 'clearValueLabel'
     | 'closeMenuOnScroll'
+    | 'defaultValue'
+    | 'disableInput'
+    | 'emailLabel'
+    | 'fieldId'
     | 'inputId'
     | 'isClearable'
     | 'isDisabled'
     | 'isLoading'
-    | 'menuPosition'
+    | 'isValidEmail'
+    | 'loadOptions'
+    | 'loadUserSource'
+    | 'maxOptions'
+    | 'maxPickerHeight'
+    | 'menuMinWidth'
     | 'menuPortalTarget'
+    | 'menuPosition'
     | 'menuShouldBlockScroll'
+    | 'noBorder'
     | 'noOptionsMessage'
     | 'onBlur'
     | 'onChange'
+    | 'onClear'
+    | 'onClose'
     | 'onFocus'
     | 'onInputChange'
+    | 'onSelection'
+    | 'open'
     | 'options'
     | 'placeholder'
-    | 'styles'
-    | 'value'
-    | 'defaultValue'
-    | 'fieldId'
-    | 'menuMinWidth'
-    | 'maxPickerHeight'
-    | 'textFieldBackgroundColor'
-    | 'loadOptions'
-    | 'loadUserSource'
     | 'search'
-    | 'anchor'
-    | 'open'
-    | 'onSelection'
-    | 'onClear'
-    | 'onClose'
-    | 'appearance'
+    | 'styles'
     | 'subtle'
-    | 'noBorder'
-    | 'addMoreMessage'
-    | 'clearValueLabel'
-    | 'allowEmail'
     | 'suggestEmailsForDomain'
-    | 'emailLabel'
-    | 'disableInput'
-    | 'isValidEmail'
-    | 'maxOptions'
-    | 'ariaLabelledBy'
-    | 'ariaLive'
+    | 'textFieldBackgroundColor'
+    | 'value'
   > &
     Partial<
       Pick<
@@ -434,7 +442,7 @@ export default UserPicker;
 
 // @public (undocumented)
 export type UserPickerProps = WithAnalyticsEventsProps & {
-  fieldId: string | null;
+  fieldId: null | string;
   options?: OptionData[];
   width?: number | string;
   menuMinWidth?: number;
@@ -462,9 +470,9 @@ export type UserPickerProps = WithAnalyticsEventsProps & {
   placeholder?: React_2.ReactNode;
   addMoreMessage?: string;
   noOptionsMessage?:
-    | ((value: { inputValue: string }) => string | null)
-    | string
-    | null;
+    | ((value: { inputValue: string }) => null | string)
+    | null
+    | string;
   value?: Value;
   isDisabled?: boolean;
   isClearable?: boolean;
@@ -480,10 +488,10 @@ export type UserPickerProps = WithAnalyticsEventsProps & {
   autoFocus?: boolean;
   maxOptions?: number;
   inputId?: string;
-  closeMenuOnScroll?: boolean | EventListener;
+  closeMenuOnScroll?: EventListener | boolean;
   menuShouldBlockScroll?: boolean;
   ariaLabelledBy?: string;
-  ariaLive?: 'polite' | 'off' | 'assertive';
+  ariaLive?: 'assertive' | 'off' | 'polite';
 };
 
 // @public (undocumented)
@@ -501,13 +509,13 @@ export type UserPickerState = {
 
 // @public (undocumented)
 export type UserSource =
-  | 'google'
-  | 'slack'
-  | 'microsoft'
+  | 'confluence'
   | 'github'
+  | 'google'
   | 'jira'
-  | 'confluence'
-  | 'other-atlassian';
+  | 'microsoft'
+  | 'other-atlassian'
+  | 'slack';
 
 // @public (undocumented)
 interface UserSourceResult {
@@ -525,3 +533,5 @@ export type Value = OptionData | OptionData[] | null | undefined;
 
 // (No @packageDocumentation comment for this package)
 ```
+
+<!--SECTION END: Main Entry Types-->