z-input

A basic styled text input for your web application

z-input
Table of contents
Install
- Import as HTML/CSS component
- Import as Stateless Functional Component (SFC)
How to use
- CSS component
- Stateless Functional Component
Theming
License

Install

The package is available to download through npm:

npm install z-input --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-input/dist/style.css">

When bundling an web app

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

require('z-input/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 ZInput = require('z-input')(React.createElement);

// Render it on page, using JSX here :)
render(<ZInput />, 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-input`	Root container	Block
Any containing `.z-input`	root	`.z-input--label`	Makes space for a floating label	Modifier
Any containing `.z-input`	root	`.z-input--box`	Renders a block input box good for search bars and headers	Modifier
Any containing `.z-input`	root	`.z-input--borderless`	Renders an input box without borders, preserving browser's outline	Modifier
Any containing `.z-input`	root	`.z-input--success`	Renders a green border to indicate success	Modifier
Any containing `.z-input`	root	`.z-input--warning`	Renders a yellow border to indicate warning	Modifier
Any containing `.z-input`	root	`.z-input--danger`	Renders a reddish border to indicate danger	Modifier
Any containing `.z-input`	root	`.z-input--error`	Renders a red border to indicate error	Modifier
Any containing `.z-input`	root	`.z-input--prefix`	Makes room in the inpux box for a prefix element	Modifier
Any containing `.z-input`	root	`.z-input--suffix`	Makes room in the inpux box for a suffix element	Modifier
Any containing `.z-input`	root	`.z-input--dark`	Makes the input text white so it can be read easier on dark backgrounds	Modifier
Any containing `.z-input`	root	`.z-input__label`	Renders a floating label	Element
Any containing `.z-input`	root	`.z-input__prefix`	Renders a prefix element before the input text	Element
Any containing `.z-input`	root	`.z-input__suffix`	Renders a suffix element after the input text	Element
Any containing `.z-input`	root	`.z-input--open`	Forces floating label to be open in an labeled input	Modifier
Any containing `.z-input`	root	`.z-input--closed`	Forces floating label to be closed in an labeled input	Modifier

Full working example:

<div class="z-input">
  <input type="text" placeholder="Type something">
</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
`borderless`	`boolean`	Pass true to render a borderless input box
`box`	`boolean`	Pass true to render an input box good for search bars and headers
`prefix`	`HTMLElement` or `TextNode`	The prefix to render before the input text
`suffix`	`HTMLElement` or `TextNode`	The suffix to render after the input text
`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 input is in a dark background and input text will be white
`isOpen`	`boolean` or `undefined`	Pass true or false to force the floating label to be open or closed

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

Full example (JSX):

<ZInput placeholder="Type something" />

Theming

Since 1.3.0 you can theme z-input using CSS Variables!

The list of variables available is below:

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

LICENSE

MIT

z-kit/z-input