tessl/npm-jquery-datetimepicker
jQuery plugin for date and time selection combining both date picker and time picker functionality with extensive customization and internationalization support
—
Pending
Does it follow best practices?
Impact
Pending
No eval scenarios have been run
Pending
The risk profile of this skill
plugin-interface.mddocs/
Plugin Interface
The main jQuery plugin interface for jquery-datetimepicker provides initialization and method invocation capabilities.
Capabilities
Plugin Initialization
Initialize a datetimepicker on selected elements with optional configuration.
/**
* Initialize datetimepicker on selected elements
* @param options - Configuration options for the picker
* @returns jQuery object for chaining
*/
function datetimepicker(options?: DateTimePickerOptions): JQuery;Usage Examples:
// Basic initialization
$('#myinput').datetimepicker();
// With configuration options
$('#myinput').datetimepicker({
format: 'Y-m-d H:i',
step: 30,
minDate: '2023-01-01'
});
// Chaining
$('#myinput').datetimepicker({
timepicker: false
}).addClass('date-only');Method Invocation
Call methods on existing datetimepicker instances using string commands.
/**
* Invoke methods on existing datetimepicker instances
* @param method - Method name to invoke
* @returns jQuery object for chaining or method-specific return value
*/
function datetimepicker(method: string, ...args: any[]): any;Show Method
Display the datetimepicker widget.
/**
* Show the datetimepicker widget
* @returns jQuery object for chaining
*/
function datetimepicker(method: 'show'): JQuery;Usage Examples:
// Show the picker
$('#myinput').datetimepicker('show');
// Show and focus input
$('#myinput').datetimepicker('show').focus();Hide Method
Hide the datetimepicker widget.
/**
* Hide the datetimepicker widget
* @returns jQuery object for chaining
*/
function datetimepicker(method: 'hide'): JQuery;Usage Examples:
// Hide the picker
$('#myinput').datetimepicker('hide');Toggle Method
Toggle the visibility of the datetimepicker widget.
/**
* Toggle visibility of the datetimepicker widget
* @returns jQuery object for chaining
*/
function datetimepicker(method: 'toggle'): JQuery;Usage Examples:
// Toggle picker visibility
$('#myinput').datetimepicker('toggle');
// Use with button
$('#toggleBtn').click(function() {
$('#myinput').datetimepicker('toggle');
});Destroy Method
Destroy the datetimepicker instance and remove all associated event handlers.
/**
* Destroy the datetimepicker instance
* @returns jQuery object for chaining
*/
function datetimepicker(method: 'destroy'): JQuery;Usage Examples:
// Destroy the picker
$('#myinput').datetimepicker('destroy');
// Destroy and reinitialize with new options
$('#myinput').datetimepicker('destroy').datetimepicker({
format: 'H:i',
datepicker: false
});Reset Method
Reset the input to its default value.
/**
* Reset the input to its default value
* @returns jQuery object for chaining
*/
function datetimepicker(method: 'reset'): JQuery;Usage Examples:
// Reset to default value
$('#myinput').datetimepicker('reset');
// Reset multiple inputs
$('.datetime-inputs').datetimepicker('reset');Validate Method
Validate the current input value.
/**
* Validate the current input value
* @returns jQuery object for chaining
*/
function datetimepicker(method: 'validate'): JQuery;Usage Examples:
// Validate current value
$('#myinput').datetimepicker('validate');
// Validate and handle result
$('#myinput').datetimepicker('validate');
if ($('#myinput').hasClass('xdsoft_invalid')) {
// Handle invalid input
}Plugin Defaults
Access default configuration options.
/**
* Default configuration options for all datetimepicker instances
*/
$.fn.datetimepicker.defaults: DateTimePickerOptions;Usage Examples:
// Modify global defaults
$.fn.datetimepicker.defaults.format = 'Y-m-d H:i';
$.fn.datetimepicker.defaults.step = 30;
// Use custom defaults for all future instances
$('.datetime-inputs').datetimepicker(); // Will use modified defaults