[material-ui][TextField] InputProps vs inputProps confusion

[eyn]

The TextField (nor Input) does not pass the step property through to the input as a step attribute.

• I have searched the issues of this repository and believe that this is not a duplicate.

Expected Behavior

<Textfield type="number" step="0.01" /> renders a <input type="number" step="0.01" />

Current Behavior

<Textfield type="number" step="0.01" /> renders a <input type="number" />

Steps to Reproduce (for bugs)

1. Go to https://codesandbox.io/s/lyxw254vz9
2. Click on the up/down arrows on right of textbox and see differences in behaviour

Context

Your Environment

Tech	Version
Material-UI	1.0.0.rc0
React	16
browser	Safari - Not possible to insert 0.xx number and pass validation. Chrome accepts 0.xx number and validates it but step is still by unit

[eyn]

Happy to do a pr for this if you're happy having step added to TextField (and Input)?

[sakulstra]

didn't test, but I guess you should use <TextField inputProps={{step: 0.01}} /> instead? It#s a prop on Input instead of TextField.

update: sry, just checked your sandbox :D you already came up with that. What#s the problem with the inputProps solution? I guess there are more props we don't pass down automagically: https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement so it might be consistent to not do it at all.

[oliviertassinari]

@eyn We try to find a tradeoff between the popular properties applied on the input and the bundle size of the component. step hasn't made it yet.

[oliviertassinari]

I have added the waiting for users upvotes tag. I'm closing the issue as I'm not sure people are looking for such abstraction. So please upvote this issue if you are. We will prioritize our effort based on the number of upvotes.

[eyn]

Agree it's a balance and step probably falls outside that line at the moment. Just wanted at least a discussion. Any thoughts about a helpful message in development mode for properties that are valid on <input /> but not passed on by TextField or Input.

[oliviertassinari]

Any thoughts about a helpful message in development mode for properties that are valid on but not passed on by TextField or Input.

@eyn I think that it's a good idea 👍

[leMaik]

So… Is there actually no way to specify the steps attribute? 😞

[oliviertassinari]

@leMaik You can with the inputProps property: https://codesandbox.io/s/lyxw254vz9

<TextField inputProps={{ step: "0.01" }} type="number" />

[oliviertassinari]

I think that @eyn's idea is brilliant. We could add warnings about this issue at runtime so people don't have to find this issue on GitHub.

[leMaik]

@oliviertassinari Oh, with a small i. 😓 A warning would have helped me a lot, indeed. I'll look into adding them later. 👍

[sakulstra]

we've been running into this problem over and over again(with min/max/step) :D and eventually ended up writing a custom NumberField which deflattens these props. Would it make sense to expose such a component within material-ui?

[oliviertassinari]

@sakulstra Do you have an example of how it works? It could be interesting.

[sakulstra]

Pretty sure it isn't 😅

We're using this within formik so i tried to extract the not super exciting gist of what we do ;)

const NumberField = ({step, min, max, inputProps, ...rest}) => {
  let inputProps = Object.assing({}, inputProps);
  if (step) inputProps.step = step;
  if (min) inputProps.min = min;
  if (max) inputProps.max = max;
  return (
    <TextField inputProps={inputProps} {...rest} />
  )
}

There's probably a more elegant solution to this, bu we basically whitelisted some props which currently aren't forwarded to inputProps automatically and manually forward them.

[oliviertassinari]

@sakulstra Thanks for sharing the implementation. It's a problem we are exploring in #14580.

There is one pragmatic option we have considered: we could deprecate the inputProps. Instead of forwarding the props to the root element, we could forward them to the inner input element. You almost never need to target the wrapping div (we solve the problem with a ContainerComponent and ContainerProps props for the ListItem).

However, there is one downside to it. It breaks the convention almost all the other components are following. What's the purpose of a convention? Create predictability and intuitive APIs. I'm not sure we actually have an intuitive API here. I see a lot of people struggling with the inputProps existence. We would solve:

