Skip to content

Commit

Permalink
📝 Add jsdoc for custom InputText props
Browse files Browse the repository at this point in the history
  • Loading branch information
acusti committed Jan 8, 2024
1 parent 64e04a5 commit 0ae1c5e
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions packages/input-text/src/InputText.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,21 @@ export type Props = {
disabled?: boolean;
enterKeyHint?: InputHTMLAttributes<HTMLInputElement>['enterKeyHint'];
form?: string;
/**
* The initial value of the text input. If props.initialValue changes at
* any point, the new value will override the local state of the input.
*/
initialValue?: string;
list?: string;
max?: number;
maxHeight?: number | string;
maxLength?: number;
min?: number;
minLength?: number;
/**
* If true, input renders as a textarea element that automatically grows
* and shrinks to adjust to the length of its contents.
*/
multiLine?: boolean;
multiple?: boolean;
name?: string;
Expand All @@ -29,10 +37,15 @@ export type Props = {
placeholder?: string;
readOnly?: boolean;
required?: boolean;
/** If true, the contents of the input are selected when it’s focused. */
selectTextOnFocus?: boolean;
size?: number;
step?: number;
style?: React.CSSProperties;
/**
* If true, pressing enter/return submits the <form> that the input is a
* part of, or else blurs the input if no form is found.
*/
submitOnEnter?: boolean;
tabIndex?: number;
title?: string;
Expand Down

0 comments on commit 0ae1c5e

Please sign in to comment.