jb-textarea

simple textarea web component to input long text

• lightweight
• zero dependency
• help you manage validation in easy way
• config auto height grow ability with max height
• web component so you can use it with any framework you need

sample: https://codepen.io/javadbat/pen/poRZVXe

installation and setup

npm i jb-textarea

<jb-textarea label="توضیحات" value="" message="متن زیر باکس"></jb-textarea>

get and set value

document.querySelector("jb-textarea").value;
// retun inputed text
document.querySelector("jb-textarea").value = "salam";
set value to salam

set validation

jb-textarea use jb-validation inside to handle validation so for more information you can read it's documentation.
for simple usage you can set validation to your input:

//you have 2 ways: 
//1- set list directly 
    description.validation.list = [
        {
            validator: /.{3}/g,
            message: 'description must have 3 char at least'
        },
    //you can use function as a validator too
        {
            validator: (valueString)=>{return valueString == "hello"},
            message: 'you can only type hello in the box'
        },
    //you can also return string in validator if you want custom error message in some edge cases
        {
            validator: (valueString)=>{
               if(valueString.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-textarea').validation.addValidationListGetter(getterFunction)

check validation

like any other jb design system you can access validation by validation property:

//access validation module
document.getElementByTagName('jb-textarea').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 = document.getElementByTagName('jb-textarea').validation.checkValidity(showError)

events

document.querySelector("jb-textarea").addEventListener('change',func);
document.querySelector("jb-textarea").addEventListener('keydown',func);
document.querySelector("jb-textarea").addEventListener('keyup',func);
document.querySelector("jb-textarea").addEventListener('keypress',func);
document.querySelector("jb-textarea").addEventListener('input',func);

auto height grow

you can set autoHeight to true so when user type something and text overflow a textarea height component will grow by itself in boundary of --jb-textarea-min-height and --jb-textarea-max-height that you set by css variable

document.querySelector("jb-textarea").autoHeight = true;

the good point of set boundary with css variable is you can set different min or max base on device by CSS media queries.

set custom style

in some cases in your project you need to change default 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-textarea-margin | web-component margin default is 0 12px | | --jb-textarea-border-radius | web-component border-radius default is 16px | | --jb-textarea-border-width | web-component border-width default is 1px | | --jb-textarea-border-color | border color of select in normal mode | | --jb-textarea-border-color-focus | border color of select in normal mode | | --jb-textarea-bgcolor | background color of input | | --jb-textarea-border-botton-width | border bottom thickness default is 3px | | --jb-textarea-label-font-size | font size of input label default is 0.8em | | --jb-textarea-value-font-size | font size of input value default is 1.1em | | --jb-textarea-value-color | color of value default in initial | | --jb-textarea-message-font-size | font size of message we show under input | | --jb-textarea-message-error-color | change color of error we show under input default is red | | --jb-textarea-min-height | minimum height of text area default is 80px | | --jb-textarea-max-height | minimum height of text area default is none | | --jb-textarea-placeholder-color | placeholder color default is 'initial' | | --jb-textarea-placeholder-font-size | placeholder font-size default is initial | | --jb-textarea-label-color | label color default is #1f1735 |
| --jb-textarea-value-color | value color |

Other Related Docs:

• see jb-textarea-react if you want to use this component in react.

• see All JB Design system Component List for more components.

• use Contribution Guide if you want to contribute in this component.