Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/javadbat/jb-input
extended input box web component
https://github.com/javadbat/jb-input
Last synced: 7 days ago
JSON representation
extended input box web component
- Host: GitHub
- URL: https://github.com/javadbat/jb-input
- Owner: javadbat
- License: mit
- Created: 2020-05-04T08:28:40.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-11T10:21:38.000Z (11 days ago)
- Last Synced: 2024-12-11T11:18:47.911Z (11 days ago)
- Language: TypeScript
- Size: 164 KB
- Stars: 12
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jb-input
[](https://www.webcomponents.org/element/jb-input)
[](https://raw.githubusercontent.com/javadbat/jb-input/master/LICENSE)
[](https://www.npmjs.com/package/jb-input)
text input web component with these benefit:
- easy to add custom regex or function validation.
- multiple validation with different message.
- support both RTL and LTR.
- add label and message in UX friendly format.
- customizable ui with css variable sp you can have multiple style in different scope of your app.
- extendable so you can create your own custom input base on jb-input like [jb-number-input](https://github.com/javadbat/jb-number-input).
- can accept persian number char and convert them to english char in value.
sample: [codepen](https://codepen.io/javadbat/pen/dyNwddd)
## using with JS frameworks
to use this component in **react** see [`jb-input/react`](https://github.com/javadbat/jb-input/tree/main/react);
## instructions
### install
#### using npm
```cmd
npm i jb-input
```
in one of your js in page
```js
import 'jb-input';
```
in your html or jsx
```html
```
#### using cdn
you can just add script tag to your html file and then use web component how ever you need
```HTML
```
### get/set value
```js
//get value
const inputValue = document.getElementByTagName('jb-input').value;
//set value
document.getElementByTagName('jb-input').value = "new string";
```
### events
```js
document.getElementByTagName('jb-input').addEventListener('change',(event)=>{console.log(event.target.value)});
document.getElementByTagName('jb-input').addEventListener('keyup',(event)=>{console.log(event.target.value)});
document.getElementByTagName('jb-input').addEventListener('keydown',(event)=>{console.log(event.target.value)});
document.getElementByTagName('jb-input').addEventListener('keypress',(event)=>{console.log(event.target.value)});
document.getElementByTagName('jb-input').addEventListener('input',(event)=>{console.log(event.target.value)});
document.getElementByTagName('jb-input').addEventListener('beforeinput',(event)=>{console.log(event.target.value)});
// when user press enter on keyboard(dispatched on onKeyup)
document.getElementByTagName('jb-input').addEventListener('enter',(event)=>{console.log(event.target.value)});
```
### set validation
jb-input use [jb-validation](https://github.com/javadbat/jb-validation) inside to handle validation. so for more information you can read [jb-validation](https://github.com/javadbat/jb-validation) documentation.
for simple usage you can set validation to your input:
```js
//you have 2 ways:
//1- set list directly
titleInput.validation.list = [
{
validator: /.{3}/g,
message: 'عنوان حداقل باید سه کارکتر طول داشته باشد'
},
//you can use function as a validator too
{
validator: ({displayValue,value})=>{return value == "سلام"},
message: 'شما تنها میتوانید عبارت سلام را وارد کنید'
},
//you can also return string in validator if you want custom error message in some edge cases
{
validator: ({displayValue,value})=>{
if(value.includes("*")){
return 'you cant write * in your text'
}
return true;
},
message: 'default error when return false'
},
];
//2- pass a function that returns the validation list so on each validation process we execute your callback function and get the needed validation list
const result = document.getElementByTagName('jb-input').validation.addValidationListGetter(getterFunction)
```
### check validation
like any other jb design system you can access validation by `validation` property:
```js
//access validation module
document.getElementByTagName('jb-input').validation
// check if input pass all the validations. showError is a boolean that determine your intent to show error to user on invalid status.
const result = await document.getElementByTagName('jb-input').validation.checkValidity({showError})
//or
const result = document.getElementByTagName('jb-input').validation.checkValiditySync({showError})
//return boolean of if inputted string is valid
const result = document.getElementByTagName('jb-input').checkValidity()
//orreturn boolean and show error
const result = document.getElementByTagName('jb-input').reportValidity()
```
### intercept user input
I don't recommend this in most cases but sometimes you need to change what user input in the text field or prevent user from typing or paste the wrong value into the field in this scenario we have a tools to let you do this. to doing so just register a interceptor function like this:
```ts
this.validation.addStandardValueCallback((inputtedString:string, oldValue:JBInputValue, prevResult:JBInputValue):JBInputValue=>{
//here you can check new string, old value and the value object that return by previous StandardValueCallback if you register multiple callback to modify value
return {
// the value we return as dom.value
value:string,
//the value we ser into the input box that final user see
displayValue:string
}
});
```
### custom inputs
if you want something more than just simple input please check this components that use jb-input but add extra validation and input check layer for better user experience:
- [jb-number-input](https://github.com/javadbat/jb-number-input) for input number
- [jb-payment-input](https://github.com/javadbat/jb-payment-input) for input bank card number and SHABA number
- [jb-date-input](https://github.com/javadbat/jb-date-input) for input date value
- [jb-national-input](https://github.com/javadbat/jb-national-input) for input national ID (کد ملی) value
- [jb-mobile-input](https://github.com/javadbat/jb-mobile-input) for input mobile value
- [jb-time-input](https://github.com/javadbat/jb-time-input) for input time value
### other attribute
| atribute name | description |
| ------------- | ------------- |
| name | name you want to set to actual input element `` |
| message | in botton of input we show small message for example "user name must be at least 5 char" |
| autocomplete | set autocomplete directly into dom element in case you need it |
| direction | set web-component direction defualt set is rtl but if you need ltr use `` |
| disabled | disable the input |
| inputmode | set input mode help mobile device to open proper keyboard for your input like `url`, `search` and `numeric` |
### set custom style
in some cases in your project you need to change defualt style of web-component for example you need zero margin or different border-radius and etc.
if you want to set a custom style to this web-component all you need is to set css variable in parent scope of web-component
| css variable name | description |
| ------------- | ------------- |
| --jb-input-margin | web-component margin default is `0 0` |
| --jb-input-border-radius | web-component border-radius default is `16px` |
| --jb-input-border-color | border color of select in normal mode |
| --jb-input-border-color-focus | border color of select in normal mode |
| --jb-input-bgcolor | background color of input |
| --jb-input-border-bottom-width | border bottom thickness default is `3px` |
| --jb-input-label-font-size | font size of input label default is `0.8em` |
| --jb-input-label-color | change label color default is `#1f1735` |
| --jb-input-label-margin | change label margin default is `0 4px` |
| --jb-input-message-font-size | font size of message we show under input |
| --jb-input-message-color | set under box message color defualt is `#929292` |
| --jb-input-message-error-color | change color of error we show under input default is `red` |
| --jb-input-height | height of input default is 40px |
| --jb-input-placeholder-color | change placeholder color |
| --jb-input-placeholder-font-size | change placeholder font-size |
| --jb-input-value-font-size | input value font-size |
| --jb-input-value-color | input value color |
| --jb-input-input-padding | set input inner padding default is `2px 12px 0 12px` |
| --jb-input-input-text-align | set input element text align for example if you have number Input and want to make it left |
| --jb-input-input-direction | set input element direction to other than inherited value from it's parent element |
| --jb-input-input-font-weight | set input value font-weight default is `initial` (browser setting) |
| --jb-input-box-shadow | set box shadow of input |
| --jb-input-box-shadow-focus | set box shadow of input on focus |
| --jb-input-border-width | border width default is `1px` |
| --jb-input-label-margin | label margin default is `0` |
| --jb-input-label-font-weight | label font weight default is `300` |
| --jb-input-box-overflow | input box overflow default is `hidden` |
## add custom element in input box
in jb-input you can put icon or any other custom html DOM in input box. to doing so you just have to plae custom DOM in `jb-input` tag and add `slot="start-section"` or `slot="end-section"` to place it before or after input field.
example:
```HTML
after
before
```
## Other Related Docs:
- see [jb-input-react](https://github.com/javadbat/jb-input/tree/main/react) if you want to use this component in react.
- see [All JB Design system Component List](https://github.com/javadbat/design-system/blob/master/docs/component-list.md) for more components.
- use [Contribution Guide](https://github.com/javadbat/design-system/blob/master/docs/contribution-guide.md) if you want to contribute in this component.