/
TextAreaWithMessage.tsx
53 lines (50 loc) · 1.29 KB
/
TextAreaWithMessage.tsx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
import type { ReactElement } from "react";
import { forwardRef } from "react";
import type { FieldMessageContainerExtension } from "../FormMessageContainer";
import { FormMessageContainer } from "../FormMessageContainer";
import type { TextAreaProps } from "./TextArea";
import { TextArea } from "./TextArea";
/**
* @remarks \@since 2.5.0
*/
export type TextAreaWithMessageProps =
FieldMessageContainerExtension<TextAreaProps>;
/**
* This component is a simple wrapper for the `TextArea` and `FormMessage`
* components that should be used along with the `useTextField` hook to
* conditionally show help and error messages with a `TextArea`.
*
* Simple example:
*
* ```ts
* const [value, areaProps] = useTextField({
* id: "area-id",
* });
*
* return (
* <TextFieldWithMessage
* label="Label"
* placeholder="Placeholder"
* {...areaProps}
* />
* );
* ```
*
* @remarks \@since 2.5.0
*/
export const TextAreaWithMessage = forwardRef<
HTMLTextAreaElement,
TextAreaWithMessageProps
>(function TextAreaWithMessage(
{ messageProps, messageContainerProps, ...props },
ref
): ReactElement {
return (
<FormMessageContainer
{...messageContainerProps}
messageProps={messageProps}
>
<TextArea {...props} ref={ref} />
</FormMessageContainer>
);
});