Pikas UI

@pikas-ui/textarea

This package contains a textarea component that can be used in your application.

Change Log

Requirements

To use this package, you must install the @pikas-ui/styles package.

Installation

You can install this package using npm, yarn, or pnpm.

npm install @pikas-ui/textarea

yarn add @pikas-ui/textarea

pnpm add @pikas-ui/textarea

Usage

Textarea

With the Textarea component, you can create a textarea.

Textarea label

Eu est labore ea laborum laborum mollit non minim eu commodo.

import { Textarea } from '@pikas-ui/textarea';

const Example: React.FC = () => {
  return (
    <Textarea
      label="Textarea label"
      description="Eu est labore ea laborum laborum mollit non minim eu commodo."
      required
      height={200}
    />
  );
};

Props

Props extends TextareaHTMLAttributes<HTMLTextAreaElement>

Prop	Description	Type	Default
`label`	The label of the textarea.	`string` or `ReactNode`	-
`boxShadow`	The box shadow of the textarea.	`PikasShadow`	`"inner-md"`
`borderRadius`	The border radius of the textarea.	`PikasRadius`	`"md"`
`padding`	The padding of the textarea.	`TextareaPadding`	`"md"`
`fontSize`	The font size of the textarea.	`PikasFontSize`	`"em-base"`
`colorName`	The color of the textarea.	`PikasColors`	-
`colorHex`	The color hex of the textarea.	`string`	-
`placeholderColorName`	The placeholder color of the textarea.	`PikasColors`	`"black-light"`
`placeholderColorHex`	The placeholder color hex of the textarea.	`string`	-
`borderColorName`	The border color of the textarea.	`PikasColors`	`"transparent"`
`borderColorHex`	The border color hex of the textarea.	`string`	-
`borderWidth`	The border width of the textarea.	`number`	`0`
`textError`	The error text of the textarea.	`string`	-
`css`	The css of the textarea.	`TextareaCSS`	-
`outline`	The outline of the textarea.	`boolean`	`true`
`resize`	The resize of the textarea.	`TextareaResize`	`"none"`
`description`	The description of the textarea.	`string`	-
`width`	The width of the textarea.	`string or number`	`"100%"`
`minWidth`	The min width of the textarea.	`string or number`	-
`maxWidth`	The max width of the textarea.	`string or number`	`"100%"`
`height`	The height of the textarea.	`string or number`	`300px`
`minHeight`	The min height of the textarea.	`string or number`	-
`maxHeight`	The max height of the textarea.	`string or number`	-
`required`	The required of the textarea.	`boolean`	`false`
`info`	Add a info icon with a tooltip.	`string`	-
`data`	The data of the textarea.	`DOMStringMap`	-

Contributing

This documentation can be edited on GitHub here