多行文本
Mantine Core 的独立组件,请不要替换为 JGuang UI/Base UI 的同名 API。
安装
npm install @mantine/core@9.7.1 @mantine/hooks@9.7.1
入口引入 @mantine/core/styles.css,并在根组件使用 MantineProvider;通过 forceColorScheme 同步深浅色主题。
使用与验证
在左侧选择组件,在预览中操作它的状态;使用“查看代码”检查真实源码。安装后执行类型检查和构建,再验证键盘焦点、手机布局与深浅色主题。
来源
https://github.com/mantinedev/mantine/tree/f0e2bc6d28b0f0b8aaefb5b859937bf77f539df7 MIT 许可证;不包括付费内容。下方提供上游英文参考内容,中文使用指南已适配;上游详细参考暂保留英文。
版本与兼容性
固定的 Mantine Core 9.7.1 要求 React 和 React DOM 满足 ^19.2.0,并配套 @mantine/hooks@9.7.1。此条件来自实际 npm 包的 peerDependencies。React 18 或其他不兼容版本不能强行安装;先向项目负责人说明升级影响并确认方案,不使用 --force/--legacy-peer-deps 掩盖冲突。入口的原生 Provider 开启 theme.respectReducedMotion,并用 forceColorScheme 控制深浅色。
适用场景
编辑多行文本并可自动调整高度。
本地示例使用的原生参数
以下参数由本地、经过类型检查的 JSX 示例提取,按所属组件区分。不是全部属性清单;完整签名和继承关系见下方固定源码参考。
| 组件参数 | 说明 |
|---|---|
Textarea.disabled | 禁用用户输入或操作,不等同于只读。 |
Textarea.error | 本地错误展示,本身不执行校验。 |
Textarea.readOnly | 阻止编辑并保留只读交互。 |
Textarea.label | 可见标签或当前组件的标签内容。 |
Textarea.autosize | 根据内容自动调整输入区域高度。 |
Textarea.minRows | 文本区域最少行数。 |
交互与状态检查
当前场景:默认、禁用、校验错误、只读。切换支持的禁用、错误或只读场景后检查真实行为;无此原生状态的组件不会被强行添加统一属性。验证键盘焦点和退出方式,修改值后按原生回调签名连接业务状态。
业务接入边界
示例内容和状态仅保存在本地,不提供服务端持久化、授权或数据请求。静态展示组件不应被当作已完成的业务流程。
宿主配置
先安装固定版本 @mantine/core 和 @mantine/hooks,在入口引入 @mantine/core/styles.css,并使用 MantineProvider。示例的 theme 和 variant 是 JGuang 编写的宿主参数,不是所有原生组件都接受的统一 API;通过 forceColorScheme 同步应用主题。源码面板中的原生实现仅供阅读,使用 npm 导出,不要单独复制内部实现。此批只覆盖 Core,不包括日期、图表和表单扩展包。上游详细说明保留英文,不宣称全文中文化。
可运行用法
以下代码使用资源原生 API;不是把其他设计系统的同名组件替换进来。
import { useState } from 'react';
import * as M from '@mantine/core';
import '@mantine/core/styles.css';
function ComponentPreview({ variant = 'Default' }: { variant?: string }) {
const disabled = variant === "Disabled";
const invalid = variant === "Invalid";
const readOnly = variant === "Read only";
return <M.Textarea disabled={disabled} error={invalid ? "Message is required / 请填写消息" : undefined} readOnly={readOnly} label="Message / 消息" autosize minRows={3} />;
}
export default function Example({ variant = 'Default', theme = 'light' }: { variant?: string; theme?: 'light' | 'dark' }) {
return <M.MantineProvider forceColorScheme={theme} theme={{ respectReducedMotion: true }}><ComponentPreview variant={variant} /></M.MantineProvider>;
}
可用状态与示例
默认、禁用、校验错误、只读
示例遵循 Mantine 原生 API。支持多状态的输入组件可将示例中的 variant 改为 Disabled、Invalid 或 Read only;这些只是示例标签,不是新增的组件属性。改造时保留组件要求的数据、受控值、store 和复合子组件结构。
Usage
Loading state
Set loading prop to display a loading indicator. By default, the loader is displayed on the right side of the input.
You can change the position with the loadingPosition prop to 'left' or 'right'. This is useful for async operations like API calls, searches, or validations:
Controlled
import { useState } from 'react';
import { Textarea } from '@mantine/core';
function Demo() {
const [value, setValue] = useState('');
return (
<Textarea
value={value}
onChange={(event) => setValue(event.currentTarget.value)}
/>
);
}
Uncontrolled
Textarea can be used with uncontrolled forms the same way as a native textarea element.
Set the name attribute to include textarea value in FormData object on form submission.
To control the initial value in uncontrolled forms, use the defaultValue prop.
Example usage of uncontrolled Textarea with FormData:
import { Textarea } from '@mantine/core';
function Demo() {
return (
<form
onSubmit={(event) => {
event.preventDefault();
const formData = new FormData(event.currentTarget);
console.log('Textarea value:', formData.get('message'));
}}
>
<Textarea label="Enter your message" name="message" />
<button type="submit">Submit</button>
</form>
);
}
Bottom section
Use bottomSection prop to render content inside the input border at the bottom.
This is useful for displaying character counters, hints, or other supplementary information:
Autosize
The autosize textarea height grows until maxRows are reached or indefinitely if maxRows is not set:
Enable resize
By default, resize is none;
to enable it, set the resize prop to vertical or both:
Error state
Success state
Disabled state
源码参数参考
以下实现签名和类型从本地固定版本源码生成。保留可选属性、原生继承类型、联合分支和 never 限制;不会将其他设计系统的 API 混入。forwardRef 实现中的 ref 属于 React 引用,不是新增业务属性。此区域是原始类型参考,不是上游说明的全文翻译。
Textarea(props)
export interface TextareaProps
extends
BoxProps,
__BaseInputProps,
StylesApiProps<TextareaFactory>,
ElementProps<'textarea', 'size'> {
__staticSelector?: string;
/** If set, enables textarea height growing with its content @default false */
autosize?: boolean;
/** Maximum rows for autosize textarea to grow, ignored if `autosize` prop is not set */
maxRows?: number;
/** Minimum rows of autosize textarea, ignored if `autosize` prop is not set */
minRows?: number;
/** Controls `resize` CSS property @default 'none' */
resize?: React.CSSProperties['resize'];
/** Content rendered at the bottom of the input, inside the border */
bottomSection?: React.ReactNode;
/** Props passed down to the `bottomSection` element */
bottomSectionProps?: React.ComponentProps<'div'>;
}
export type TextareaFactory = Factory<{
props: TextareaProps;
ref: HTMLTextAreaElement;
stylesNames: __InputStylesNames;
}>;
export type Mod = Record<string, any> | string;
export type BoxMod = Mod | Mod[] | BoxMod[];
export interface BoxProps extends MantineStyleProps {
/** Class added to the root element, if applicable */
className?: string | undefined;
/** Inline style added to root component element, can subscribe to theme defined on MantineProvider */
style?: MantineStyleProp;
/** CSS variables defined on root component element */
__vars?: CssVarsProp;
/** `size` property passed down the HTML element */
__size?: string;
/** Breakpoint above which the component is hidden with `display: none` */
hiddenFrom?: MantineBreakpoint;
/** Breakpoint below which the component is hidden with `display: none` */
visibleFrom?: MantineBreakpoint;
/** Determines whether component should be hidden in light color scheme with `display: none` */
lightHidden?: boolean;
/** Determines whether component should be hidden in dark color scheme with `display: none` */
darkHidden?: boolean;
/** Element modifiers transformed into `data-` attributes, for example, `{ 'data-size': 'xl' }`, falsy values are removed */
mod?: BoxMod;
}
export type ElementProps<
ElementType extends React.ElementType,
PropsToOmit extends string = never,
> = Omit<React.ComponentProps<ElementType>, 'style' | PropsToOmit>;
export interface CSSProperties extends React.CSSProperties {
[key: string]: any;
}
type MantineStyle = CSSProperties | ((theme: MantineTheme) => CSSProperties);
export type MantineStyleProp = MantineStyle | MantineStyle[] | MantineStyleProp[] | undefined;
export type CssVariable = `--${string}`;
export type CssVariables<Variable extends string = CssVariable> = Partial<Record<Variable, string>>;
export type CssVars<Variable extends string = CssVariable> =
| CssVariables<Variable>
| ((theme: MantineTheme) => CssVariables<Variable>)
| CssVars<Variable>[];
export type CssVarsProp<Variable extends string = CssVariable> =
| CssVars<Variable>
| CssVars<Variable>[];
type WrapperProps = React.ComponentProps<'div'> & DataAttributes;
export interface __BaseInputProps extends __InputWrapperProps, __InputProps {
/** Props passed down to the root element */
wrapperProps?: WrapperProps;
}
export type __InputStylesNames = InputStylesNames | InputWrapperStylesNames;
export type InputStylesNames = 'input' | 'wrapper' | 'section' | 'bottomSection';
export interface __InputProps {
/** Content section displayed on the left side of the input */
leftSection?: React.ReactNode;
/** Left section width, used to set `width` of the section and input `padding-left`, by default equals to the input height */
leftSectionWidth?: React.CSSProperties['width'];
/** Props passed down to the `leftSection` element */
leftSectionProps?: React.ComponentProps<'div'>;
/** Sets `pointer-events` styles on the `leftSection` element. Use `'all'` when section contains interactive elements (buttons, links). @default 'none' */
leftSectionPointerEvents?: React.CSSProperties['pointerEvents'];
/** Content section displayed on the right side of the input */
rightSection?: React.ReactNode;
/** Right section width, used to set `width` of the section and input `padding-right`, by default equals to the input height */
rightSectionWidth?: React.CSSProperties['width'];
/** Props passed down to the `rightSection` element */
rightSectionProps?: React.ComponentProps<'div'>;
/** Sets `pointer-events` styles on the `rightSection` element. Use `'all'` when section contains interactive elements (buttons, links). @default 'none' */
rightSectionPointerEvents?: React.CSSProperties['pointerEvents'];
/** Sets `required` attribute on the `input` element */
required?: boolean;
/** Key of `theme.radius` or any valid CSS value to set `border-radius`, numbers are converted to rem @default theme.defaultRadius */
radius?: MantineRadius;
/** Sets `disabled` attribute on the `input` element */
disabled?: boolean;
/** Controls input `height`, horizontal `padding`, and `font-size` @default 'sm' */
size?: MantineSize | (string & {});
/** Determines whether the input should have `cursor: pointer` style. Use when input acts as a button-like trigger (e.g., `component="button"` for Select/DatePicker). @default false */
pointer?: boolean;
/** Determines whether the input should have red border and red text color when the `error` prop is set @default true */
withErrorStyles?: boolean;
/** Determines whether the input should have green border when the `success` prop is set @default true */
withSuccessStyles?: boolean;
/** HTML `size` attribute for the input element (number of visible characters) */
inputSize?: string;
/** Section to be displayed when the input is `__clearable` and `rightSection` is not defined */
__clearSection?: React.ReactNode;
/** Determines whether the `__clearSection` should be displayed if it is passed to the component, has no effect if `rightSection` is defined */
__clearable?: boolean;
/** Determines how the clear button and rightSection are rendered @default 'both' */
__clearSectionMode?: ClearSectionMode;
/** Right section displayed when both `__clearSection` and `rightSection` are not defined */
__defaultRightSection?: React.ReactNode;
/** Displays loading indicator in the left or right section @default false */
loading?: boolean;
/** Position of the loading indicator @default 'right' */
loadingPosition?: 'left' | 'right';
/** Content section displayed at the bottom of the input, inside the border */
__bottomSection?: React.ReactNode;
/** Props passed down to the `__bottomSection` element */
__bottomSectionProps?: React.ComponentProps<'div'>;
}
export type InputWrapperStylesNames =
| 'root'
| InputLabelStylesNames
| InputDescriptionStylesNames
| InputErrorStylesNames
| InputSuccessStylesNames;
export interface __InputWrapperProps {
/** Contents of `Input.Label` component. If not set, label is not displayed. */
label?: React.ReactNode;
/** Contents of `Input.Description` component. If not set, description is not displayed. */
description?: React.ReactNode;
/** Contents of `Input.Error` component. If not set, error is not displayed. */
error?: React.ReactNode;
/** Contents of `Input.Success` component. If not set, success is not displayed. */
success?: React.ReactNode;
/** Adds required attribute to the input and a red asterisk on the right side of label @default false */
required?: boolean;
/** If set, the required asterisk is displayed next to the label. Overrides `required` prop. Does not add required attribute to the input. @default false */
withAsterisk?: boolean;
/** Props passed down to the `Input.Label` component */
labelProps?: InputLabelProps & DataAttributes & PlaceholderPolymorphicProps;
/** Props passed down to the `Input.Description` component */
descriptionProps?: InputDescriptionProps & DataAttributes & PlaceholderPolymorphicProps;
/** Props passed down to the `Input.Error` component */
errorProps?: InputErrorProps & DataAttributes & PlaceholderPolymorphicProps;
/** Props passed down to the `Input.Success` component */
successProps?: InputSuccessProps & DataAttributes & PlaceholderPolymorphicProps;
/** Render function to wrap the input element. Useful for adding tooltips, popovers, or other wrappers around the input. @default React.Fragment */
inputContainer?: (children: React.ReactNode) => React.ReactNode;
/** Controls order and visibility of wrapper elements. Only elements included in this array will be rendered. @default ['label', 'description', 'input', 'error'] */
inputWrapperOrder?: ('label' | 'input' | 'description' | 'error')[];
}
原生与外部类型
以下外部类型仍由 React 或资源自身依赖定义,没有手工展开为虚构属性。实际可用类型以安装版本的 TypeScript 检查为准。
Factory<{
props: TextareaProps;
ref: HTMLTextAreaElement;
stylesNames: __InputStylesNames;
}>
MantineStyleProps
React.CSSProperties
MantineTheme
Partial<Record<Variable, string>>
Record<Variable, string>
Variable
MantineBreakpoint
Record<string, any>
React.ReactNode
InputLabelProps
DataAttributes
PlaceholderPolymorphicProps
InputDescriptionProps
InputErrorProps
InputSuccessProps
React.ComponentProps<'div'>
MantineRadius
MantineSize
ClearSectionMode
StylesApiProps<TextareaFactory>
React.ElementType
Omit<React.ComponentProps<ElementType>, 'style' | PropsToOmit>
React.ComponentProps<ElementType>
ElementType
PropsToOmit
HTMLTextAreaElement
InputLabelStylesNames
InputDescriptionStylesNames
InputErrorStylesNames
InputSuccessStylesNames