From c6b34f1864d035b128356f80c29122b28f2ab246 Mon Sep 17 00:00:00 2001 From: t1m0n Date: Thu, 24 Mar 2016 11:33:39 +0300 Subject: [PATCH] complete English docs --- docs/index-ru.html | 3 +- docs/index.html | 35 ++++++----- docs/jade/pages/index-ru.jade | 9 ++- docs/jade/pages/index.jade | 106 +++++++++++++++++++++++++++------- 4 files changed, 114 insertions(+), 39 deletions(-) diff --git a/docs/index-ru.html b/docs/index-ru.html index 165e166..de91bf6 100644 --- a/docs/index-ru.html +++ b/docs/index-ru.html @@ -242,7 +242,8 @@ $('.my-datepicker').datepicker({ navTitles: { days: '<h3>Выберете дату заезда</h3> MM, yyyy' } -})

monthsField

Типstring

Значение по умолчанию"monthsShort"

Какое поле из объекта локализации использовать в качестве названий месяцев, когдаview = "months".

timepicker

Типboolean

Значение по умолчаниюfalse

Еслиtrue, то будет добавлена возомжность выбора времени.

dateTimeSeparator

Типstring

Значение по умолчанию" "

Разделитель между датой и временем

timeFormat

Типstring

Значение по умолчаниюnull

Формат времени. По умолчанию берется из локализации. Если передать значение сюда, то оно будет иметь больший приоритет. Возможные варианты:

minHours

Типnumber

Значение по умолчанию0

Минимальное значение часов от 0 до 23. Нельзя выбрать час меньше, чем переданное значение.

maxHours

Типnumber

Значение по умолчанию23

Максимальное значение часов от 0 до 23. Нельзя выбрать час больше, чем переданное значение.

minMinutes

Типnumber

Значение по умолчанию0

Минимальное значение часов от 0 до 59. Нельзя вустановить значение минут меньше, чем переданное значение.

maxMinutes

Типnumber

Значение по умолчанию59

Максимальное значение минут от 0 до 59. Нельзя вустановить значение минут больше, чем переданное значение.

hoursStep

Типnumber

Значение по умолчанию1

Шаг выбора часов.

minutesStep

Типnumber

Значение по умолчанию1

Шаг выбора минут.

События

onSelect(formattedDate, date, inst)

Типfunction

Значение по умолчаниюnull

Функция обратного вызова при выборе даты.

  • formattedDatestring- отформатированная дата.
  • dateDate|array- объектDateвыбранной даты, если{multipleDates: true}, то будет передан массив таких объектов.
  • instobject- экземпляр плагина.

onChangeMonth(month, year)

Типfunction

Значение по умолчаниюnull

Функция обратного вызова при изменении месяца.

  • monthnumber- номер месяца (от 0 до 12), к которому осуществлен переход.
  • yearnumber- номер года, к которому осуществлен переход.

onChangeYear(year)

Типfunction

Значение по умолчаниюnull

Функция обратного вызова при изменении года.

  • yearnumber- номер года, к которому осуществлен переход

onChangeDecade(decade)

Типfunction

Значение по умолчаниюnull

Функция обратного вызова при изменении декады.

  • decadearray- массив, состоящий из номера года с которого начинается декада, и года на котором она заканчивается.

onChangeView(view)

Типfunction

Значение по умолчаниюnull

Функция обратного вызова при изменении вида календаря

  • viewstring- вид, к которому осуществлен переход (days, months, years).

onRenderCell(date, cellType)

Типfunction

Значение по умолчаниюnull

Функция обратного вызова при отрисовке ячейки календаря.

  • dateDate- объект даты текущей ячейки
  • cellTypestring- тип текущей ячейки (day, month, year).

Функция должна возвращать объект, которой может состоять из трех полей:

{
+})

monthsField

Типstring

Значение по умолчанию"monthsShort"

Какое поле из объекта локализации использовать в качестве названий месяцев, когдаview = "months".

timepicker

Типboolean

Значение по умолчаниюfalse

Еслиtrue, то будет добавлена возомжность выбора времени.

dateTimeSeparator

Типstring

Значение по умолчанию" "

Разделитель между датой и временем.

timeFormat

Типstring

Значение по умолчаниюnull