• Downshift Voice Over Accessibility  #14555 The aria label are not applied on the right element
• [material-ui][TextField] InputProps vs inputProps confusion #11377 🔺
• [BUG] InputProps and inputProps are not the same #12805 Just to put this somewhere, it seems like InputProps and inputProps are not the same:
• Eslint giving error for duplicate props #10064 eslint duplicate error InputProps and inputProps
• use of min/max and endAdornment in InputProps #16952 eslint duplicate error InputProps and inputProps
• Textfield InputProps #15070 greater 10 or less than zero by setting the min and max in InputProps. But its not working
• Pattern support for TextField #13183 Mehh., inputprops is they way
• Input of type file ignores the accept prop #12369 Input of type file ignores the accept prop`
• Other InputProps are not applied to InputProps.inputComponent #12365 InputProps are not spread on the right element
• Provide a way to set properties on the native input element rendered by TextField #11427 How to apply attribute on the native input?
• InputProps do not get applied to input #9480 InputProps do not get applied to input
• maxlength attribute is not working in v1 #7768 maxlength attribute is not working
• and more…

cc @eps1lon

[sakulstra]

@oliviertassinari thanks for the references, looking trough this, it seems like your approach makes a lot more sense! Looking forward to this change ;)

[jhoffmcd]

As a last resort, if the choice is pragmatic and intuitive, I would choose to break convention I suppose. Form in general have always been a pain point with special complexities so they might unique in a sense. Seems like it solves a whole host of problems that would be nice to eliminate.

[davext]

I'm still having trouble understanding the difference between inputProps vs InputProps

TextField.d.ts

1. I noticed that autoComplete="new-password" mentioned here works when I have "inputProps" but it does not when I have InputProps
2. endAdornment works when I have InputProps and not when I have inputProps
3. if I have both (which wouldn't make sense based on the screenshot attached) it slows down the browser significantly.

[oliviertassinari]

@davext The component/DOM structure of TextField is:

• FormControl
  • InputLabel
  • Input
    • input
  • FormHelperText

it should clarify it

[mnajdova]

I'm still having trouble understanding the difference between inputProps vs InputProps

index c33fab4291..7a582b6b84 100644
--- a/packages/material-ui/src/TextField/TextField.js
+++ b/packages/material-ui/src/TextField/TextField.js
@@ -302,7 +302,7 @@ TextField.propTypes /* remove-proptypes */ = {
    */
   inputProps: PropTypes.object,
   /**
-   * Props applied to the Input element.
+   * Props applied to the Input component.
    * It will be a [`FilledInput`](/api/filled-input/),
    * [`OutlinedInput`](/api/outlined-input/) or [`Input`](/api/input/)
    * component depending on the `variant` prop value.

Could this diff help? It would at least add a differentiation between the component vs element.

[oliviertassinari]

@mnajdova I'm not sure what the right terminology is. From my perspective, props are first applied to the element, then made available in the component's render method.

At this point, I would either propose:

1. A better documentation [material-ui][TextField] InputProps vs inputProps confusion #11377 (comment)

2. Renaming input → htmlInput to match the htmlFor (React), htmlColor (Icon component) props convention.

We can likely do these two changes.

[vicary]

The current convention triggers the lint rule react/jsx-no-duplicate-props and we have no way around it.

[mahady-manana]

Prevent duplicate properties in JSX (react/jsx-no-duplicate-props)

   .....
    InputProps={InputProps}
    inputProps={inputProps}
   ......
    />

This problem was signaled here since 2018: ESlint give error duplicate error.

Is there a solution to fix this issue ?
We are using v5.

[DiegoAndai]

Hey everyone, I'm working on this alongside the #41281 work. My current view on how to solve the confusion relying on the slots pattern is:

InputProps

To be deprecated in favor of slotProps.input

inputProps

For this one, I see two options to deprecate in favor of:

1. slotProps.htmlInput: Differentiates the name from slotProps.input and follows React's htmlFor pattern. Pro: keeps the input element available without accessing nested slots.
2. slotProps.input.slotProps.input: More confusing than option 1, but might be logical for users familiar with the slots pattern.

I prefer option 1., but wonder about your opinion or if you see other options.

[DiegoAndai]

I opened my proposal as a PR ☝🏼

[mnajdova]

1. slotProps.htmlInput: Differentiates the name from slotProps.input and follows React's htmlFor pattern. Pro: keeps the input element available without accessing nested slots.

I like this better, hoisting the API that makes sense on top makes sense, however this will fail if the Input slot is changed and it has a different API for the HTML input. I don't think this is very likely to happen, but at least the second option does not suffer from this issue.

[DiegoAndai]

this will fail if the Input slot is changed and it has a different API for the HTML input.

I think option 2 suffers from this as well. If the custom input does not support slotProps.input, then TextField's slotProps.input.slotProps.input wouldn't work either.