@craydel/craydel-text-field

CraydelTextField

Installation

Get the latest version by NPM:

$ npm i @craydel/craydel-text-field

Register Plugin

If you use the plugin API, the component will be registered as a global component just like when including it with the script tag, but you won't need to re-register it through the components property in your own components.

Create the plugin file e.g craydel-components.js file.

// craydel-components.js
import Vue from 'vue'
import CraydelTextField from '@craydel/craydel-text-field/src/CraydelTextField.vue'

const Components = {
  CraydelTextField,
};

Object.keys(Components).forEach(name => {
  Vue.component(name, Components[name]);
});

export default Components;

Next reference the plugin file in your nuxt.config.js

// Plugins to run before rendering page: https://go.nuxtjs.dev/config-plugins
plugins: [
  '~/plugins/craydel-components.js'
]

Props

Name	Type	Default	Description
id	string	random ID	Sets the DOM id on the component.
placeholder	string	'Select'	Sets the component's placeholder text.
is-required	boolean	false	Puts component in a required state.
required-error	string	'Field is required'	Puts the component in an error state and passes through the custom required error message.
type	string	'text'	Sets input type. Options are: text, email, alpha, alphaNum, numeric, integer, decimal, url.
error-message	string	'text'	Puts the input in an error state and passes through a custom error message.
max-length	number	100	The maximum number of characters allowed in the field.
hint	string	undefined	Hint text.
prefix	string	undefined	Displays prefix text.
suffix	string	undefined	Displays suffix text.
no-validation	boolean	false	Removes the validation styling from the component.
disabled	boolean	false	Disables the component.
loading	boolean | string	false	Displays linear progress bar. Can either be a String which specifies which color is applied to the progress bar (any material color or theme color - primary, secondary, success, info, warning, error) or a Boolean which uses the primary color.

 

Events

Name	Description
change	Emitted when the input is changed by user interaction.
keydown	Emitted when any key is pressed.

 

Usage

An example showing a text field that allows decimals only.

<craydel-text-field
        type="decimal"
        suffix="%"
        placeholder="Enter percentage"
></craydel-text-field>