Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[TextareaAutosize] Add rowsMin prop #18804

Merged
merged 2 commits into from
Dec 13, 2019
Merged

[TextareaAutosize] Add rowsMin prop #18804

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cbebea6
Add rowsMin
lcswillems Dec 12, 2019
dde4273
update documentation
oliviertassinari Dec 13, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/pages/api/input-base.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ It contains a load of style reset and some state logic.
| <span class="prop-name">required</span> | <span class="prop-type">bool</span> | | If `true`, the `input` element will be required. |
| <span class="prop-name">rows</span> | <span class="prop-type">string<br>&#124;&nbsp;number</span> | | Number of rows to display when multiline option is set to true. |
| <span class="prop-name">rowsMax</span> | <span class="prop-type">string<br>&#124;&nbsp;number</span> | | Maximum number of rows to display when multiline option is set to true. |
| <span class="prop-name">rowsMin</span> | <span class="prop-type">string<br>&#124;&nbsp;number</span> | | Minimum number of rows to display when multiline option is set to true. |
| <span class="prop-name">startAdornment</span> | <span class="prop-type">node</span> | | Start `InputAdornment` for this component. |
| <span class="prop-name">type</span> | <span class="prop-type">string</span> | <span class="prop-default">'text'</span> | Type of the `input` element. It should be [a valid HTML5 input type](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Form_%3Cinput%3E_types). |
| <span class="prop-name">value</span> | <span class="prop-type">any</span> | | The value of the `input` element, required for a controlled component. |
Expand Down
3 changes: 2 additions & 1 deletion docs/pages/api/textarea-autosize.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,9 @@ You can learn more about the difference by [reading this guide](/guides/minimizi

| Name | Type | Default | Description |
|:-----|:-----|:--------|:------------|
| <span class="prop-name">rows</span> | <span class="prop-type">string<br>&#124;&nbsp;number</span> | | Minimum number of rows to display. |
| <span class="prop-name">rows</span> | <span class="prop-type">string<br>&#124;&nbsp;number</span> | | Use `rowsMin` instead. The prop will be removed in v5. |
| <span class="prop-name">rowsMax</span> | <span class="prop-type">string<br>&#124;&nbsp;number</span> | | Maximum number of rows to display. |
| <span class="prop-name">rowsMin</span> | <span class="prop-type">string<br>&#124;&nbsp;number</span> | <span class="prop-default">1</span> | Minimum number of rows to display. |

The `ref` is forwarded to the root element.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/pages/components/textarea-autosize/MinHeightTextarea.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ import React from 'react';
import TextareaAutosize from '@material-ui/core/TextareaAutosize';

export default function MinHeightTextarea() {
return <TextareaAutosize aria-label="minimum height" rows={3} placeholder="Minimum 3 rows" />;
return <TextareaAutosize aria-label="minimum height" rowsMin={3} placeholder="Minimum 3 rows" />;
}
2 changes: 1 addition & 1 deletion docs/src/pages/components/textarea-autosize/MinHeightTextarea.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ import React from 'react';
import TextareaAutosize from '@material-ui/core/TextareaAutosize';

export default function MinHeightTextarea() {
return <TextareaAutosize aria-label="minimum height" rows={3} placeholder="Minimum 3 rows" />;
return <TextareaAutosize aria-label="minimum height" rowsMin={3} placeholder="Minimum 3 rows" />;
}
7 changes: 6 additions & 1 deletion packages/material-ui/src/InputBase/InputBase.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,7 @@ const InputBase = React.forwardRef(function InputBase(props, ref) {
renderSuffix,
rows,
rowsMax,
rowsMin,
startAdornment,
type = 'text',
value: valueProp,
Expand Down Expand Up @@ -367,7 +368,7 @@ const InputBase = React.forwardRef(function InputBase(props, ref) {
ref: null,
};
} else if (multiline) {
if (rows && !rowsMax) {
if (rows && !rowsMax && !rowsMin) {
InputComponent = 'textarea';
} else {
inputProps = {
Expand Down Expand Up @@ -599,6 +600,10 @@ InputBase.propTypes = {
* Maximum number of rows to display when multiline option is set to true.
*/
rowsMax: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
/**
* Minimum number of rows to display when multiline option is set to true.
*/
rowsMin: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
/**
* Start `InputAdornment` for this component.
*/
Expand Down
1 change: 1 addition & 0 deletions packages/material-ui/src/TextareaAutosize/TextareaAutosize.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import * as React from 'react';

export interface TextareaAutosizeProps extends React.TextareaHTMLAttributes<HTMLTextAreaElement> {
rowsMax?: string | number;
rowsMin?: string | number;
}

declare const TextareaAutosize: React.ComponentType<
Expand Down
22 changes: 15 additions & 7 deletions packages/material-ui/src/TextareaAutosize/TextareaAutosize.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,9 @@ const styles = {
};

const TextareaAutosize = React.forwardRef(function TextareaAutosize(props, ref) {
const { onChange, rows, rowsMax, style, value, ...other } = props;
const { onChange, rows, rowsMax, rowsMin: rowsMinProp = 1, style, value, ...other } = props;

const rowsMin = rows || rowsMinProp;

const { current: isControlled } = React.useRef(value != null);
const inputRef = React.useRef(null);
Expand Down Expand Up @@ -60,10 +62,10 @@ const TextareaAutosize = React.forwardRef(function TextareaAutosize(props, ref)
// The height of the outer content
let outerHeight = innerHeight;

if (rows != null) {
outerHeight = Math.max(Number(rows) * singleRowHeight, outerHeight);
if (rowsMin) {
outerHeight = Math.max(Number(rowsMin) * singleRowHeight, outerHeight);
}
if (rowsMax != null) {
if (rowsMax) {
outerHeight = Math.min(Number(rowsMax) * singleRowHeight, outerHeight);
}
outerHeight = Math.max(outerHeight, singleRowHeight);
Expand All @@ -88,7 +90,7 @@ const TextareaAutosize = React.forwardRef(function TextareaAutosize(props, ref)

return prevState;
});
}, [rows, rowsMax, props.placeholder]);
}, [rowsMax, rowsMin, props.placeholder]);

React.useEffect(() => {
const handleResize = debounce(() => {
Expand Down Expand Up @@ -123,7 +125,7 @@ const TextareaAutosize = React.forwardRef(function TextareaAutosize(props, ref)
onChange={handleChange}
ref={handleRef}
// Apply the rows prop to get a "correct" first SSR paint
rows={rows || 1}
rows={rowsMin}
style={{
height: state.outerHeightStyle,
// Need a large enough different to allow scrolling.
Expand Down Expand Up @@ -159,13 +161,19 @@ TextareaAutosize.propTypes = {
*/
placeholder: PropTypes.string,
/**
* Minimum number of rows to display.
* Use `rowsMin` instead. The prop will be removed in v5.
*
* @deprecated
*/
rows: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
/**
* Maximum number of rows to display.
*/
rowsMax: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
/**
* Minimum number of rows to display.
*/
rowsMin: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
/**
* @ignore
*/
Expand Down