Skip to content

z-kit/z-textarea

Repository files navigation

z-textarea

Build SemVer License

A basic styled textarea for your web application

Table of contents

Install

The package is available to download through npm:

npm install z-textarea --save

Import as HTML/CSS component

The simple case

The package will be located inside the node_modules folder, you can import it into the HTML document as follows:

<link rel="stylesheet" href="node_modules/z-textarea/dist/style.css">

When bundling an web app

For bundlers that support CSS, like Webpack, you can use it like this:

require('z-textarea/dist/style.css');

Import as a Stateless Functional Component (SFC)

The package does not include the renderer, you can use any renderer that supports SFCs. You could use React, Preact, Inferno, etc.

Notice: This package contains CSS styling, you may need a bundler that's capable of requiring CSS files like Webpack with css-loader.

Once you have chosen the renderer you can include the package in your project as follows:

// Assuming the React renderer is being used
const React = require('react');
const render = require('react-dom').render;

// Passing the render function when importing
const ZTextarea = require('z-textarea')(React.createElement);

// Render it on page, using JSX here :)
render(<ZTextarea />, document.body);

How to use

CSS component

Just add the HTML structure and CSS classes to reproduce the UI component.

Class hierarchy

Recommended HTML tags Parent Class Description Type
div, section, main, article, fieldset root .z-textarea Root container Block
Any containing .z-textarea root .z-textarea--label Makes space for a floating label Modifier
Any containing .z-textarea root .z-textarea--success Renders a green border to indicate success Modifier
Any containing .z-textarea root .z-textarea--warning Renders a yellow border to indicate warning Modifier
Any containing .z-textarea root .z-textarea--danger Renders a reddish border to indicate danger Modifier
Any containing .z-textarea root .z-textarea--error Renders a red border to indicate error Modifier
Any containing .z-textarea root .z-textarea--dark Makes the textarea text white so it can be read easier on dark backgrounds Modifier
Any containing .z-textarea root .z-textarea__label Renders a floating label Element

Full working example:

<div class="z-textarea">
  <textarea placeholder="Type something"></textarea>
</div>

Stateless Functional Component

Render the HTML by using the SFC and passing props.

Supported Props

Prop name Expected Type Description
label string or TextNode The floating label to render
color string A custom border color that you might pass to override the defaults
success boolean Pass true to indicate success and render a green border
warning boolean Pass true to indicate warning and render a yellow border
danger boolean Pass true to indicate danger and render a reddish border
error boolean Pass true to indicate error and render a red border
dark boolean Pass true to indicate the textarea is in a dark background and text will be white

Note that you can pass any attribute compatible with textarea that it will be automatically passed through.

Full example (JSX):

<ZTextarea placeholder="Type something" />

Theming

You can theme z-textarea using CSS Variables!

The list of variables available is below:

Variable Expected type Description
--primary-color color The border-color for selected textarea
--success-color color The border-color for selected success textarea
--warning-color color The border-color for selected warnings textarea
--danger-color color The border-color for selected danger textarea
--error-color color The border-color for selected errored textarea
--neutral-border-color color The border-color for idle textarea
--neutral-color color The text color for placeholders/floating labels
--dark-color color The background color for textarea labels

LICENSE

MIT