Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flexcodelabs/flecodelabs-input
https://github.com/flexcodelabs/flecodelabs-input
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/flexcodelabs/flecodelabs-input
- Owner: flexcodelabs
- Created: 2022-07-31T08:45:05.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-07-31T11:01:34.000Z (over 2 years ago)
- Last Synced: 2023-03-11T18:46:15.148Z (almost 2 years ago)
- Language: TypeScript
- Size: 301 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
@flexcodelabs/input
[](https://www.npmjs.com/package/@flexcodelabs/input) [](https://www.npmjs.com/package/@flexcodelabs/input)
[Package Name](#@flexcodelabs/input)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Examples](#examples)
- [Props](#props)
## Features
- List of features
## Installation
`npm install @flexcodelabs/input`
or
`yarn add @flexcodelabs/input`
## Usage
```js
...
import Input from '@flexcodelabs/input';
// Normal input
// password input
// textarea
// Input with error message
// Input with success message
```
## Examples
[Source code](https://github.com/flexcodelabs/flecodelabs-input)
## Props
| Name | Type | Default | Required | Description |
| ------------ | -------------------------------------------------------------------- | ------- | -------- | ------------------------------------------- |
| label | `string` | - | `false` | input label |
| disabled | `boolean` | - | `false` | input disabled status |
| autoComplete | `string` | - | `false` | |
| inputClass | `string` | - | `false` | input custom class name |
| inputStyle | `CSSProperties` | - | `false` | input custom styles |
| error | `string` | - | `false` | error message |
| onChange | `func()` | - | `false` | |
| type | `string` | - | `false` | input type |
| success | `string` | - | `false` | success message |
| value | `string or number` | - | `true` | input value |
| name | `string` | - | `false` | input name |
| required | `boolean` | - | `false` | whether input field is required |
| showLabel | `boolean` | `true` | `false` | show or hide input label |
| textarea | `boolean` | - | `false` | whether to display textarea or normal input |
| placeholder | `string` | - | `false` | |
| showIcon | `ReactNode` | - | `false` | show icon for password input field |
| hideIcon | `ReactNode` | - | `false` | hide icon for password input field |
| className | `string` | - | `false` | custom class name |
| style | `CSSProperties` | - | `false` | custom styles |
| inputMode | `search, text, tel, none, url, email, numeric, decimal or undefined` | - | `false` | |