You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+48-22Lines changed: 48 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,39 +8,61 @@
8
8
9
9
# ts-inputs
10
10
11
-
This is an opinionated TypeScript Starter kit to help kick-start development of your next Bun package.
11
+
A collection of smart, type-safe input components for Vue.js that provides automatic formatting, validation, and internationalization support. Built to make form input handling both powerful and developer-friendly.
12
12
13
13
## Features
14
14
15
-
This Starter Kit comes pre-configured with the following:
15
+
ts-inputs comes with the following powerful features:
16
16
17
-
- 🛠️ [Powerful Build Process](https://github.com/oven-sh/bun) - via Bun
18
-
- 💪🏽 [Fully Typed APIs](https://www.typescriptlang.org/) - via TypeScript
19
-
- 📚 [Documentation-ready](https://vitepress.dev/) - via VitePress
20
-
- ⌘ [CLI & Binary](https://www.npmjs.com/package/bunx) - via Bun & CAC
21
-
- 🧪 [Built With Testing In Mind](https://bun.sh/docs/cli/test) - pre-configured unit-testing powered by [Bun](https://bun.sh/docs/cli/test)
- 🎨 [ESLint](https://eslint.org/) - for code linting _(and formatting)_
24
-
- 📦️ [pkg.pr.new](https://pkg.pr.new) - Continuous (Preview) Releases for your libraries
25
-
- 🐙 [GitHub Actions](https://github.com/features/actions) - runs your CI _(fixes code style issues, tags releases & creates its changelogs, runs the test suite, etc.)_
17
+
- 🎯 **Smart Input Components**
18
+
- Credit Card formatting with automatic card type detection
19
+
- Date formatting with customizable patterns
20
+
- Time formatting with 12h/24h support
21
+
- Numerical formatting with thousand/lakh grouping
22
+
- Google Places autocomplete integration
26
23
27
-
## Get Started
24
+
- 💪 **Type Safety**
25
+
- Full TypeScript support
26
+
- Type-safe props and events
27
+
- Intelligent autocompletion
28
+
29
+
- 🌈 **Developer Experience**
30
+
- Simple Vue.js integration
31
+
- Customizable formatting options
32
+
- Automatic validation
33
+
- Internationalization support
34
+
- Modern and clean UI
28
35
29
-
It's rather simple to get your package development started:
36
+
## Get Started
30
37
31
38
```bash
32
-
# you may use this GitHub template or the following command:
33
-
bunx degit stacksjs/ts-inputs my-pkg
34
-
cd my-pkg
39
+
# Install using your preferred package manager
40
+
npm install ts-inputs
41
+
# or
42
+
yarn add ts-inputs
43
+
# or
44
+
pnpm add ts-inputs
45
+
```
35
46
36
-
bun i # install all deps
37
-
bun run build # builds the library for production-ready use
47
+
Basic usage example:
38
48
39
-
# after you have successfully committed, you may create a "release"
40
-
bun run release # automates git commits, versioning, and changelog generations
41
-
```
49
+
```vue
50
+
<script setup lang="ts">
51
+
import { CreditCardInput, DateInput, NumeralInput, TimeInput } from 'ts-inputs'
42
52
43
-
_Check out the package.json scripts for more commands._
0 commit comments