datatables.net-datetime/docs/api/errorMsg().xml

DateTime picker for DataTables.net

<?xml version="1.0" encoding="UTF-8" ?>
<dt-api library="DateTime">
	<name>errorMsg()</name>
	<summary>Either sets the error message or removes it</summary>
	<since>1.0.0</since>

	<type type="function">
		<signature>errorMsg()</signature>
		<description>Empties the error message.</description>
		<returns type="DateTime">Self for chaining.</returns>
	</type>
	<type type="function">
		<signature>errorMsg(msg)</signature>
		<description>Sets the error message.</description>
		<parameter type="string" name="msg" optional="true">
			Message to be displayed.
		</parameter>
		<returns type="DateTime">Self for chaining.</returns>
	</type>

	<description>
		Either sets the error message or removes it depending on if the `msg` parameter is passed or not.

		This is useful for providing custom error messages when an error occurs.
	</description>

	<example title="Set Error Message"><![CDATA[
var dt = new DateTime(document.getElementById('example'));

dt.errMsg('Oops an error occurred!');
]]></example>

<example title="Basic validation - set and clear an error message"><![CDATA[
var dt = new DateTime(document.getElementById('example'));

el.addEventListener('change', function () {
	if (dt.val()) {
		// There is a value - clear the error message
		dt.errMsg();
	}
	else {
		// No value - error
		dt.errMsg('oops an error occurred!');
	}
});
]]></example>

</dt-api>