Формат времени. По умолчанию берется из локализации. Если передать значение сюда, то оно будет иметь больший приоритет. +Для включения 12-ти часового режима добавьте 'aa' или 'AA' в параметрtimeFormat, например{timeFormat: "hh:ii AA"}Возможные варианты:

  • h- часы
  • hh- часы, с лидирующим нулем
  • i- минуты
  • ii- минуты, с лидирующим нулем
  • aa- период дня - 'am' или 'pm'
  • AA- период дня заглавными буквами

minHours

Типnumber

Значение по умолчанию0

Минимальное значение часов от 0 до 23. Нельзя выбрать час меньше, чем переданное значение.

maxHours

Типnumber

Значение по умолчанию23

Максимальное значение часов от 0 до 23. Нельзя выбрать час больше, чем переданное значение.

minMinutes

Типnumber

Значение по умолчанию0

Минимальное значение часов от 0 до 59. Нельзя вустановить значение минут меньше, чем переданное значение.

maxMinutes

Типnumber

Значение по умолчанию59

Максимальное значение минут от 0 до 59. Нельзя вустановить значение минут больше, чем переданное значение.

hoursStep

Типnumber

Значение по умолчанию1

Шаг выбора часов.

minutesStep

Типnumber

Значение по умолчанию1

Шаг выбора минут.

События

onSelect(formattedDate, date, inst)

Типfunction

Значение по умолчаниюnull

Функция обратного вызова при выборе даты.

  • formattedDatestring- отформатированная дата.
  • dateDate|array- объектDateвыбранной даты, если{multipleDates: true}, то будет передан массив таких объектов.
  • instobject- экземпляр плагина.

onChangeMonth(month, year)

Типfunction

Значение по умолчаниюnull

Функция обратного вызова при изменении месяца.

  • monthnumber- номер месяца (от 0 до 12), к которому осуществлен переход.
  • yearnumber- номер года, к которому осуществлен переход.

onChangeYear(year)

Типfunction

Значение по умолчаниюnull

Функция обратного вызова при изменении года.

  • yearnumber- номер года, к которому осуществлен переход

onChangeDecade(decade)

Типfunction

Значение по умолчаниюnull

Функция обратного вызова при изменении декады.

  • decadearray- массив, состоящий из номера года с которого начинается декада, и года на котором она заканчивается.

onChangeView(view)

Типfunction

Значение по умолчаниюnull

Функция обратного вызова при изменении вида календаря

  • viewstring- вид, к которому осуществлен переход (days, months, years).

onRenderCell(date, cellType)

Типfunction

Значение по умолчаниюnull

Функция обратного вызова при отрисовке ячейки календаря.

  • dateDate- объект даты текущей ячейки
  • cellTypestring- тип текущей ячейки (day, month, year).

Функция должна возвращать объект, которой может состоять из трех полей:

