Security News
NIST Misses 2024 Deadline to Clear NVD Backlog
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
@commercetools-uikit/multiline-text-input
Advanced tools
A controlled text input component for multi-line strings with validation states.
A controlled text input component for multi-line strings with validation states.
yarn add @commercetools-uikit/multiline-text-input
npm --save install @commercetools-uikit/multiline-text-input
Additionally install the peer dependencies (if not present)
yarn add react react-intl
npm --save install react react-intl
import MultilineTextInput from '@commercetools-uikit/multiline-text-input';
const Example = () => (
<MultilineTextInput
value="foo"
onChange={
(/** event */) => {
// alert(event.target.value)
}
}
/>
);
export default Example;
Props | Type | Required | Default | Description |
---|---|---|---|---|
name | string | Used as HTML name of the input component. property | ||
aria-invalid | boolean | Indicate if the value entered in the input is invalid. | ||
aria-errormessage | string | HTML ID of an element containing an error message related to the input. | ||
autoComplete | string | Used as HTML autocomplete property | ||
id | string | Used as HTML id property. An id is auto-generated when it is not specified. | ||
value | string | ✅ | Value of the input component. | |
onChange | ChangeEventHandler | Called with an event containing the new value. Required when input is not read only. Parent should pass it back as value. | ||
onBlur | FocusEventHandler | Called when input is blurred | ||
onFocus | FocusEventHandler | Called when input is focused | ||
isAutofocussed | boolean | Focus the input on initial render | ||
defaultExpandMultilineText | boolean | false | Expands multiline text input initially | |
isDisabled | boolean | Indicates that the input cannot be modified (e.g not authorized, or changes currently saving). | ||
isReadOnly | boolean | Indicates that the field is displaying read-only content | ||
placeholder | string | Placeholder text for the input | ||
hasError | boolean | Indicates that input has errors | ||
hasWarning | boolean | Control to indicate on the input if there are selected values that are potentially invalid | ||
horizontalConstraint | union Possible values: , 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 'scale', 'auto' | Horizontal size limit of the input fields. | ||
rightActionIcon | ReactElement | Custom action icon to be displayed on the right side of the input. | ||
rightActionProps | TSecondaryButtonIconProps | Props for the right-action icon-button. Required when rightActionIcon is provided.
At least a label and an onClick prop/function need to be provided. | ||
isCondensed | boolean | Set this to true to reduce the paddings of the input allowing the input to display
more data in less space. | ||
maxRows | number | Set this to value to determine the maximum text rows of the text area. Any text overflow past this row number would implement a scroll |
MultilineTextInput.isEmpty
Returns true
when the value is considered empty, which is when the value is empty or consists of spaces and linebreaks only.
MultilineTextInput.isEmpty(''); // -> true
MultilineTextInput.isEmpty(' '); // -> true
MultilineTextInput.isEmpty('\n'); // -> true
MultilineTextInput.isEmpty('tree'); // -> false
Whenever a user input can hold multiline strings this MultilineTextInput
component is recommended
Not recommended to be used when the content is single-lined (e.g email address, password etc.)
The horizontal constraint is not recommended to be smaller than s
since content may cut off
FAQs
A controlled text input component for multi-line strings with validation states.
The npm package @commercetools-uikit/multiline-text-input receives a total of 0 weekly downloads. As such, @commercetools-uikit/multiline-text-input popularity was classified as not popular.
We found that @commercetools-uikit/multiline-text-input demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.