Improve renderInput spreading experience (mui#1760)

* Improve input customization exprience and add new examples * Remove data-mui-test from renderInput props * Fix Cypress tests and ts error
mnajdova · May 9, 2020 · 7d6525b · 7d6525b
1 parent 30c5bed
commit 7d6525b
Show file tree

Hide file tree

Showing 10 changed files with 109 additions and 64 deletions.
diff --git a/docs/pages/demo/datepicker/AdvancedKeyboard.example.jsx b/docs/pages/demo/datepicker/AdvancedKeyboard.example.jsx
diff --git a/docs/pages/demo/datepicker/CustomInput.example.jsx b/docs/pages/demo/datepicker/CustomInput.example.jsx
@@ -0,0 +1,28 @@
+import React, { useState } from 'react';
+import { styled } from '@material-ui/core';
+import { DesktopDatePicker } from '@material-ui/pickers';
+
+const InputContainer = styled('div')({
+  display: 'flex',
+  alignItems: 'center',
+});
+
+function CustomInput() {
+  const [selectedDate, handleDateChange] = useState(new Date());
+
+  return (
+    <DesktopDatePicker
+      label="Advanced keyboard"
+      value={selectedDate}
+      onChange={date => handleDateChange(date)}
+      renderInput={({ ref, inputProps, InputProps }) => (
+        <InputContainer ref={ref}>
+          <input {...inputProps} />
+          {InputProps?.endAdornment}
+        </InputContainer>
+      )}
+    />
+  );
+}
+
+export default CustomInput;
diff --git a/docs/pages/demo/datepicker/index.mdx b/docs/pages/demo/datepicker/index.mdx
@@ -10,7 +10,7 @@ import * as ViewsDatePicker from './ViewsDatePicker.example';
 import * as BasicDatePicker from './BasicDatePicker.example';
 import * as StaticDatePicker from './StaticDatePicker.example';
 import * as DatePickers from './DatePickers.example';
-import * as AdvancedKeyboard from './AdvancedKeyboard.example';
+import * as CustomInput from './CustomInput.example';
 
 <PageMeta component="DatePicker" />
 
@@ -53,11 +53,11 @@ For that use `StaticDatePicker`.
   <Example paddingBottom source={StaticDatePicker} />
 </Hidden>
 
-#### Advanced keyboard input
+#### Custom input component
 
-We are providing default localized formats, but you can change this behaviour with `format` and `mask` props.
+You can customize rendering input by `renderInput` prop. But make sure you will spread `ref` and `inputProps` correctly to the custom input component.
 
-<Example source={AdvancedKeyboard} />
+<Example source={CustomInput} />
 
 #### Customization
 

diff --git a/docs/pages/demo/daterangepicker/CustomRangeInputs.example.tsx b/docs/pages/demo/daterangepicker/CustomRangeInputs.example.tsx
@@ -0,0 +1,22 @@
+import React, { useState } from 'react';
+import { DateRangePicker, DateRange } from '@material-ui/pickers';
+
+function CustomRangeInputs() {
+  const [selectedDate, handleDateChange] = useState<DateRange>([null, null]);
+
+  return (
+    <DateRangePicker
+      label="Advanced keyboard"
+      value={selectedDate}
+      onChange={date => handleDateChange(date)}
+      renderInput={(startProps, endProps) => (
+        <>
+          <input ref={startProps.ref as React.Ref<HTMLInputElement>} {...startProps.inputProps} />
+          <input ref={endProps.ref as React.Ref<HTMLInputElement>} {...endProps.inputProps} />
+        </>
+      )}
+    />
+  );
+}
+
+export default CustomRangeInputs;
diff --git a/docs/pages/demo/daterangepicker/index.mdx b/docs/pages/demo/daterangepicker/index.mdx
@@ -9,6 +9,7 @@ import * as ResponsiveDateRangePicker from './ResponsiveDateRangePicker.example'
 import * as MinMaxDateRangePicker from './MinMaxDateRangePicker.example';
 import * as CalendarsDateRangePicker from './CalendarsDateRangePicker.example';
 import * as StaticDateRangePicker from './StaticDateRangePicker.example';
+import * as CustomRangeInputs from './CustomRangeInputs.example';
 
 <PageMeta component="DateRangePicker" />
 
@@ -43,6 +44,13 @@ Disabling dates performs just like in simple `DatePicker`
 
 <Example source={MinMaxDateRangePicker} />
 
+#### Custom input component
+
+You can customize rendering input by `renderInput` prop. For `DateRangePicker` it takes **2** parameters – for start and end input respectively.
+So if you need to render custom input make sure you will spread `ref` and `inputProps` correctly to the input components.
+
+<Example source={CustomRangeInputs} />
+
 #### Static mode
 
 It is possible to render any picker without modal or popper. For that use `StaticDateRangePicker`.

diff --git a/docs/pages/regression/Regression.tsx b/docs/pages/regression/Regression.tsx
@@ -100,9 +100,15 @@ function Regression() {
         onChange={changeRange}
         renderInput={(startProps, endProps) => (
           <>
-            <TextField {...startProps} inputProps={{ 'data-mui-test': 'desktop-range-picker' }} />
+            <TextField
+              {...startProps}
+              inputProps={{ ...startProps.inputProps, 'data-mui-test': 'desktop-range-picker' }}
+            />
             <DateRangeDelimiter> to </DateRangeDelimiter>
-            <TextField {...endProps} inputProps={{ 'data-mui-test': 'desktop-range-picker-end' }} />
+            <TextField
+              {...endProps}
+              inputProps={{ ...endProps.inputProps, 'data-mui-test': 'desktop-range-picker-end' }}
+            />
           </>
         )}
       />

diff --git a/lib/.size-snapshot.json b/lib/.size-snapshot.json
@@ -1,26 +1,26 @@
 {
   "build/dist/material-ui-pickers.esm.js": {
-    "bundled": 188938,
-    "minified": 101335,
-    "gzipped": 26402,
+    "bundled": 189105,
+    "minified": 101411,
+    "gzipped": 26429,
     "treeshaked": {
       "rollup": {
-        "code": 83375,
+        "code": 83443,
         "import_statements": 2121
       },
       "webpack": {
-        "code": 92851
+        "code": 92919
       }
     }
   },
   "build/dist/material-ui-pickers.umd.js": {
-    "bundled": 299832,
-    "minified": 116954,
-    "gzipped": 33374
+    "bundled": 300017,
+    "minified": 117022,
+    "gzipped": 33387
   },
   "build/dist/material-ui-pickers.umd.min.js": {
-    "bundled": 258486,
-    "minified": 107815,
-    "gzipped": 30601
+    "bundled": 258671,
+    "minified": 107883,
+    "gzipped": 30626
   }
 }
diff --git a/lib/src/DateRangePicker/DateRangePickerInput.tsx b/lib/src/DateRangePicker/DateRangePickerInput.tsx
@@ -7,8 +7,8 @@ import { CurrentlySelectingRangeEndProps } from './RangeTypes';
 import { useMaskedInput } from '../_shared/hooks/useMaskedInput';
 import { DateRangeValidationError } from '../_helpers/date-utils';
 import { WrapperVariantContext } from '../wrappers/WrapperVariantContext';
-import { DateInputProps, MuiTextFieldProps } from '../_shared/PureDateInput';
 import { mergeRefs, executeInTheNextEventLoopTick } from '../_helpers/utils';
+import { DateInputProps, MuiTextFieldProps } from '../_shared/PureDateInput';
 
 export const useStyles = makeStyles(
   theme => ({
@@ -147,6 +147,8 @@ export const DateRangePickerInput: React.FC<DateRangeInputProps> = ({
       ref: startRef,
       variant: 'outlined',
       focused: open && currentlySelectingRangeEnd === 'start',
+    },
+    inputProps: {
       onClick: !openOnFocus ? openRangeStartSelection : undefined,
       onFocus: openOnFocus ? openRangeStartSelection : undefined,
     },
@@ -164,6 +166,8 @@ export const DateRangePickerInput: React.FC<DateRangeInputProps> = ({
       ref: endRef,
       variant: 'outlined',
       focused: open && currentlySelectingRangeEnd === 'end',
+    },
+    inputProps: {
       onClick: !openOnFocus ? openRangeEndSelection : undefined,
       onFocus: openOnFocus ? openRangeEndSelection : undefined,
     },

diff --git a/lib/src/_shared/PureDateInput.tsx b/lib/src/_shared/PureDateInput.tsx
@@ -123,11 +123,15 @@ export const PureDateInput: React.FC<DateInputProps & DateInputRefs> = ({
     ref: containerRef,
     inputRef: forwardedRef,
     error: validationError,
-    'aria-label': getOpenDialogAriaText(rawValue, utils),
-    onClick: onOpen,
-    value: inputValue,
     InputProps: PureDateInputProps,
-    onKeyDown: onSpaceOrEnter(onOpen),
+    inputProps: {
+      disabled,
+      'aria-readonly': true,
+      'aria-label': getOpenDialogAriaText(rawValue, utils),
+      value: inputValue,
+      onClick: onOpen,
+      onKeyDown: onSpaceOrEnter(onOpen),
+    },
     ...TextFieldProps,
   });
 };

diff --git a/lib/src/_shared/hooks/useMaskedInput.tsx b/lib/src/_shared/hooks/useMaskedInput.tsx
@@ -21,7 +21,7 @@ type MaskedInputProps = Omit<
   | 'disableOpenPicker'
   | 'getOpenDialogAriaText'
   | 'OpenPickerButtonProps'
->;
+> & { inputProps?: Partial<React.HTMLProps<HTMLInputElement>> };
 
 export function useMaskedInput({
   disableMaskedInput,
@@ -37,6 +37,7 @@ export function useMaskedInput({
   readOnly,
   TextFieldProps,
   label,
+  inputProps,
 }: MaskedInputProps): MuiTextFieldProps {
   const utils = useUtils();
   const isFocusedRef = React.useRef(false);
@@ -99,23 +100,23 @@ export function useMaskedInput({
       };
 
   return {
-    ...inputStateArgs,
     label,
     disabled,
-    placeholder: formatHelperText,
     error: validationError,
     helperText: formatHelperText,
-    // @ts-ignore ??? fix typings for textfield finally
-    'data-mui-test': 'keyboard-date-input',
-    inputProps: { readOnly, type: shouldUseMaskedInput ? 'tel' : 'text' },
+    inputProps: {
+      ...inputStateArgs,
+      disabled, // make spreading in custom input easier
+      placeholder: formatHelperText,
+      readOnly,
+      type: shouldUseMaskedInput ? 'tel' : 'text',
+      ...inputProps,
+      onFocus: createDelegatedEventHandler(
+        () => (isFocusedRef.current = true),
+        inputProps?.onFocus
+      ),
+      onBlur: createDelegatedEventHandler(() => (isFocusedRef.current = false), inputProps?.onBlur),
+    },
     ...TextFieldProps,
-    onFocus: createDelegatedEventHandler(
-      () => (isFocusedRef.current = true),
-      TextFieldProps?.onFocus
-    ),
-    onBlur: createDelegatedEventHandler(
-      () => (isFocusedRef.current = false),
-      TextFieldProps?.onBlur
-    ),
   };
 }