{
 	html: '', // Кастомный контент ячейки
 	classes: '', // Дополнительные классы для ячейки
 	disabled: '' // true/false, если true, то ячейку нельзя будет выбрать
diff --git a/docs/index.html b/docs/index.html
index 72ed986..f8276d5 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -129,15 +129,15 @@ $picker.datepicker({
 var currentDate = currentDate = new Date();
 $picker.data('datepicker').selectDate(new Date(currentDate.getFullYear(), currentDate.getMonth(), 10))

Timepicker

To enable timepicker use option{timepicker: true}- it will add current time and a couple of range sliders by which one can pick time.

By default current user time will be set. This value can be changed bystartDateparameter.

Example
<div class="datepicker-here" data-timepicker="true" data-language='en'></div>

More detailed info about timepicker parameters you can find in Options.

Time format

Time format is defined in localization object or intimeFormatparameter. By default (in Russian language) 24 hours format is used. For enabling 12 hours mode you must addaaorAAsymbol intimeFormat. After what 'AM' and 'PM' sings will appear in timepicker widget.

Lets use 12 hours mode in Russian language:

Example
<div class="datepicker-here" data-timepicker="true" data-time-format='hh:ii aa'></div>
-

Действия со временем

Для задания максимально/минимально возможных значений часов или минут используйте параметрыmaxHours,minHours,maxMinutes,minMinutes. Также время можно указывать в парамтерахminDateиmaxDate

Давайте создадим календарь, где пользователь может выбрать время с 09:00 до 18:00, а в субботу и воскресенье с 10:00 до 16:00.

Example
<input type='text' id='timepicker-actions-exmpl' />
 <script>
-	// Зададим стартовую дату
+	// Create start date
 	var start = new Date(),
 		startHours = 9;
 
-	// 09:00
+	// 09:00 AM
 	start.setHours(9);
 	start.setMinutes(0);
 
-	// Если сегодня суббота или воскресенье - 10:00
-	if ([6,0].indexOf(start.getDay()) != -1) {
+	// If today is Saturday or Sunday set 10:00 AM
+	if ([6, 0].indexOf(start.getDay()) != -1) {
 		start.setHours(10);
 		startHours = 10
 	}
 
 	$('#timepicker-actions-exmpl').datepicker({
 		timepicker: true,
+		language: 'en',
 		startDate: start,
 		minHours: startHours,
 		maxHours: 18,
-		onSelect: function(fd, d, picker) {
-			// Ничего не делаем если выделение было снято
+		onSelect: function (fd, d, picker) {
+			// Do nothing if selection was cleared
 			if (!d) return;
 
 			var day = d.getDay();
-			// Если выбранный день суббота или воскресенье, то устанавливаем
-			// часы для выходных, в противном случае восстанавливаем начальные значения
+			// If chosen day is Saturday or Sunday when set
+			// hour value for weekends, else restore defaults
 			if (day == 6 || day == 0) {
 				picker.update({
 					minHours: 10,
@@ -244,7 +246,8 @@ Possible values are the same as inview
 	   navTitles: {
 		   days: '<h3>Check in date:</h3> MM, yyyy'
 	   }
-   })

monthsField

Typestring

Defaults"monthsShort"

Field name from localization object which should be used as months names, when view is 'months'.

Events

onSelect(formattedDate, date, inst)

Typefunction

Defaultsnull

Callback when selecting date

  • formattedDatestring- formatted date.
  • dateDate|array- JavaScript Date object + })

monthsField

Typestring

Defaults"monthsShort"

Field name from localization object which should be used as months names, when view is 'months'.

timepicker

Typeboolean

Defaultsfalse

Iftrue, when timepicker widget will be added.

dateTimeSeparator

Typestring

Defaults" "

Separator between date and time

timeFormat

Typestring

Defaultsnull

Desirable time format. Taken from localization by default. If value passed here, then it will be used instead. +For using 12 hours mode, add "aa" or "AA" to yourtimeFormatparameter, e.g.{timeFormat: "hh:ii AA"}Possible values are:

  • h- hours
  • hh- hours with leading zero
  • i- minutes
  • ii- minutes with leading zero
  • aa- day period - 'am' or 'pm'
  • AA- day period capitalized

minHours

Typenumber

Defaults0

Minimal hours value, must be between 0 and 23. You will not be able to choose value lower than this.

maxHours

Typenumber

Defaults23

Maximum hours value, must be between 0 and 23. You will not be able to choose value higher than this.

minMinutes

Typenumber

Defaults0

Minimal minutes value, must be between 0 and 59. You will not be able to choose value lower than this.

maxMinutes

Typenumber

Defaults59

Maximum minutes value, must be between 0 and 59. You will not be able to choose value higher than this.

hoursStep

Typenumber

Defaults1

Hours step in slider.

minutesStep

Typenumber

Defaults1

Minutes step in slider.

Events

onSelect(formattedDate, date, inst)

Typefunction

Defaultsnull

Callback when selecting date

  • formattedDatestring- formatted date.
  • dateDate|array- JavaScript Date object if{multipleDates: true}, then it will be an array of js dates.
  • instobject- plugin instance.

onChangeMonth(month, year)

Typefunction

Defaultsnull

Callback when months are changed.

  • monthnumber- month number (from 0 to 12), to which transition is done.
  • yearnumber- year, to which transition is done.

onChangeYear(year)

Typefunction

Defaultsnull

Callback when year is changed

  • yearnumber- year, to which transition is done.

onChangeDecade(decade)

Typefunction

Defaultsnull

Callback when decade is changed

  • decadearray- array which consists of two years: first year in decade and last year in decade.

onChangeView(view)

Typefunction

Defaultsnull

Callback when datepicker's view is changed

  • viewstring- view name, to which transition is done (days, months, years).

onRenderCell(date, cellType)

Typefunction

Defaultsnull

Callback when datepicker's cell is rendered.

  • dateDate- current cell date
  • cellTypestring- current cell type (day, month, year).

The callback must return object which may consists of three fields:

{
 	html: '', // Custom cell content
 	classes: '', // Extra css classes to cell
diff --git a/docs/jade/pages/index-ru.jade b/docs/jade/pages/index-ru.jade
index 1fa624a..3162046 100644
--- a/docs/jade/pages/index-ru.jade
+++ b/docs/jade/pages/index-ru.jade
@@ -725,11 +725,16 @@ block content
 
 		.param
 			+param-header('dateTimeSeparator', 'string', '" "', 'opts-dateTimeSeparator')
-			p Разделитель между датой и временем
+			p Разделитель между датой и временем.
 
 		.param
 			+param-header('timeFormat', 'string', 'null', 'opts-timeFormat')
-			p Формат времени. По умолчанию берется из локализации. Если передать значение сюда, то оно будет иметь больший приоритет. Возможные варианты:
+			p Формат времени. По умолчанию берется из локализации. Если передать значение сюда, то оно будет иметь больший приоритет.
+				| Для включения 12-ти часового режима добавьте 'aa' или 'AA' в параметр
+				+example-inline('timeFormat','js')
+				|, например
+				+example-inline('{timeFormat: "hh:ii AA"}','js')
+				| Возможные варианты:
 			ul
 				li
 					+param('h')
diff --git a/docs/jade/pages/index.jade b/docs/jade/pages/index.jade
index 5b93123..79ae5ff 100644
--- a/docs/jade/pages/index.jade
+++ b/docs/jade/pages/index.jade
@@ -309,8 +309,8 @@ block content
 				:code
 					

 
-		h3#timeformat-actions Действия со временем
-		p Для задания максимально/минимально возможных значений часов или минут используйте параметры
+		h3#timeformat-actions Actions with time
+		p For setting max/min hours or minutes values use
 			+example-inline('maxHours','js')
 			| ,
 			+example-inline('minHours','js')
@@ -318,25 +318,26 @@ block content
 			+example-inline('maxMinutes','js')
 			| ,
 			+example-inline('minMinutes','js')
-			| . Также время можно указывать в парамтерах
+			| . You also could set time in
 			+example-inline('minDate','js')
-			| и
+			| and
 			+example-inline('maxDate','js')
-		p Давайте создадим календарь, где пользователь может выбрать время с 09:00 до 18:00, а в субботу и воскресенье с 10:00 до 16:00.
+			|. For setting hours you must use values between 0 and 23, event if 12 hours mode is on. Plugin will automatically transform given values to 12 hours format.
+		p Lets create calendar where user can choose time between 09:00 am and 06:00 pm on working days and on Saturday and Sunday between from 10:00 am to 04:00 pm.
 
 		+example
 			+example-content
 				input(type='text')#timepicker-actions-exmpl
 				script.
-					// Зададим стартовую дату
+					// Create start date
 					var start = new Date(),
-							startHours = 9;
+						startHours = 9;
 
-					// 09:00
+					// 09:00 AM
 					start.setHours(9);
 					start.setMinutes(0);
 
-					// Если сегодня суббота или воскресенье - 10:00
+					// If today is Saturday or Sunday set 10:00 AM
 					if ([6, 0].indexOf(start.getDay()) != -1) {
 						start.setHours(10);
 						startHours = 10
@@ -344,16 +345,17 @@ block content
 
 					$('#timepicker-actions-exmpl').datepicker({
 						timepicker: true,
+						language: 'en',
 						startDate: start,
 						minHours: startHours,
 						maxHours: 18,
 						onSelect: function (fd, d, picker) {
-							// Ничего не делаем если выделение было снято
+							// Do nothing if selection was cleared
 							if (!d) return;
 
 							var day = d.getDay();
-							// Если выбранный день суббота или воскресенье, то устанавливаем
-							// часы для выходных, в противном случае восстанавливаем начальные значения
+							// If chosen day is Saturday or Sunday when set
+							// hour value for weekends, else restore defaults
 							if (day == 6 || day == 0) {
 								picker.update({
 									minHours: 10,
@@ -371,32 +373,33 @@ block content
 				:code