@dhis2-ui/select 10.9.2 → 10.10.0-alpha.1

package/types/index.d.ts

@@ -30,6 +30,16 @@ export type SelectKeyHandler<T extends BaseEventPayload> = SelectEventHandler<
 export type SelectChangeHandler<T extends BaseEventPayload> =
     SelectEventHandler<T, React.MouseEvent>
 
+type TranslateableProp = string | ((interpolationObject: any) => string)
+
+/**
+ * ====================
+ *
+ * <MultiSelect />
+ *
+ * ====================
+ **/
+
 export interface MultiSelectProps {
     children?: React.ReactNode
     className?: string
@@ -74,7 +84,13 @@ export interface MultiSelectProps {
 
 export const MultiSelect: React.FC<MultiSelectProps>
 
-type TranslateableProp = string | ((interpolationObject: any) => string)
+/**
+ * ====================
+ *
+ * <MultiSelectField />
+ *
+ * ====================
+ **/
 
 export interface MultiSelectFieldProps {
     /**
@@ -205,6 +221,14 @@ export class MultiSelectField extends React.Component<
     render(): JSX.Element
 }
 
+/**
+ * ====================
+ *
+ * <MultiSelectOption />
+ *
+ * ====================
+ **/
+
 export interface MultiSelectOptionProps {
     label: string
     value: string
@@ -217,6 +241,14 @@ export interface MultiSelectOptionProps {
 
 export const MultiSelectOption: React.FC<MultiSelectOptionProps>
 
+/**
+ * ====================
+ *
+ * <SingleSelect />
+ *
+ * ====================
+ **/
+
 export interface SingleSelectProps {
     children?: React.ReactNode
     className?: string
@@ -273,6 +305,149 @@ export interface SingleSelectProps {
 
 export const SingleSelect: React.FC<SingleSelectProps>
 
+/**
+ * ====================
+ *
+ * <SimpleSingleSelect />
+ *
+ * ====================
+ **/
+
+type SimpleSingleSelectCustomOptionProp = (props: {
+    value: string
+    label: string
+    index: number
+    disabled: boolean
+    highlighted: boolean
+}) => JSX.Element
+
+export interface SimpleSingleSelectProps {
+    /** necessary for IDs that are required for accessibility **/
+    idPrefix: string.isRequired
+
+    /** An array of options **/
+    options: Array<{
+        label: string
+        value: string
+        component?: SimpleSingleSelectCustomOptionProp
+        disabled?: boolean
+    }>
+
+    /** A callback that will be called with the new value or an empty string **/
+    onChange: (value: string) => void
+
+    /** Will focus the select initially **/
+    autoFocus?: boolean
+
+    /** Additional class names that will be applied to the root element **/
+    className?: string
+
+    /** This will allow us to put an aria-label on the clear button **/
+    clearText?: string
+
+    /** Whether a clear button should be displayed or not **/
+    clearable?: boolean
+
+    /** Allows to override what's rendered inside the `button[role="option"]`.
+     * Can be overriden on an individual option basis **/
+    customOption?: SimpleSingleSelectCustomOptionProp
+
+    /** A value for a `data-test` attribute on the root element **/
+    dataTest?: string
+
+    /** Renders a select with lower height **/
+    dense?: boolean
+
+    /** Disables all interactions with the select (except focussing) **/
+    disabled?: boolean
+
+    /** Text or component to display when there are no options **/
+    empty?: React.ReactNode
+
+    /** Applies 'error' appearance for validation feedback. Mutually exclusive with `warning` and `valid` props **/
+    error?: boolean
+
+    /** Help text that will be displayed below the input **/
+    filterHelpText?: string
+
+    /** Value will be used as aria-label attribute on the filter input **/
+    filterLabel?: string
+
+    /** Placeholder for the filter input **/
+    filterPlaceholder?: string
+
+    /** Value of the filter input **/
+    filterValue?: string
+
+    /** Whether the select should display a filter input **/
+    filterable?: boolean
+
+    /** Should contain the id of the element that labels the select, if applicable **/
+    labelledBy?: string
+
+    /** Will show a loading indicator at the end of the options-list **/
+    loading?: boolean
+
+    /** Text that will be displayed next to the loading indicator **/
+    menuLoadingText?: string
+
+    /** Allows to modify the max height of the menu **/
+    menuMaxHeight?: string
+
+    /** String that will be displayed when the select is being filtered but the options array is empty **/
+    noMatchText?: string
+
+    /** For a11y: How aggressively the user should be updated about changes in options **/
+    optionUpdateStrategy?: 'off' | 'polite' | 'assertive'
+
+    /** String to show when there's no value and no valueLabel **/
+    placeholder?: string
+
+    /** String that will be displayed before the label of the selected option **/
+    prefix?: string
+
+    /** Standard HTML tab-index attribute that will be put on the combobox's root element **/
+    tabIndex?: number | string
+
+    /** Applies 'valid' appearance for validation feedback. Mutually exclusive with `warning` and `valid` props **/
+    valid?: boolean
+
+    /** As of now, this component does not support being uncontrolled **/
+    value?: string
+
+    /**
+     * When the option is not in the options list (e.g. not loaded or list is
+     * filtered), but a selected value needs to be displayed, then this prop can
+     * be used to supply the text to be shown.
+     **/
+    valueLabel?: string
+
+    /** Applies 'warning' appearance for validation feedback. Mutually exclusive with `warning` and `valid` props **/
+    warning?: boolean
+
+    /** Will be called when the combobox is loses focus **/
+    onBlur?: (e: React.FocusEvent<HTMLElement>) => void
+
+    /** Will be called when the last option is scrolled into the visible area **/
+    onEndReached?: () => void
+
+    /** Will be called when the filter value changes **/
+    onFilterChange?: (value: string) => void
+
+    /** Will be called when the combobox is being focused **/
+    onFocus?: (e: React.FocusEvent<HTMLElement>) => void
+}
+
+export const SimpleSingleSelect: React.FC<SimpleSingleSelectProps>
+
+/**
+ * ====================
+ *
+ * <SingleSelectField />
+ *
+ * ====================
+ **/
+
 export interface SingleSelectFieldProps {
     /**
      * Should be `SingleSelectOption` components
@@ -402,6 +577,14 @@ export class SingleSelectField extends React.Component<
     render(): JSX.Element
 }
 
+/**
+ * ====================
+ *
+ * <SingleSelectOption />
+ *
+ * ====================
+ **/
+
 export interface SingleSelectOptionProps {
     label: string
     value: string