1.0.2 • Published 8 months ago

svelte-pin-input v1.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
8 months ago

svelte-pin-input

A Svelte component for entering verification/PIN codes.

npm version

Installation:

npm install svelte-pin-input

or

yarn add svelte-pin-input

Usage:

Use SveltePinInput in your component like this:

Initialize a variable to hold the inputed code and set up an event listener for the updateValue event to keep track of the user's input.

let code = '';

on:updateValue={(e) => (code = e.detail.value)}

Example

<script>
	import SveltePinInput from "svelte-pin-input";

    let code = '';

    const customStyle = `background-color: lightblue;
    text-align:center; color: black; width: 50px; height: 50px; border-radius: 10px; border: grey; margin-right: 10px`;

    const customInvalidStyle = `background-color: pink;
    text-align:center; color: black; width: 50px; height: 50px; border-radius: 10px; border: grey; margin-right: 10px`;

</script>

<SveltePinInput
    size={5}
    isInputHidden={false}
    inputType="mixed"
    inputStyle= {customStyle}
    inputStyleInvalid={customInvalidStyle}
    isValid={false}
    containerstyle="display: flex"
    on:updateValue={(e) => (code = e.detail.value)}
/>

isInputHidden={true}

Screenshot

inputType="number"

Screenshot

inputType="text"

Screenshot

inputType="mixed"

Screenshot

Props

Common props you may want to specify include:

Prop NameInitial ValueTypeDescription
size6numberThe size of the input fields.
inputType'text''text' \| 'number' \| 'mixed'The type of input ('text', 'number', or 'mixed').
containerstyleundefinedstringOptional CSS styles for the inputs container.
inputStyleundefinedstringOptional CSS styles for the input elements.
inputStyleInvalidundefinedstringOptional CSS styles for invalid input elements.
patternundefinedRegExpOptional pattern for input validation.
isInputHiddentruebooleanWhether the input is hidden (default: true).
disabledfalsebooleanWhether the input is disabled (default: false).
isValidtruebooleanWhether the input is valid (default: true).

License

MIT Licensed. Copyright (c) Chiamaka Umeh 2023.

1.0.2

8 months ago

2.0.3

4 years ago

1.0.1

8 months ago

2.0.2

4 years ago

2.0.0

4 years ago

1.0.0

4 years ago

0.0.2

4 years ago