Skip to content

stacksjs/ts-inputs

Repository files navigation

Social Card of this repo

npm version GitHub Actions Commitizen friendly

TS-Inputs

A TypeScript library providing specialized input handling and formatting for various data types.

Overview

TS-Inputs is a modular library that provides specialized input handling, formatting, and validation for different types of data. It's designed to be used in web applications where precise input control and formatting are required.

Features

  • Credit Card Input: Formatting and validation for credit card numbers
  • Date Input: Specialized date input handling
  • Time Input: Time format handling
  • Numeral Input: Number formatting and validation
  • General Input: Common input handling utilities
  • Cursor Tracker: Input cursor position tracking

Project Structure

src/
├── common/           # Shared utilities and types
│   ├── types.ts     # Common type definitions
│   └── utils.ts     # Shared utility functions
├── credit-card/     # Credit card input handling
├── cursor-tracker/  # Cursor position tracking
├── date/           # Date input handling
├── general/        # General input utilities
├── numeral/        # Number formatting
└── time/           # Time input handling

Common Utilities

The library provides several common utilities and types:

  • RequireExactlyOne: Type utility for requiring exactly one property from a set
  • DelimiterType: Type definition for input delimiters
  • BlocksType: Type for input block definitions
  • Various interfaces for input formatting and delimiter handling

Usage

import { creditCard, date, numeral, time } from 'ts-inputs'

// Example usage with credit card input
const formattedCard = creditCard.format('4111111111111111')
// Result: '4111 1111 1111 1111'

Installation

npm install ts-inputs
# or
yarn add ts-inputs

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Testing

bun test

Changelog

Please see our releases page for more information on what has changed recently.

Stargazers

Stargazers

Community

For help, discussion about best practices, or any other conversation that would benefit from being searchable:

Discussions on GitHub

For casual chit-chat with others using this package:

Join the Stacks Discord Server

Postcardware

"Software that is free, but hopes for a postcard." We love receiving postcards from around the world showing where Stacks is being used! We showcase them on our website too.

Our address: Stacks.js, 12665 Village Ln #2306, Playa Vista, CA 90094, United States 🌎

Credits

Sponsors

We would like to extend our thanks to the following sponsors for funding Stacks development. If you are interested in becoming a sponsor, please reach out to us.

License

The MIT License (MIT). Please see LICENSE for more information.

Made with 💙