z-input

A basic styled text input for your web application

Table of contents

• 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

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

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:

LICENSE

MIT