time input web component
npm install jb-time-inputjb-time-input/react;
command
npm i jb-time-input
`
`javascript
import 'jb-time-input'
`
`HTML
`
$3
like any other javascript DOM element you can bind event to web component with DOM.addEventListener the supported event is:
`javascript
//when default property are defined best time for impl your config
document.querySelector('jb-date-input').addEventListener('init',this.onCalendarElementInitiated);
//when calendar init all property and function and dom created and bind successully
document.querySelector('jb-date-input').addEventListener('load',this.onCalendarElementLoaded);
//keyboard event
document.querySelector('jb-time-input').addEventListener('keydown',()=>{});
document.querySelector('jb-time-input').addEventListener('keyup',()=>{});
document.querySelector('jb-time-input').addEventListener('keypress',()=>{});
document.querySelector('jb-time-input').addEventListener('change',()=>{});
// when user press enter on type good for situation you want so submit form or call search function on user press enter.
document.querySelector('jb-time-input').addEventListener('enter',()=>{});
//focus event
document.querySelector('jb-time-input').addEventListener('focus',()=>{});
document.querySelector('jb-time-input').addEventListener('blur',()=>{});
`
$3
to set value of time input you have 2 way:
- by html as a attribute:
`html
`
- by javascript
`javascript
document.querySelector('jb-date-input').value = "01:11:12";
`
$3
jb-time-input use jb-validation inside to handle validation so for more information you can read it's documentation.
jb time input will check validation automatically and show error on user blur the input and hide error on user type and blur to use this feature you just have to set validation list of component.
`javascript
document.querySelector('jb-time-input').validationList = [
//regex validator
{
validator: /^[1][1234].*$/g,
message:"hour must be between 11 and 14"
},
//callback function validator
{
validator:({displayValue,value,valueObject})=>{
//display value is the value user see
//value is the value developer get by dom.value
//valueObject is the {hour:number,minute:number,second:number} object contain inputted value in number
if(valueObject.minute<30){
return false;
}
return true;
},
message:'minute must be 30 to 60'
}
]
`
you can trigger validation manually by calling checkValidity function. for example you can call it when submit button clicked and check if value is valid or not.
`javascript
// if you set showError false you can get validation result but component wont show error to user by itself its good when you want show error in your own way
const showError = true;
const validationResult = document.querySelector('jb-time-input').validation.checkValidity(showError);
if(validationResult.isAllValid){
alert('all validation are passed')
}else{
alert('validation error!');
}
`
you can also get validation result of your time input by following way:
`javascript
document.querySelector('jb-time-input').validation.resultSummary
`
$3
you can change some attribute in html like label or message configurable attribute are:
`HTML
`
$3
if you want to just input minute and hour and disable second in picker and input just set secondEnabled to false
`javascript
document.querySelector('jb-time-input').secondEnabled = false;
`
$3
if you want picker to show 02 instead of 2 when number is less than 10 just set frontalZero of time picker default is false.
`js
document.querySelector('jb-time-input').frontalZero = true;
`
or
`html
`
$3
if you want to tell user some units is optional and grey the numbers in picker, you can set optionalUnits
`js
//it could be 'hour' or 'minute' or 'second'
document.querySelector('jb-time-input').optionalUnits = ['hour'];
`
$3
if you want to show persian number instead of english number chars. you can set showPersianNumber:
`js
document.querySelector('jb-time-input').showPersianNumber = true
`
$3
you can customize jb-time-input look by setting css variable in your app.
jb-time-input use jb-input and jb-time-picker and jb-popover underneath so to change the styles of your component read custom style section of these components and set their css variable.
more than above here is the css variable that we use in jb-time-input itself:
| css variable name | description |
| ------------- | ------------- |
| --jb-time-input-margin | outer margin of web component default is 12px 0 |
Other Related Docs:
- see jb-time-input/react` if you want to use this component in ReactJS.
- see All JB Design system Component List for more components.
- use Contribution Guide if you want to contribute in this component.